Class CouchbaseSet

CouchbaseSet provides a simplified interface for storing a set within a Couchbase document.

See

Hierarchy

CouchbaseSet

Index

Methods

add contains remove size values

Methods

add

add(item: any, callback?: NodeCallback<boolean>): Promise<boolean>
Adds a new item to the set. Returning whether the item already existed in the set or not.
Parameters
- item: any
  
  The item to add.
- Optional callback: NodeCallback<boolean>
  
  A node-style callback to be invoked after execution.
Returns Promise<boolean>
- Defined in lib/datastructures.ts:513

contains

contains(item: any, callback?: NodeCallback<boolean>): Promise<boolean>
Returns whether a specific value already exists in the set.
Parameters
- item: any
  
  The value to search for.
- Optional callback: NodeCallback<boolean>
  
  A node-style callback to be invoked after execution.
Returns Promise<boolean>
- Defined in lib/datastructures.ts:541

remove

remove(item: any, callback?: NodeCallback<void>): Promise<void>
Removes a specific value from the set.
Parameters
- item: any
  
  The value to remove.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:562

size

size(callback?: NodeCallback<number>): Promise<number>
Returns the number of elements in this set.
Parameters
- Optional callback: NodeCallback<number>
  
  A node-style callback to be invoked after execution.
Returns Promise<number>
- Defined in lib/datastructures.ts:610

values

values(callback?: NodeCallback<any[]>): Promise<any[]>
Returns a list of all values in the set.
Parameters
- Optional callback: NodeCallback<any[]>
  
  A node-style callback to be invoked after execution.
Returns Promise<any[]>
- Defined in lib/datastructures.ts:599

Generated using TypeDoc