Class CouchbaseList

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

See

Collection.list

Index

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>
- Defined in lib/datastructures.ts:67

forEach

forEach(rowCallback, callback?): Promise<void>
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
      value: any
      index: number
      array: CouchbaseList
      Returns void
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/datastructures.ts:52

getAll

getAll(callback?): Promise<any[]>
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[]>
- Defined in lib/datastructures.ts:40

getAt

getAt(index, callback?): 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>
- Defined in lib/datastructures.ts:94

indexOf

indexOf(value, callback?): Promise<number>
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>
- Defined in lib/datastructures.ts:129

push

push(value, callback?): Promise<void>
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>
- Defined in lib/datastructures.ts:161

removeAt

removeAt(index, callback?): 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>
- Defined in lib/datastructures.ts:115

size

size(callback?): Promise<number>
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>
- Defined in lib/datastructures.ts:148

unshift

unshift(value, callback?): Promise<void>
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>
- Defined in lib/datastructures.ts:179