Class IterableQueue<Element>

Exposes an AsyncIterable interface for the BlockingQueue.

Type Parameters

Element

Hierarchy

BlockingQueue<Element>
- IterableQueue

Implements

AsyncIterable<Element>

Index

Constructors

Accessors

Methods

[asyncIterator] dequeue done enqueue next

Constructors

constructor

new IterableQueue<Element>(options?): IterableQueue<Element>
Create a new IterableQueue
Type Parameters
- Element
Parameters
- options: BlockingQueueOptions = {}
  
  IterableQueue options
Returns IterableQueue<Element>
Overrides BlockingQueue.constructor
- Defined in iterable-queue.ts:18

Accessors

length

get length(): number
Returns number
Inherited from BlockingQueue.length
- Defined in blocking-queue.ts:79

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<Element, any, undefined>
Returns AsyncIterator<Element, any, undefined>
Implementation of AsyncIterable.[asyncIterator]
- Defined in iterable-queue.ts:22

dequeue

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

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

done

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

This releases all readers blocked on enqueue

Returns void
Inherited from BlockingQueue.done
- Defined in blocking-queue.ts:88

enqueue

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

next

next(): Promise<IteratorResult<Element, any>>
Used by the iterator returned from [Symbol.asyncIterator] Called every time an item is needed

Returns Promise<IteratorResult<Element, any>>
Iterator result
- Defined in iterable-queue.ts:32

Generated using TypeDoc