Class CouchbaseMap

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

See

map

Hierarchy

  • CouchbaseMap

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>

exists

  • 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>

forEach

  • 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.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

get

  • 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>

getAll

  • 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 }>

keys

  • 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[]>

remove

  • 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>

set

  • 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>

size

  • 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>

values

  • 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[]>

Settings

Member Visibility

Theme

Generated using TypeDoc