@proto-kit/deployment • Docs
Documentation / @proto-kit/deployment / BullQueue
Class: BullQueue
TaskQueue implementation for BullMQ
Extends
Implements
Constructors
new BullQueue()
new BullQueue(
parent):BullQueue
Parameters
• parent: ModuleContainerLike
Returns
Overrides
Defined in
deployment/src/queue/BullQueue.ts:37
Properties
currentConfig
protectedcurrentConfig:undefined|BullQueueConfig
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
AbstractTaskQueue.currentConfig
Defined in
common/dist/config/ConfigurableModule.d.ts:17
queues
protectedqueues:Record<string,InstantiatedQueue>
Inherited from
Defined in
sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:4
presets
staticpresets:Presets<unknown>
Inherited from
Defined in
sequencer/dist/sequencer/builder/SequencerModule.d.ts:8
Accessors
config
Get Signature
get config():
Config
Returns
Config
Set Signature
set config(
config):void
Parameters
• config: Config
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:18
Methods
close()
close():
Promise<void>
Returns
Promise<void>
Implementation of
Defined in
deployment/src/queue/BullQueue.ts:119
closeQueues()
protectedcloseQueues():Promise<void>
Returns
Promise<void>
Inherited from
Defined in
sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:6
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:20
createOrGetQueue()
protectedcreateOrGetQueue(name,creator):InstantiatedQueue
Parameters
• name: string
• creator
Returns
Inherited from
AbstractTaskQueue.createOrGetQueue
Defined in
sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:5
createWorker()
createWorker(
name,executor,options?):Closeable
Parameters
• name: string
• executor
• options?
• options.concurrency?: number
Returns
Implementation of
Defined in
deployment/src/queue/BullQueue.ts:48
drainAllQueues()
drainAllQueues():
Promise<void>
Returns
Promise<void>
Implementation of
Inherited from
AbstractTaskQueue.drainAllQueues
Defined in
sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:7
getQueue()
getQueue(
queueName):Promise<InstantiatedQueue>
Parameters
• queueName: string
Returns
Promise<InstantiatedQueue>
Implementation of
Defined in
deployment/src/queue/BullQueue.ts:89
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>