Class BlockedQueue<I>

BlockedQueue

a blocked queue for async operations

Since

5.19.0

Type Parameters

I = any

Hierarchy

BlockedQueue

Index

Constructors

Methods

deQueue enQueue

Constructors

constructor

new BlockedQueue<I>(capacity?, maxPending?): BlockedQueue<I>
Type Parameters
- I = any
Parameters
- capacity: number = 1000
  
  default 1000
- maxPending: number = ...
  
  default 10 * capacity, the max allowed number of pending items
Returns BlockedQueue<I>
- Defined in build/repo/src/functional/BlockedQueue.ts:35

Methods

deQueue

deQueue(): Promise<I>
retrieve an item from queue

Returns Promise<I>
- Defined in build/repo/src/functional/BlockedQueue.ts:80

enQueue

enQueue(item): Promise<void>
push an item to the queue, blocked when the queue is full
Parameters
- item: I
Returns Promise<void>

Throws
throw when pending items are too much
- Defined in build/repo/src/functional/BlockedQueue.ts:51