Class BlockingQueue<Element>

enqueue blocks when the queue is full, until an item is read with dequeue, or done dequeue blocks when the queue is empty, until an item is added with enqueue, or done done must be called when no more items will be added dequeue returns undefined there are no more items and processing is complete

Type Parameters

Element

Hierarchy (View Summary)

BlockingQueue
- IterableQueue

Index

Constructors

Accessors

Methods

dequeue done enqueue

Constructors

constructor

new BlockingQueue<Element>(
options?: BlockingQueueOptions,
): BlockingQueue<Element>
Create a new BlockingQueue
Type Parameters
- Element
Parameters
- options: BlockingQueueOptions = {}
  BlockingQueue options
Returns BlockingQueue<Element>
- Defined in blocking-queue.ts:56

Accessors

length

get length(): number
Returns number
- Defined in blocking-queue.ts:72

Methods

dequeue

dequeue(): Promise<Element | undefined>
Gets an element when one is ready, waits if none are ready.

Returns Promise<Element | undefined>
Element or undefined if queue is empty and done has been called
- Defined in blocking-queue.ts:125

done

done(): void
Indicate that no more items will be enqueued.

This releases all readers blocked on enqueue

Returns void
- Defined in blocking-queue.ts:81

enqueue

enqueue(item: Element): Promise<void>
Add an item to the queue, wait if the queue is full.
Parameters
- item: Element
  Element to add
Returns Promise<void>
- Defined in blocking-queue.ts:100