Class QueuePro<DataType, ReturnType, NameType>

Type Parameters

DataType = any
ReturnType = any
NameType extends string = string

Hierarchy

Queue<DataType, ReturnType, NameType>
- QueuePro

Index

Constructors

Methods

add addBulk deleteGroup deleteGroups getGroupJobs getGroupJobsCount getGroups getGroupsByStatus getGroupsCount getGroupsCountByStatus getGroupsJobsCount getGroupStatus getVersion obliterate pauseGroup repairMaxedGroup resumeGroup

Constructors

constructor

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

Methods

add

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

addBulk

addBulk(
jobs: { data: DataType; name: NameType; opts?: BulkJobProOptions }[],
): Promise<JobPro<DataType, ReturnType, NameType>[]>
Adds an array of jobs to the queue. This method may be faster than adding one job at a time in a sequence.
Parameters
- jobs: { data: DataType; name: NameType; opts?: BulkJobProOptions }[]
  The array of jobs to add to the queue. Each job is defined by 3 properties, 'name', 'data' and 'opts'. They follow the same signature as 'Queue.add'.
Returns Promise<JobPro<DataType, ReturnType, NameType>[]>
Overrides Queue.addBulk
- Defined in src/classes/queue-pro.ts:63

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 src/classes/queue-pro.ts:308

deleteGroups

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

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

getGroupJobs

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

getGroupJobsCount

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

getGroups

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

TODO: Support group id filtering.
Parameters
- start: number = 0
- end: number = -1
Returns Promise<{ id: string; status: GroupStatus }[]>
- Defined in src/classes/queue-pro.ts:80

getGroupsByStatus

getGroupsByStatus(
    status: GroupStatus,
    start?: number,
    end?: number,
): Promise<{ count: number; id: string }[]>
Gets all the groups that are in a particular status.
Parameters
- status: GroupStatus
  GroupStatus so we can filter by status
- start: number = 0
  start index, used for pagination.
- end: number = -1
  end index, used for pagination.
Returns Promise<{ count: number; id: string }[]>
an array of objects with the group id and status.
- Defined in src/classes/queue-pro.ts:125

getGroupsCount

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

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

getGroupsCountByStatus

getGroupsCountByStatus(): Promise<
{ limited: number; maxed: number; paused: number; waiting: number },
>
Get the total number of groups with jobs in them, in their different statuses.

Returns Promise<{ limited: number; maxed: number; paused: number; waiting: number }>
- Defined in src/classes/queue-pro.ts:173

getGroupsJobsCount

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

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

getGroupStatus

getGroupStatus(groupId: string): Promise<GroupStatus>
Get the given group status.
Parameters
- groupId: string
  The group id to get the status for.
Returns Promise<GroupStatus>
GroupStatus - The status of the group or null if the group does not exist.
- Defined in src/classes/queue-pro.ts:231

getVersion

getVersion(): Promise<string>
Get library version.

Returns Promise<string>
the content of the meta.library field.
- Defined in src/classes/queue-pro.ts:38

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 src/classes/queue-pro.ts:343

pauseGroup

pauseGroup(groupId: string | number): Promise<boolean>
Pauses the processing of a specific group globally.

Adding jobs requires a LUA script to check first if the paused list exist and in that case it will add it there instead of the wait list or group list.
Parameters
- groupId: string | number
Returns Promise<boolean>
- Defined in src/classes/queue-pro.ts:354

repairMaxedGroup

repairMaxedGroup(groupId: string): Promise<any>
Repairs a maxed group.

It seems that in some unknown situations a group can become maxed although there are no active jobs in the group. This function will try to repair this situation.
Parameters
- groupId: string
  the group to repair
Returns Promise<any>
- Defined in src/classes/queue-pro.ts:379

resumeGroup

resumeGroup(groupId: string | number): Promise<boolean>
Resumes the processing of a specific group globally.

The method reverses the pause operation by resuming the processing of the group.
Parameters
- groupId: string | number
  the group to resume
Returns Promise<boolean>
- Defined in src/classes/queue-pro.ts:366

Class QueuePro<DataType, ReturnType, NameType>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns QueuePro<DataType, ReturnType, NameType>

Methods

add

Parameters

Returns Promise<JobPro<DataType, ReturnType, NameType>>

addBulk

Parameters

Returns Promise<JobPro<DataType, ReturnType, NameType>[]>

deleteGroup

Parameters

Returns Promise<void>

deleteGroups

Returns Promise<void>

getGroupJobs

Parameters

Returns Promise<JobPro<DataType, ReturnType, NameType>[]>

getGroupJobsCount

Parameters

Returns Promise<number>

getGroups

Parameters

Returns Promise<{ id: string; status: GroupStatus }[]>

getGroupsByStatus

Parameters

Returns Promise<{ count: number; id: string }[]>

getGroupsCount

Returns Promise<number>

getGroupsCountByStatus

Returns Promise<{ limited: number; maxed: number; paused: number; waiting: number }>

getGroupsJobsCount

Returns Promise<number>

getGroupStatus

Parameters

Returns Promise<GroupStatus>

getVersion

Returns Promise<string>

obliterate

Parameters

Returns Promise<void>

pauseGroup

Parameters

Returns Promise<boolean>

repairMaxedGroup

Parameters

Returns Promise<any>

resumeGroup

Parameters

Returns Promise<boolean>

Settings

On This Page