Module v2

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

BackoffFunction: ((attemptsMade?, err?, job?) => number)

Type declaration

    • (attemptsMade?, err?, job?): number
    • Parameters

      • Optional attemptsMade: number
      • Optional err: Error
      • Optional job: Job

      Returns number

BulkJobOptions: Omit<JobsOptions, "repeat">
ClusterOptions: IORedis.ClusterOptions & BaseOptions
ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster
EntryId: string
EntryRaw: [EntryId, string[]]
FinishedPropValAttribute: "returnvalue" | "failedReason"
FinishedStatus: "completed" | "failed"
FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>
FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>
JobData: [JobJsonRaw | number, string?]
JobJsonSandbox: JobJson & {
    prefix: string;
    queueName: string;
}

Type declaration

  • prefix: string
  • queueName: string
JobState: FinishedStatus | "active" | "delayed" | "waiting" | "waiting-children"
JobType: JobState | "paused" | "repeat" | "wait"
JobsOptions: BaseJobOptions & {
    failParentOnFailure?: boolean;
}

Type declaration

  • Optional failParentOnFailure?: boolean

    If true, moves parent to failed.

KeysMap: {
    [index in string]: string
}
MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">
ParentOpts: {
    parentDependenciesKey?: string;
    parentKey?: string;
    waitChildrenKey?: string;
}

Type declaration

  • Optional parentDependenciesKey?: string
  • Optional parentKey?: string
  • Optional waitChildrenKey?: string
Processor<T, R, N>: ((job, token?) => Promise<R>)

Type Parameters

  • T = any

  • R = any

  • N extends string = string

Type declaration

    • (job, token?): Promise<R>
    • An async function that receives Jobs and handles them.

      Parameters

      • job: Job<T, R, N>
      • Optional token: string

      Returns Promise<R>

RedisClient: Redis | Cluster
RedisJobOptions: BaseJobOptions & {
    fpof?: boolean;
}

These fields are the ones stored in Redis with smaller keys for compactness.

Type declaration

  • Optional fpof?: boolean

    If true, moves parent to failed.

RedisOptions: IORedis.RedisOptions & BaseOptions
RepeatStrategy: ((millis, opts, name?) => number)

Type declaration

    • (millis, opts, name?): number
    • Parameters

      Returns number

SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

Type Parameters

  • T = any

  • R = any

Type declaration

    • (job): R | PromiseLike<R>
    • Parameters

      Returns R | PromiseLike<R>

Type declaration

    • (job, callback): void
    • Parameters

      • job: SandboxedJob<T, R>
      • callback: ((error, result) => void)
          • (error, result): void
          • Parameters

            • error: unknown
            • result: R

            Returns void

      Returns void

StreamName: string
StreamReadRaw: [StreamName, EntryRaw[]][]

Generated using TypeDoc