Class default<T>

A queue that batches and delays items to limit concurrent processing and reduce external API load.

Typeparam

T Type of items in the queue.

Type Parameters

T = any

Hierarchy

EventEmitter
- default

Implements

BucketQueueEmitter<T>

Index

Constructors

Accessors

constructionEvents options pressure

Methods

add cork dequeue enqueue pause push remove resume uncork

Constructors

constructor

new default<T>(options: BucketQueueOptions<T>): default<T>
Constructs a new BucketQueue object.

Throws
If the provided options do not meet the requirements.
Type Parameters
- T = any
Parameters
- options: BucketQueueOptions<T>
  
  An object containing the options for this BucketQueue.
Returns default<T>
Overrides EventEmitter.constructor
- Defined in bucketqueue.ts:252

Accessors

constructionEvents

get constructionEvents(): ConstructionEventsObject
Returns a frozen object containing all stored construction events. The object keys represent the event types and the values are arrays of event arguments. Note that this method only returns stored construction events that have not been emitted yet. Once an event is emitted, it will be removed from the stored events map.

Returns ConstructionEventsObject
- Defined in bucketqueue.ts:462

options

get options(): {
    interval: number;
    maxBatch: number;
    minBatch: number;
}
Returns the current options object used by the BucketQueue. The returned object is frozen and cannot be modified.

Returns
An object containing the current options of the BucketQueue.

Returns {
    interval: number;
    maxBatch: number;
    minBatch: number;
}
- interval: number
- maxBatch: number
- minBatch: number
- Defined in bucketqueue.ts:446

pressure

get pressure(): number
Returns the current length of the bucket, representing the number of items waiting to be processed.

Returns
The current length of the bucket.

Returns number
- Defined in bucketqueue.ts:478

Methods

add

add(...items: BucketQueuePushArguments<T>): void
Alias for push() method.
Parameters
- Rest ...items: BucketQueuePushArguments<T>
  
  The items to add to the bucket.
Returns void
- Defined in bucketqueue.ts:496

cork

cork(): void
Pause the BucketQueue by corking it, preventing any more events from processing.

Returns
void

Returns void
- Defined in bucketqueue.ts:536

dequeue

dequeue(item: T): void
Alias for the remove method.
Parameters
- item: T
  
  The item to remove.
Returns void
- Defined in bucketqueue.ts:528

enqueue

enqueue(...items: BucketQueuePushArguments<T>): void
Alias for push() method.
Parameters
- Rest ...items: BucketQueuePushArguments<T>
  
  The items to enqueue to the bucket.
Returns void
- Defined in bucketqueue.ts:504

pause

pause(): void
Alias for BucketQueue.#cork.

Returns
void

Returns void
- Defined in bucketqueue.ts:556

push

push(...items: BucketQueuePushArguments<T>): void
Pushes items to the bucket and emits the 'pipe' and 'unpipe' events.
Parameters
- Rest ...items: BucketQueuePushArguments<T>
  
  The items to push to the bucket.
Returns void
- Defined in bucketqueue.ts:486

remove

remove(item: T): void
Remove an item from the queue if it exists.
Parameters
- item: T
  
  The item to remove.
Returns void
- Defined in bucketqueue.ts:513

resume

resume(): void
Alias for BucketQueue.#uncork.

Returns
void

Returns void
- Defined in bucketqueue.ts:564

uncork

uncork(): void
Resume the BucketQueue by uncorking it, allowing events to continue processing.

Returns
void

Returns void
- Defined in bucketqueue.ts:546

Generated using TypeDoc