@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / LocalTaskQueue

Class: LocalTaskQueue

Definition of a connection-object that can generate queues and workers for a specific connection type (e.g. BullMQ, In-memory)

Extends

• AbstractTaskQueue<LocalTaskQueueConfig>

Implements

• TaskQueue

Constructors

new LocalTaskQueue()

new LocalTaskQueue(): LocalTaskQueue

Returns

LocalTaskQueue

Inherited from

AbstractTaskQueue.constructor

Properties

currentConfig

protected currentConfig: undefined | LocalTaskQueueConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

AbstractTaskQueue.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

listeners

readonly listeners: object = {}

Index Signature

[key: string]: QueueListener[] | undefined

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:96

queuedTasks

queuedTasks: object = {}

Index Signature

[key: string]: object[]

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:82

queues

protected queues: Record<string, InstantiatedQueue> = {}

Inherited from

AbstractTaskQueue.queues

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8

presets

static presets: Presets<unknown> = {}

Inherited from

AbstractTaskQueue.presets

Defined in

packages/sequencer/src/sequencer/builder/SequencerModule.ts:20

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

AbstractTaskQueue.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

closeQueues()

protected closeQueues(): Promise<void>

Returns

Promise<void>

Inherited from

AbstractTaskQueue.closeQueues

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

AbstractTaskQueue.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

createOrGetQueue()

protected createOrGetQueue(name, creator): InstantiatedQueue

Parameters

• name: string

• creator

Returns

InstantiatedQueue

Inherited from

AbstractTaskQueue.createOrGetQueue

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10

createWorker()

createWorker(queueName, executor, options?): Closeable

Parameters

• queueName: string

• executor

• options?

• options.concurrency?: number

• options.singleUse?: boolean

Returns

Closeable

Implementation of

TaskQueue.createWorker

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:185

drainAllQueues()

drainAllQueues(): Promise<void>

Returns

Promise<void>

Implementation of

TaskQueue.drainAllQueues

Inherited from

AbstractTaskQueue.drainAllQueues

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:26

getQueue()

getQueue(queueName): Promise<InstantiatedQueue>

Parameters

• queueName: string

Returns

Promise<InstantiatedQueue>

Implementation of

TaskQueue.getQueue

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:225

start()

start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Overrides

AbstractTaskQueue.start

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:236

workNextTasks()

workNextTasks(): Promise<void>

Returns

Promise<void>

Defined in

packages/sequencer/src/worker/queue/LocalTaskQueue.ts:102