Class CouchbaseList

CouchbaseList provides a simplified interface for storing lists within a Couchbase document.

See

list

Hierarchy

  • CouchbaseList

Methods

  • Provides the ability to async-for loop this object.

    Returns AsyncIterator<any, any, undefined>

  • Iterates each item in the list.

    Parameters

    • rowCallback: ((value, index, array) => void)

      A callback invoked for each item in the list.

        • (value, index, array): void
        • Parameters

          Returns void

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

  • Returns the entire list of items in this list.

    Parameters

    • Optional callback: NodeCallback<any[]>

      A node-style callback to be invoked after execution.

    Returns Promise<any[]>

  • Retrieves the item at a specific index in the list.

    Parameters

    • index: number

      The index to retrieve.

    • Optional callback: NodeCallback<any>

      A node-style callback to be invoked after execution.

    Returns Promise<any>

  • Returns the index of a specific value from the list.

    Parameters

    • value: any

      The value to search for.

    • Optional callback: NodeCallback<number>

      A node-style callback to be invoked after execution.

    Returns Promise<number>

  • Adds a new item to the end of the list.

    Parameters

    • value: any

      The value to add.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

  • Removes an item at a specific index from the list.

    Parameters

    • index: number

      The index to remove.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

  • Returns the number of items in the list.

    Parameters

    • Optional callback: NodeCallback<number>

      A node-style callback to be invoked after execution.

    Returns Promise<number>

  • Adds a new item to the beginning of the list.

    Parameters

    • value: any

      The value to add.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

Generated using TypeDoc