Class CouchbaseMap

CouchbaseMap provides a simplified interface for storing a map within a Couchbase document.

See

Index

Methods

[asyncIterator] exists forEach get getAll keys remove set size values

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<[any, string]>
Provides the ability to async-for loop this object.

Returns AsyncIterator<[any, string]>
- Defined in lib/datastructures.ts:254

exists

exists(item: string, callback?: NodeCallback<boolean>): Promise<boolean>
Checks whether a specific key exists in the map.
Parameters
- item: string
  The key in the map to search for.
- Optionalcallback: NodeCallback<boolean>
  A node-style callback to be invoked after execution.
Returns Promise<boolean>
- Defined in lib/datastructures.ts:335

forEach

forEach(
rowCallback: (value: any, key: string, map: CouchbaseMap) => void,
callback?: NodeCallback<void>,
): Promise<void>
Iterates through every item in the map.
Parameters
- rowCallback: (value: any, key: string, map: CouchbaseMap) => void
  A callback invoked for each item in the list.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:239

get

get(item: string, callback?: NodeCallback<any>): Promise<any>
Fetches a specific key from the map.
Parameters
- item: string
  The key in the map to retrieve.
- Optionalcallback: NodeCallback<any>
  A node-style callback to be invoked after execution.
Returns Promise<any>
- Defined in lib/datastructures.ts:304

getAll

getAll(
callback?: NodeCallback<{ [key: string]: any }>,
): Promise<{ [key: string]: any }>
Returns an object representing all items in the map.
Parameters
- Optionalcallback: NodeCallback<{ [key: string]: any }>
  A node-style callback to be invoked after execution.
Returns Promise<{ [key: string]: any }>
- Defined in lib/datastructures.ts:225

keys

keys(callback?: NodeCallback<string[]>): Promise<string[]>
Returns a list of all the keys which exist in the map.
Parameters
- Optionalcallback: NodeCallback<string[]>
  A node-style callback to be invoked after execution.
Returns Promise<string[]>
- Defined in lib/datastructures.ts:354

remove

remove(item: string, callback?: NodeCallback<void>): Promise<void>
Removes a specific key from the map.
Parameters
- item: string
  The key in the map to remove.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:323

set

set(item: string, value: any, callback?: NodeCallback<void>): Promise<void>
Sets a specific to the specified value in the map.
Parameters
- item: string
  The key in the map to set.
- value: any
  The new value to set.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:286

size

size(callback?: NodeCallback<number>): Promise<number>
Returns the number of items that exist in the map.
Parameters
- Optionalcallback: NodeCallback<number>
  A node-style callback to be invoked after execution.
Returns Promise<number>
- Defined in lib/datastructures.ts:378

values

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