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? blockingConnection? concurrency? connection? drainDelay? limiter? lockDuration? lockRenewTime? maxStalledCount? metrics? prefix? runRetryDelay? settings? sharedConnection? skipDelayCheck? stalledInterval?

Properties

Optional autorun

autorun?: boolean

Condition to start processor at instance creation.

Optional blockingConnection

blockingConnection?: boolean

Denotes commands should retry indefinitely.

Optional concurrency

concurrency?: number

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

See

https://docs.bullmq.io/guide/workers/concurrency

Optional connection

connection?: ConnectionOptions

Options for connecting to a Redis instance.

Optional drainDelay

drainDelay?: number

Optional limiter

limiter?: RateLimiterOptions

Enable rate limiter

See

https://docs.bullmq.io/guide/rate-limiting

Optional lockDuration

lockDuration?: number

Optional lockRenewTime

lockRenewTime?: number

Optional maxStalledCount

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.

Optional metrics

metrics?: MetricsOptions

Enable collect metrics.

See

https://docs.bullmq.io/guide/metrics

Optional prefix

prefix?: string

Prefix for all queue keys.

Optional runRetryDelay

runRetryDelay?: number

Optional settings

settings?: AdvancedOptions

Optional sharedConnection

sharedConnection?: boolean

Specify if the connection is shared.

Optional skipDelayCheck

skipDelayCheck?: boolean

Optional stalledInterval

stalledInterval?: number

Number of milliseconds between stallness checks.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc