Type aliases
ActiveEventCallback3
Type parameters
BackoffFunction
Backoff
Function
: (attemptsMade
?: number, err
?: Error, job
?: Job) => numberType declaration
- (attemptsMade?: number, err?: Error, job?: Job): number
Parameters
Optional attemptsMade: number
Optional err: Error
Optional job: Job
Returns number
CleanedEventCallback3
Type parameters
ClusterOptions
ClusterOptions: IORedis.ClusterOptions & BaseOptions
CompletedEventCallback3
Completed
Event
Callback3
<T>: (job
: Job, result
: any) => voidType parameters
Type declaration
- (job: Job, result: any): void
ErrorEventCallback3
ErrorEventCallback3: (error: Error) => void
EventCallback3
EventCallback3: () => void
FailedEventCallback3
Failed
Event
Callback3
<T>: (job
: Job, error
: Error) => voidType parameters
Type declaration
- (job: Job, error: Error): void
FinishedPropValAttribute
FinishedPropValAttribute: "returnvalue" | "failedReason"
FinishedStatus
FinishedStatus: "completed" | "failed"
FlowQueuesOpts
Flow
Queues
Opts
: Record<string, Omit<QueueOptions, "connection" | "prefix">>JobState
Job
State
: FinishedStatus | "active" | "delayed" | "waiting" | "waiting-children"JobStatusClean3
JobStatusClean3: "completed" | "wait" | "active" | "delayed" | "paused" | "failed"
JobType
Job
Type
: JobState | "paused" | "repeat" | "wait"KeysMap
KeysMap: { [ index in string]: string }
MinimalQueue
Minimal
Queue
: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">ParentOpts
ParentOpts: { parentDependenciesKey?: string; parentKey?: string; waitChildrenKey?: string }
Type declaration
Optional parentDependenciesKey?: string
Optional parentKey?: string
Optional waitChildrenKey?: string
Processor
Processor
<T, R, N>: (job
: Job<T, R, N>, token
?: string) => Promise<R>Type parameters
T = any
R = any
N: string = string
Type declaration
- (job: Job<T, R, N>, token?: string): Promise<R>
Parameters
job: Job<T, R, N>
Optional token: string
Returns Promise<R>
ProgressEventCallback3
Progress
Event
Callback3
<T>: (job
: Job, progress
: any) => voidType parameters
Type declaration
- (job: Job, progress: any): void
RedisClient
RedisClient: Redis | Cluster
RedisOptions
RedisOptions: IORedis.RedisOptions & BaseOptions
RemovedEventCallback3
Removed
Event
Callback3
<T>: (job
: Job) => voidType parameters
SandboxedJobProcessor
Sandboxed
Job
Processor
<T, R>: ((job
: SandboxedJob<T, R>) => R | PromiseLike<R>) | ((job
: SandboxedJob<T, R>, callback
: (error
: unknown, result
: R) => void) => void)Type parameters
StalledEventCallback3
Stalled
Event
Callback3
<T>: (job
: Job) => voidType parameters
StreamName
StreamName: string
WaitingEventCallback3
WaitingEventCallback3: (jobId: string) => void
An async function that receives
Job
s and handles them.