Class RateLimitedQueueClient<ItemType>

A rate-limited queue client that allows you to limit the rate at which messages are processed.

Typeparam

ItemType The type of items in the queue.

Type Parameters

ItemType = any

Hierarchy

RateLimitedQueueClient

Index

Constructors

constructor

new RateLimitedQueueClient<ItemType>(name, connection, callback?, config?, instrumentors?): RateLimitedQueueClient<ItemType>
Creates a new instance of the RateLimitedQueueClient.
Type Parameters
- ItemType = any
Parameters
- name: string
  
  The name of the queue.
- connection: RateLimitedQueueConnectionConfiguration
  
  The connection and queue configuration options.
- Optional callback: RateLimitedSpillCallback<ItemType>
  
  The callback function to call when the queue spills.
- config: Partial<RateLimitedQueueConfig> = {}
  
  The configuration options for the queue.
- instrumentors: Partial<RateLimitedQueueInstrumentors> = {}
Returns RateLimitedQueueClient<ItemType>

Throws
An error if the perInterval or interval values are invalid.
- Defined in index.ts:140

Accessors

isShutDown

get isShutDown(): boolean
Returns a boolean indicating whether or not the queue has been shut down.

Returns boolean
A boolean indicating whether or not the queue has been shut down.
- Defined in index.ts:270

running

get running(): boolean
Returns a boolean indicating whether or not the queue is running.

Returns boolean
A boolean indicating whether or not the queue is running.
- Defined in index.ts:254

working

get working(): boolean
Returns a boolean indicating whether or not the queue is currently processing a tick.

Returns boolean
A boolean indicating whether or not the queue is currently processing a tick.
- Defined in index.ts:262

Methods

enqueue

enqueue(item): Promise<boolean>
Adds an item to the rate-limited queue.
Parameters
- item: ItemType
  
  The item to add to the queue.
Returns Promise<boolean>
A Promise that resolves when the item has been added to the queue.
- Defined in index.ts:382

enqueueBulk

enqueueBulk(items): Promise<boolean[]>
Adds multiple items to the rate-limited queue in bulk.
Parameters
- items: ItemType[]
  
  An array of items to add to the queue.
Returns Promise<boolean[]>
A Promise that resolves when all items have been added to the queue.
- Defined in index.ts:397

getPressure

getPressure(): Promise<number>
Gets the total number of jobs in the queue (waiting + active).

Returns Promise<number>
A Promise that resolves to the total number of jobs in the queue.
- Defined in index.ts:291

setCallback

setCallback(callback): void
Sets the callback function to be called when the rate-limited queue spills.
Parameters
- callback: RateLimitedSpillCallback<ItemType>
  
  The callback function to call when the queue spills.
Returns void
void

Typeparam
ItemType The type of items in the queue.
- Defined in index.ts:280

shutdown

shutdown(): Promise<void>
Shuts down the queue.

Returns Promise<void>
A Promise that resolves when the queue has shut down.

Remarks
This will stop the queue and close the Connection connection.
- Defined in index.ts:348

start

start(): Promise<void>
Starts processing the queue. If the queue is already running, it will wait for the current tick to complete before starting a new one.

Returns Promise<void>
A Promise that resolves when the queue has started.
- Defined in index.ts:309

stop

stop(): Promise<void>
Stops processing the queue. If the queue is currently working, it will wait for the current tick to complete before stopping.

Returns Promise<void>
A Promise that resolves when the queue has stopped.
- Defined in index.ts:331

Class RateLimitedQueueClient<ItemType>

Typeparam

Type Parameters

ItemType = any

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

ItemType = any

Parameters

name: string

connection: RateLimitedQueueConnectionConfiguration

Optional callback: RateLimitedSpillCallback<ItemType>

config: Partial<RateLimitedQueueConfig> = {}

instrumentors: Partial<RateLimitedQueueInstrumentors> = {}

Returns RateLimitedQueueClient<ItemType>

Throws

Accessors

isShutDown

Returns boolean

running

Returns boolean

working

Returns boolean

Methods

enqueue

Parameters

item: ItemType

Returns Promise<boolean>

enqueueBulk

Parameters

items: ItemType[]

Returns Promise<boolean[]>

getPressure

Returns Promise<number>

setCallback

Parameters

callback: RateLimitedSpillCallback<ItemType>

Returns void

Typeparam

shutdown

Returns Promise<void>

Remarks

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` callback: RateLimitedSpillCallback<ItemType>