Class Scripts

Hierarchy

  • Scripts

Constructors

Methods

  • Parameters

    • jobId: string
    • delay: number

    Returns Promise<void>

  • Remove jobs in a specific state.

    Returns

    Id jobs from the deleted records.

    Parameters

    • set: string
    • timestamp: number
    • limit: number = 0

    Returns Promise<string[]>

  • Parameters

    • delayed: boolean

    Returns Promise<void>

  • Parameters

    • jobId: string
    • token: string
    • duration: number

    Returns Promise<number>

  • Parameters

    • code: number
    • jobId: string
    • command: string
    • Optional state: string

    Returns Error

  • Parameters

    • jobId: string
    • returnValue: boolean = false

    Returns Promise<number | [number, string]>

  • Parameters

    • listKey: string
    • jobId: string

    Returns Promise<boolean>

  • Moves a job back from Active to Wait. This script is used when a job has been manually rate limited and needs to be moved back to wait from active status.

    Returns

    Parameters

    • client: ChainableCommander

      Redis client

    • jobId: string

      Job id

    Returns any

  • 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[]]>

  • Parameters

    • token: string
    • Optional jobId: string

    Returns Promise<any[]>

  • 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<any[]>

  • Parameters

    • jobId: string
    • timestamp: number
    • token: string = '0'

    Returns Promise<void>

  • Parameters

    • jobId: string
    • timestamp: number
    • token: string

    Returns (string | number)[]

  • 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)[]

  • Move parent job to waiting-children state.

    Returns

    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.

    Parameters

    Returns Promise<boolean>

  • Parameters

    • opts: {
          count: number;
          force: boolean;
      }
      • count: number
      • force: boolean

    Returns Promise<number>

  • Parameters

    • pause: boolean

    Returns Promise<void>

  • Parameters

    • jobId: string

    Returns Promise<number>

  • Parameters

    • jobId: string

    Returns Promise<number>

  • Parameters

    • repeatJobId: string
    • repeatJobKey: string

    Returns Promise<number>

  • Attempts to reprocess a job

    Returns

    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

    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>

  • Parameters

    • jobId: string
    • lifo: boolean
    • token: string

    Returns (string | number)[]

  • Type Parameters

    • T = any

    • R = any

    • N extends string = string

    Parameters

    • job: Job<T, R, N>
    • data: T

    Returns Promise<void>

  • Type Parameters

    • T = any

    • R = any

    • N extends string = string

    Parameters

    • job: Job<T, R, N>
    • progress: number | object

    Returns Promise<void>

Generated using TypeDoc