Class Scripts

Constructors

constructor

new Scripts(queue: MinimalQueue): Scripts
Parameters
- queue: MinimalQueue
Returns Scripts
- Defined in classes/scripts.ts:55

Methods

addJob

addJob(
    client: RedisClient,
    job: JobJson,
    opts: JobsOptions,
    jobId: string,
    parentOpts?: ParentOpts,
): Promise<string>
Parameters
- client: RedisClient
- job: JobJson
- opts: JobsOptions
- jobId: string
- parentOpts: ParentOpts = ...
Returns Promise<string>
- Defined in classes/scripts.ts:68

changeDelay

changeDelay(jobId: string, delay: number): Promise<void>
Parameters
- jobId: string
- delay: number
Returns Promise<void>
- Defined in classes/scripts.ts:458

cleanJobsInSet

cleanJobsInSet(
    set: string,
    timestamp: number,
    limit?: number,
): Promise<string[]>
Remove jobs in a specific state.
Parameters
- set: string
- timestamp: number
- limit: number = 0
Returns Promise<string[]>
Id jobs from the deleted records.
- Defined in classes/scripts.ts:591

drain

drain(delayed: boolean): Promise<void>
Parameters
- delayed: boolean
Returns Promise<void>
- Defined in classes/scripts.ts:377

extendLock

extendLock(jobId: string, token: string, duration: number): Promise<number>
Parameters
- jobId: string
- token: string
- duration: number
Returns Promise<number>
- Defined in classes/scripts.ts:185

finishedErrors

finishedErrors(
    code: number,
    jobId: string,
    command: string,
    state?: string,
): Error
Parameters
- code: number
- jobId: string
- command: string
- Optionalstate: string
Returns Error
- Defined in classes/scripts.ts:340

getState

getState(jobId: string): Promise<"unknown" | JobState>
Parameters
- jobId: string
Returns Promise<"unknown" | JobState>
- Defined in classes/scripts.ts:437

isFinished

isFinished(
jobId: string,
returnValue?: boolean,
): Promise<number | [number, string]>
Parameters
- jobId: string
- returnValue: boolean = false
Returns Promise<number | [number, string]>
- Defined in classes/scripts.ts:422

isJobInList

isJobInList(listKey: string, jobId: string): Promise<boolean>
Parameters
- listKey: string
- jobId: string
Returns Promise<boolean>
- Defined in classes/scripts.ts:57

moveStalledJobsToWait

moveStalledJobsToWait(): Promise<[string[], string[]]>
Looks for unlocked jobs in the active queue.

The job was being worked on, but the worker process died and it failed to renew the lock. We call these jobs 'stalled'. This is the most common case. We resolve these by moving them back to wait to be re-processed. To prevent jobs from cycling endlessly between active and wait, (e.g. if the job handler keeps crashing), we limit the number stalled job recoveries to settings.maxStalledCount.

Returns Promise<[string[], string[]]>
- Defined in classes/scripts.ts:784

moveToActive

moveToActive(
token: string,
jobId?: string,
): Promise<[] | [number | JobJsonRaw, string?]>
Parameters
- token: string
- OptionaljobId: string
Returns Promise<[] | [number | JobJsonRaw, string?]>
- Defined in classes/scripts.ts:694

moveToCompleted

moveToCompleted<T = any, R = any, N extends string = string>(
    job: Job<T, R, N>,
    returnvalue: R,
    removeOnComplete: number | boolean | KeepJobs,
    token: string,
    fetchNext: boolean,
): Promise<[] | JobData>
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- job: Job<T, R, N>
- returnvalue: R
- removeOnComplete: number | boolean | KeepJobs
- token: string
- fetchNext: boolean
Returns Promise<[] | JobData>
- Defined in classes/scripts.ts:384

moveToDelayed

moveToDelayed(jobId: string, timestamp: number, token?: string): Promise<void>
Parameters
- jobId: string
- timestamp: number
- token: string = '0'
Returns Promise<void>
- Defined in classes/scripts.ts:536

moveToDelayedArgs

moveToDelayedArgs(jobId: string, timestamp: number, token: string): string[]
Parameters
- jobId: string
- timestamp: number
- token: string
Returns string[]
- Defined in classes/scripts.ts:491

moveToFailedArgs

moveToFailedArgs<T = any, R = any, N extends string = string>(
    job: Job<T, R, N>,
    failedReason: string,
    removeOnFailed: number | boolean | KeepJobs,
    token: string,
    fetchNext?: boolean,
): (string | number | boolean | Buffer)[]
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- job: Job<T, R, N>
- failedReason: string
- removeOnFailed: number | boolean | KeepJobs
- token: string
- fetchNext: boolean = false
Returns (string | number | boolean | Buffer)[]
- Defined in classes/scripts.ts:402

moveToWaitingChildren

moveToWaitingChildren(
    jobId: string,
    token: string,
    opts?: MoveToWaitingChildrenOpts,
): Promise<boolean>
Move parent job to waiting-children state.
Parameters
- jobId: string
- token: string
- opts: MoveToWaitingChildrenOpts = {}
Returns Promise<boolean>
true if job is successfully moved, false if there are pending dependencies.

