Class CouchbaseList

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

See

list

Hierarchy

  • CouchbaseList

Methods

[asyncIterator] forEach getAll getAt indexOf push removeAt size unshift

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<any, any, undefined>

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

    Returns AsyncIterator<any, any, undefined>

forEach

  • Iterates each item in the list.

    Parameters

    • rowCallback: ((value: any, index: number, array: CouchbaseList) => 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>

getAll

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

getAt

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

indexOf

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

push

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

removeAt

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

size

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

unshift

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

Settings

Member Visibility

Theme

Generated using TypeDoc