couchbase
    Preparing search index...

    Class CouchbaseList

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

    Index

    Methods

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

      Returns AsyncIterator<any>

    • Iterates each item in the list.

      Parameters

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

    • Returns the entire list of items in this list.

      Parameters

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

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

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

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

      • Optionalcallback: NodeCallback<void>

        A node-style callback to be invoked after execution.

      Returns Promise<void>

    • Returns the number of items in the list.

      Parameters

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

      • Optionalcallback: NodeCallback<void>

        A node-style callback to be invoked after execution.

      Returns Promise<void>