Throws
JobNotExist This exception is thrown if jobId is missing.

Throws
JobLockNotExist This exception is thrown if job lock is missing.

Throws
JobNotInState This exception is thrown if job is not in active state.
- Defined in classes/scripts.ts:561

moveToWaitingChildrenArgs

moveToWaitingChildrenArgs(
    jobId: string,
    token: string,
    opts?: MoveToWaitingChildrenOpts,
): string[]
Parameters
- jobId: string
- token: string
- Optionalopts: MoveToWaitingChildrenOpts
Returns string[]
- Defined in classes/scripts.ts:513

obliterate

obliterate(opts: { count: number; force: boolean }): Promise<number>
Parameters
- opts: { count: number; force: boolean }
Returns Promise<number>
- Defined in classes/scripts.ts:807

pause

pause(pause: boolean): Promise<void>
Parameters
- pause: boolean
Returns Promise<void>
- Defined in classes/scripts.ts:136

promote

promote(jobId: string): Promise<number>
Parameters
- jobId: string
Returns Promise<number>
- Defined in classes/scripts.ts:758

remove

remove(jobId: string): Promise<number>
Parameters
- jobId: string
Returns Promise<number>
- Defined in classes/scripts.ts:178

removeRepeatable

removeRepeatable(repeatJobId: string, repeatJobKey: string): Promise<number>
Parameters
- repeatJobId: string
- repeatJobKey: string
Returns Promise<number>
- Defined in classes/scripts.ts:168

reprocessJob

reprocessJob<T = any, R = any, N extends string = string>(
job: Job<T, R, N>,
state: "completed" | "failed",
): Promise<void>
Attempts to reprocess a job
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- job: Job<T, R, N>
- state: "completed" | "failed"
  The expected job state. If the job is not found on the provided state, then it's not reprocessed. Supported states: 'failed', 'completed'
Returns Promise<void>
Returns a promise that evaluates to a return code: 1 means the operation was a success 0 means the job does not exist -1 means the job is currently locked and can't be retried. -2 means the job was not found in the expected set
- Defined in classes/scripts.ts:664

retryJobArgs

retryJobArgs(jobId: string, lifo: boolean, token: string): string[]
Parameters
- jobId: string
- lifo: boolean
- token: string
Returns string[]
- Defined in classes/scripts.ts:608

retryJobs

retryJobs(
    state?: FinishedStatus,
    count?: number,
    timestamp?: number,
): Promise<number>
Parameters
- state: FinishedStatus = 'failed'
- count: number = 1000
- timestamp: number = ...
Returns Promise<number>
- Defined in classes/scripts.ts:639

updateData

updateData<T = any, R = any, N extends string = string>(
job: Job<T, R, N>,
data: T,
): Promise<void>
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- job: Job<T, R, N>
- data: T
Returns Promise<void>
- Defined in classes/scripts.ts:201

updateDelaySet

updateDelaySet(delayedTimestamp: number): Promise<[number, string]>
It checks if the job in the top of the delay set should be moved back to the top of the wait queue (so that it will be processed as soon as possible)
Parameters
- delayedTimestamp: number
Returns Promise<[number, string]>
- Defined in classes/scripts.ts:740

updateProgress

updateProgress<T = any, R = any, N extends string = string>(
job: Job<T, R, N>,
progress: number | object,
): Promise<void>
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- job: Job<T, R, N>
- progress: number | object
Returns Promise<void>
- Defined in classes/scripts.ts:217

Class Scripts

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Scripts

Methods

addJob

Parameters

Returns Promise<string>

changeDelay

Parameters

Returns Promise<void>

cleanJobsInSet

Parameters

Returns Promise<string[]>

drain

Parameters

Returns Promise<void>

extendLock

Parameters

Returns Promise<number>

finishedErrors

Parameters

Returns Error

getState

Parameters

Returns Promise<"unknown" | JobState>

isFinished

Parameters

Returns Promise<number | [number, string]>

isJobInList

Parameters

Returns Promise<boolean>

moveStalledJobsToWait

Returns Promise<[string[], string[]]>

moveToActive

Parameters

Returns Promise<[] | [number | JobJsonRaw, string?]>

moveToCompleted

Type Parameters

Parameters

Returns Promise<[] | JobData>

moveToDelayed

Parameters

Returns Promise<void>

moveToDelayedArgs

Parameters

Returns string[]

moveToFailedArgs

Type Parameters

Parameters

Returns (string | number | boolean | Buffer)[]

moveToWaitingChildren

Parameters

Returns Promise<boolean>

Throws

Throws

Throws

moveToWaitingChildrenArgs

Parameters

Returns string[]

obliterate

Parameters

Returns Promise<number>

pause

Parameters

Returns Promise<void>

promote

Parameters

Returns Promise<number>

remove

Parameters

Returns Promise<number>

removeRepeatable

Parameters

Returns Promise<number>

reprocessJob