Class QueuePro<DataType, ResultType, NameType>

Type Parameters

DataType = any
ResultType = any
NameType extends string = string

Hierarchy

Queue<DataType, ResultType, NameType>
- QueuePro

Index

Constructors

Methods

add deleteGroup deleteGroups getGroupJobs getGroupJobsCount getGroups getGroupsCount getGroupsJobsCount obliterate

Constructors

constructor

new QueuePro<DataType = any, ResultType = any, NameType extends string = string>(
name: string,
opts?: QueueProOptions,
): QueuePro<DataType, ResultType, NameType>
Type Parameters
- DataType = any
- ResultType = any
- NameType extends string = string
Parameters
- name: string
- Optionalopts: QueueProOptions
Returns QueuePro<DataType, ResultType, NameType>
Overrides Queue<DataType, ResultType, NameType>.constructor
- Defined in classes/queue-pro.ts:12

Methods

add

add(
    name: NameType,
    data: DataType,
    opts?: JobsProOptions,
): Promise<Job<DataType, ResultType, NameType>>
Adds a Job to the queue.
Parameters
- name: NameType
- data: DataType
- Optionalopts: JobsProOptions
Returns Promise<Job<DataType, ResultType, NameType>>
Overrides Queue.add
- Defined in classes/queue-pro.ts:23

deleteGroup

deleteGroup(groupId: string | number): Promise<void>
Cleans all the jobs that are part of a group.
Parameters
- groupId: string | number
Returns Promise<void>
- Defined in classes/queue-pro.ts:119

deleteGroups

deleteGroups(): Promise<void>
Cleans all the groups in this queue

Returns Promise<void>
- Defined in classes/queue-pro.ts:140

getGroupJobs

getGroupJobs(
    groupId: string | number,
    start?: number,
    end?: number,
): Promise<Job<any, any, string>[]>
Get jobs that are part of a given group.
Parameters
- groupId: string | number
- start: number = 0
- end: number = -1
Returns Promise<Job<any, any, string>[]>
- Defined in classes/queue-pro.ts:81

getGroupJobsCount

getGroupJobsCount(groupId: string | number): Promise<any>
Gets the count of jobs inside a given group id.
Parameters
- groupId: string | number
Returns Promise<any>
- Defined in classes/queue-pro.ts:102

getGroups

getGroups(start?: number, end?: number): Promise<string[]>
Get the group ids with jobs current jobs in them.

TODO: Support group id filtering.
Parameters
- start: number = 0
- end: number = -1
Returns Promise<string[]>
- Defined in classes/queue-pro.ts:32

getGroupsCount

getGroupsCount(): Promise<number>
Get the the number of groups with jobs in them.

Returns Promise<number>
- Defined in classes/queue-pro.ts:42

getGroupsJobsCount

getGroupsJobsCount(): Promise<number>
Gets the count of all the jobs belonging to any group.

Returns Promise<number>
- Defined in classes/queue-pro.ts:53

obliterate

obliterate(opts?: { count?: number; force?: boolean }): Promise<void>
Completely destroys the queue and all of its contents irreversibly. This method will the pause the queue and requires that there are no active jobs. It is possible to bypass this requirement, i.e. not having active jobs using the "force" option.

Note: This operation requires to iterate on all the jobs stored in the queue and can be slow for very large queues.
Parameters
- Optionalopts: { count?: number; force?: boolean }
  Obliterate options.
Returns Promise<void>
Overrides Queue.obliterate
- Defined in classes/queue-pro.ts:154