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], any, undefined>
Provides the ability to async-for loop this object.

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

exists

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

forEach

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

get

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

getAll

getAll(callback?): Promise<{
[key: string]: any;
}>
Returns an object representing all items in the map.
Parameters
- Optional callback: 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?): Promise<string[]>
Returns a list of all the keys which exist in the map.
Parameters
- Optional callback: NodeCallback<string[]>
  A node-style callback to be invoked after execution.
Returns Promise<string[]>
- Defined in lib/datastructures.ts:354

remove

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

set

set(item, value, callback?): 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.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:286

size

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

values

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