Class CouchbaseQueue

CouchbaseQueue provides a simplified interface for storing a queue within a Couchbase document.

see: Collection.queue

Hierarchy

CouchbaseQueue

Index

Methods

Methods

pop

pop(callback?: NodeCallback<any>): Promise<any>

- Defined in lib/datastructures.ts:449
Removes an item from the front of the queue.

Parameters
- Optional callback: NodeCallback<any>
  
  A node-style callback to be invoked after execution.
Returns Promise<any>

push

push(value: any, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/datastructures.ts:432
Adds a new item to the back of the queue.

Parameters
- value: any
  
  The value to add.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

size

size(callback?: NodeCallback<number>): Promise<number>

- Defined in lib/datastructures.ts:419
Returns the number of items in the queue.

Parameters
- Optional callback: NodeCallback<number>
  
  A node-style callback to be invoked after execution.
Returns Promise<number>

Generated using TypeDoc