Class Queue<DataType, ReturnType, NameType>

Type Parameters

DataType = any
ReturnType = any
NameType extends string = string

Hierarchy

Queue<DataType, ReturnType, NameType>
- Queue

Index

Constructors

Methods

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

Constructors

constructor

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

Methods

add

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

addBulk

addBulk(jobs): Promise<Job<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<Job<DataType, ReturnType, NameType>[]>
Overrides Queue.addBulk
- Defined in src/classes/queue-pro.ts:63

deleteGroup

deleteGroup(groupId): 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:304

deleteGroups

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

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

getGroupJobs

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

getGroupJobsCount

getGroupJobsCount(groupId): 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:293

getGroupStatus

getGroupStatus(groupId): 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:234

getGroups

getGroups(start?, end?): 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:84

getGroupsByStatus

getGroupsByStatus(status, start?, end?): 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:129

getGroupsCount

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

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

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:177

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:205

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?): Promise<void>
Parameters
- Optional opts: {
  count?: number;
  force?: boolean;
  }
  - Optional count?: number
  - Optional force?: boolean
Returns Promise<void>
Overrides Queue.obliterate
- Defined in src/classes/queue-pro.ts:337

pauseGroup

pauseGroup(groupId): 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:348

repairMaxedGroup

repairMaxedGroup(groupId): 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:372

repairStalledKey

repairStalledKey(): Promise<any>
Repairs stalled key when you are migrating from v4 or below to v6 or above. This key used a zset and now it uses a set, this is why this method is needed. An error like: 'WRONGTYPE Operation against a key holding the wrong kind of value' in moveStalledJobsToWait script is a good indicator of this change. Note: Migration from v5 to v6 won't need to call this method

Returns Promise<any>
- Defined in src/classes/queue-pro.ts:383

resumeGroup

resumeGroup(groupId): 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:360

Class Queue<DataType, ReturnType, NameType>

Type Parameters

DataType = any

ReturnType = any

NameType extends string = string

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

DataType = any

ReturnType = any

NameType extends string = string

Parameters

name: string

Optional opts: QueueProOptions

Returns Queue<DataType, ReturnType, NameType>

Methods

add

Parameters

name: NameType

data: DataType

Optional opts: JobsProOptions

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

addBulk

Parameters

jobs: { data: DataType; name: NameType; opts?: BulkJobProOptions; }[]

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

deleteGroup

Parameters

groupId: string | number

Returns Promise<void>

deleteGroups

Returns Promise<void>

getGroupJobs

Parameters

groupId: string | number

start: number = 0

end: number = -1

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

getGroupJobsCount

Parameters

groupId: string | number

Returns Promise<number>

getGroupStatus

Parameters

groupId: string

Returns Promise<GroupStatus>

getGroups

Parameters

start: number = 0

end: number = -1

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

getGroupsByStatus

Parameters

status: GroupStatus

start: number = 0

end: number = -1

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>

getVersion

Returns Promise<string>

obliterate

Parameters

Optional opts: { count?: number; force?: boolean; }

Optional count?: number

Optional force?: boolean

Returns Promise<void>

pauseGroup

Parameters

groupId: string | number

Returns Promise<boolean>

repairMaxedGroup

`Optional` opts: QueueProOptions

`Optional` opts: JobsProOptions

jobs: {
data: DataType;
name: NameType;
opts?: BulkJobProOptions;
}[]

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

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

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

`Optional` opts: {
count?: number;
force?: boolean;
}

`Optional` count?: number

`Optional` force?: boolean