Type Aliases
ActiveEventCallback3
ActiveEventCallback3<T>: ((job,
jobPromise?) => void) Type declaration
- (job, jobPromise?): void
Returns void
BackoffFunction
BackoffFunction: ((attemptsMade?, err?, job?) => number)
Type declaration
- (attemptsMade?, err?, job?): number
Parameters
Optional attemptsMade: numberOptional err: ErrorOptional job: Job
Returns number
CleanedEventCallback3
CleanedEventCallback3<T>: ((jobs,
status) => void) Type declaration
- (jobs, status): void
Returns void
CompletedEventCallback3
CompletedEventCallback3<T>: ((job,
result) => void) Type declaration
- (job, result): void
Returns void
ErrorEventCallback3
ErrorEventCallback3: ((error) => void)
Type declaration
- (error): void
Returns void
EventCallback3
EventCallback3: (() => void)
FailedEventCallback3
FailedEventCallback3<T>: ((job,
error) => void) Type declaration
- (job, error): void
Returns void
FinishedPropValAttribute
FinishedPropValAttribute: "returnvalue" | "failedReason"
FinishedStatus
FinishedStatus: "completed" | "failed"
FlowQueuesOpts
FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">> JobJsonSandbox
JobJsonSandbox: JobJson & { prefix: string; queueName: string; } Type declaration
prefix: string
queueName: string
JobState
JobState: FinishedStatus | "active" | "delayed" | "waiting" | "waiting-children" JobStatusClean3
JobStatusClean3: "completed" | "wait" | "active" | "delayed" | "paused" | "failed"
JobType
JobType: JobState | "paused" | "repeat" | "wait" KeysMap
KeysMap: {
[index in string]: string
}
MinimalQueue
MinimalQueue: 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,
token?) => Promise<R>) Type Parameters
- T = any
- R = any
- N extends string = string
Type declaration
- (job, token?): Promise<R>
Parameters
- job: Job<T, R, N>
Optional token: string
Returns Promise<R>
ProgressEventCallback3
ProgressEventCallback3<T>: ((job,
progress) => void) Type declaration
- (job, progress): void
Returns void
RedisClient
RedisClient: Redis | Cluster
RemovedEventCallback3
RemovedEventCallback3<T>: ((job) => void) RepeatStrategy
RepeatStrategy: ((millis, opts, name?) => number)
Type declaration
- (millis, opts, name?): number
Returns number
SandboxedJobProcessor
SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job,
callback) => void) Type declaration
- (job): R | PromiseLike<R>
Returns R | PromiseLike<R>
Type declaration
- (job, callback): void
Parameters
- job: SandboxedJob<T, R>
- callback: ((error, result) => void)
- (error, result): void
Returns void
Returns void
StalledEventCallback3
StalledEventCallback3<T>: ((job) => void) StreamName
StreamName: string
WaitingEventCallback3
WaitingEventCallback3: ((jobId) => void)
Type declaration
- (jobId): void
Returns void
An async function that receives
Jobs and handles them.