Class TaskQueueClient

Hierarchy

TaskQueueClient

Index

Constructors

constructor

Properties

_queue

Accessors

Methods

enqueue

Constructors

constructor

new TaskQueueClient(optionsRef: TaskModuleOptionsRef): TaskQueueClient

- Defined in src/tasks.ts:134
Parameters
- optionsRef: TaskModuleOptionsRef
Returns TaskQueueClient

Properties

_queue

_queue: BullQueue.Queue

Accessors

options

get options(): TaskModuleOptions

- Defined in src/tasks.ts:151
Get the task client options. See

Returns TaskModuleOptions

queue

get queue(): Queue<TaskJob>

- Defined in src/tasks.ts:144
Returns Queue<TaskJob>

queueName

get queueName(): string

- Defined in src/tasks.ts:155
Returns string

queueOptions

get queueOptions(): QueueOptions

- Defined in src/tasks.ts:159
Returns QueueOptions

Methods

enqueue

enqueue(data: TaskJob, opts?: JobOptions): Promise<QueueJob<TaskJob>>

- Defined in src/tasks.ts:176
Enqueue a new task. To handle the task on the worker side, register for it with .process()

Parameters
- data: TaskJob
- Optional opts: JobOptions
Returns Promise<QueueJob<TaskJob>>

Generated using TypeDoc