Interface WorkerOptions

Base Queue options

interface WorkerOptions {
    autorun?: boolean;
    blockingConnection?: boolean;
    concurrency?: number;
    connection?: ConnectionOptions;
    drainDelay?: number;
    limiter?: RateLimiterOptions;
    lockDuration?: number;
    lockRenewTime?: number;
    maxStalledCount?: number;
    metrics?: MetricsOptions;
    prefix?: string;
    runRetryDelay?: number;
    settings?: AdvancedOptions;
    sharedConnection?: boolean;
    skipDelayCheck?: boolean;
    stalledInterval?: number;
}

Hierarchy (view full)

Properties

autorun?: boolean

Condition to start processor at instance creation.

blockingConnection?: boolean

Denotes commands should retry indefinitely.

concurrency?: number

Amount of jobs that a single worker is allowed to work on in parallel.

connection?: ConnectionOptions

Options for connecting to a Redis instance.

drainDelay?: number

Enable rate limiter

lockDuration?: number
lockRenewTime?: number
maxStalledCount?: number

Amount of times a job can be recovered from a stalled state to the wait state. If this is exceeded, the job is moved to failed.

metrics?: MetricsOptions

Enable collect metrics.

prefix?: string

Prefix for all queue keys.

runRetryDelay?: number
settings?: AdvancedOptions
sharedConnection?: boolean

Specify if the connection is shared.

skipDelayCheck?: boolean
stalledInterval?: number

Number of milliseconds between stallness checks.

Generated using TypeDoc