diff --git a/classes/v5.AsyncFifoQueue.html b/classes/v5.AsyncFifoQueue.html index 09e7d0fc17..abc574f37d 100644 --- a/classes/v5.AsyncFifoQueue.html +++ b/classes/v5.AsyncFifoQueue.html @@ -1,11 +1,11 @@ AsyncFifoQueue | bullmq - v5.34.4

Class AsyncFifoQueue<T>

AsyncFifoQueue

A minimal FIFO queue for asynchronous operations. Allows adding asynchronous operations and consume them in the order they are resolved.

-

Type Parameters

  • T

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Methods

add fetch numPending numQueued numTotal waitAll -

Constructors

constructor

Methods

add

fetch

numPending

numQueued

numTotal

waitAll

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

add

fetch

numPending

numQueued

numTotal

waitAll

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.Backoffs.html b/classes/v5.Backoffs.html index 4bae5b41c7..4af23235e9 100644 --- a/classes/v5.Backoffs.html +++ b/classes/v5.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.34.4

Class Backoffs

Constructors

constructor +Backoffs | bullmq - v5.34.4

Class Backoffs

Constructors

constructor

Properties

builtinStrategies

Methods

calculate normalize -

Constructors

constructor

Properties

Static builtinStrategies

builtinStrategies: BuiltInStrategies = ...

Methods

Static calculate

Static normalize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Static builtinStrategies

builtinStrategies: BuiltInStrategies = ...

Methods

Static calculate

Static normalize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.Child.html b/classes/v5.Child.html index 2131e6fd2d..317fbdccdf 100644 --- a/classes/v5.Child.html +++ b/classes/v5.Child.html @@ -1,7 +1,7 @@ Child | bullmq - v5.34.4

Class Child

Child class

This class is used to create a child process or worker thread, and allows using isolated processes or threads for processing jobs.

-

Hierarchy

  • EventEmitter
    • Child

Constructors

constructor +

Hierarchy

  • EventEmitter
    • Child

Constructors

constructor

Properties

childProcess processFile worker @@ -13,4 +13,4 @@ init kill send -

Constructors

constructor

Properties

childProcess

childProcess: ChildProcess

processFile

processFile: string

worker

worker: Worker

Accessors

exitCode

killed

pid

signalCode

Methods

hasProcessExited

init

kill

  • kill(signal?, timeoutMs?): Promise<void>

  • Parameters

    • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
    • Optional timeoutMs: number

    Returns Promise<void>

send

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

childProcess

childProcess: ChildProcess

processFile

processFile: string

worker

worker: Worker

Accessors

exitCode

killed

pid

signalCode

Methods

hasProcessExited

init

kill

send

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.ChildPool.html b/classes/v5.ChildPool.html index 6a2716a8d6..605fa3788d 100644 --- a/classes/v5.ChildPool.html +++ b/classes/v5.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.34.4

Class ChildPool

Constructors

constructor +ChildPool | bullmq - v5.34.4

Class ChildPool

Constructors

constructor

Properties

free retained

Methods

clean @@ -8,4 +8,4 @@ release remove retain -

Constructors

constructor

Properties

free

free: {
    [key: string]: Child[];
} = {}

Type declaration

retained

retained: {
    [key: number]: Child;
} = {}

Type declaration

Methods

clean

getAllFree

getFree

kill

  • kill(child, signal?): Promise<void>

  • Parameters

    • child: Child
    • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'

    Returns Promise<void>

release

remove

retain

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

free

free: {
    [key: string]: Child[];
} = {}

Type declaration

retained

retained: {
    [key: number]: Child;
} = {}

Type declaration

Methods

clean

getAllFree

getFree

kill

  • kill(child, signal?): Promise<void>

  • Parameters

    • child: Child
    • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'

    Returns Promise<void>

release

remove

retain

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.ChildProcessor.html b/classes/v5.ChildProcessor.html index bc4f69b51d..041ff9e1d9 100644 --- a/classes/v5.ChildProcessor.html +++ b/classes/v5.ChildProcessor.html @@ -1,7 +1,7 @@ ChildProcessor | bullmq - v5.34.4

Class ChildProcessor

ChildProcessor

This class acts as the interface between a child process and it parent process so that jobs can be processed in different processes.

-

Constructors

constructor +

Constructors

constructor

Properties

currentJobPromise processor status? @@ -9,4 +9,4 @@ start stop waitForCurrentJobAndExit -

Constructors

constructor

Properties

currentJobPromise

currentJobPromise: Promise<unknown>

processor

processor: any

Optional status

status?: ChildStatus

Methods

init

start

stop

waitForCurrentJobAndExit

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

currentJobPromise

currentJobPromise: Promise<unknown>

processor

processor: any

Optional status

status?: ChildStatus

Methods

init

start

stop

waitForCurrentJobAndExit

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.DelayedError.html b/classes/v5.DelayedError.html index 00730d7e99..24ad4c821f 100644 --- a/classes/v5.DelayedError.html +++ b/classes/v5.DelayedError.html @@ -1,5 +1,5 @@ DelayedError | bullmq - v5.34.4

Class DelayedError

DelayedError

Error to be thrown when job is moved to delayed state from job in active state.

-

Hierarchy

  • Error
    • DelayedError

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.FlowProducer.html b/classes/v5.FlowProducer.html index c3855262e3..754c846739 100644 --- a/classes/v5.FlowProducer.html +++ b/classes/v5.FlowProducer.html @@ -4,7 +4,7 @@ Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data. All Jobs can be in different queues, either children or parents,

-

Hierarchy

Constructors

constructor +

Hierarchy

  • EventEmitter
    • FlowProducer

Constructors

constructor

Properties

closing keys opts @@ -21,14 +21,14 @@ on once waitUntilReady -

Constructors

constructor

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

opts

opts: QueueBaseOptions = ...

queueKeys

queueKeys: QueueKeys

toKey

toKey: ((name, type) => string)

Type declaration

    • (name, type): string

    • Parameters

      • name: string
      • type: string

      Returns string

Accessors

client

Methods

add

  • add(flow, opts?): Promise<JobNode>

  • Adds a flow.

    +

Constructors

constructor

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

opts

opts: QueueBaseOptions = ...

queueKeys

queueKeys: QueueKeys

toKey

toKey: ((name, type) => string)

Type declaration

    • (name, type): string

    • Parameters

      • name: string
      • type: string

      Returns string

Accessors

client

Methods

add

addBulk

Returns Promise<JobNode>

addBulk

close

disconnect

emit

getFlow

Returns Promise<JobNode[]>

close

disconnect

emit

getFlow

off

on

once

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<JobNode>

off

on

once

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v5.Job.html b/classes/v5.Job.html index 10a1cac1e9..bb9b9179f2 100644 --- a/classes/v5.Job.html +++ b/classes/v5.Job.html @@ -3,7 +3,7 @@ you add a job to the queue with methods such as Queue.addJob( ... )

A Job instance is also passed to the Worker's process function.

Job

-

Type Parameters

Implements

Constructors

constructor +

Type Parameters

  • DataType = any
  • ReturnType = any
  • NameType extends string = string

Implements

Constructors

constructor

Properties

attemptsMade attemptsStarted data @@ -72,146 +72,146 @@

Constructors

constructor

Properties

attemptsMade

attemptsMade: number = 0

Number of attempts after the job has failed.

+
  • Optional id: string

    • Returns Job<DataType, ReturnType, NameType>

    Properties

    attemptsMade

    attemptsMade: number = 0

    Number of attempts after the job has failed.

    Default Value

    0
    -

    attemptsStarted

    attemptsStarted: number = 0

    Number of attempts when job is moved to active.

    +

    attemptsStarted

    attemptsStarted: number = 0

    Number of attempts when job is moved to active.

    Default Value

    0
    -

    data

    data: DataType

    The payload for this job.

    -

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    +

    data

    data: DataType

    The payload for this job.

    +

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    Deprecated

    use deduplicationId

    -

    Optional deduplicationId

    deduplicationId?: string

    Deduplication identifier.

    -

    delay

    delay: number = 0

    An amount of milliseconds to wait until this job can be processed.

    +

    Optional deduplicationId

    deduplicationId?: string

    Deduplication identifier.

    +

    delay

    delay: number = 0

    An amount of milliseconds to wait until this job can be processed.

    Default Value

    0
    -

    failedReason

    failedReason: string

    Reason for failing.

    -

    Optional finishedOn

    finishedOn?: number

    Timestamp for when the job finished (completed or failed).

    -

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    -

    Optional nextRepeatableJobId

    nextRepeatableJobId?: string

    Produced next repetable job Id.

    -

    opts

    opts: JobsOptions = {}

    The options object for this job.

    -

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    -

    Optional parentKey

    parentKey?: string

    Fully qualified key (including the queue prefix) pointing to the parent of this job.

    -

    priority

    priority: number = 0

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that +

    failedReason

    failedReason: string

    Reason for failing.

    +

    Optional finishedOn

    finishedOn?: number

    Timestamp for when the job finished (completed or failed).

    +

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    +

    Optional nextRepeatableJobId

    nextRepeatableJobId?: string

    Produced next repetable job Id.

    +

    opts

    opts: JobsOptions = {}

    The options object for this job.

    +

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    +

    Optional parentKey

    parentKey?: string

    Fully qualified key (including the queue prefix) pointing to the parent of this job.

    +

    priority

    priority: number = 0

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

    Default Value

    0
    -

    Optional processedBy

    processedBy?: string

    The worker name that is processing or processed this job.

    -

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    -

    progress

    progress: number | object = 0

    The progress a job has performed so far.

    +

    Optional processedBy

    processedBy?: string

    The worker name that is processing or processed this job.

    +

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    +

    progress

    progress: number | object = 0

    The progress a job has performed so far.

    Default Value

    0
    -

    Readonly queueQualifiedName

    queueQualifiedName: string

    It includes the prefix, the namespace separator :, and queue name.

    +

    Readonly queueQualifiedName

    queueQualifiedName: string

    It includes the prefix, the namespace separator :, and queue name.

    See

    https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html

    -

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    -

    returnvalue

    returnvalue: ReturnType = null

    The value returned by the processor when processing this job.

    +

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    +

    returnvalue

    returnvalue: ReturnType = null

    The value returned by the processor when processing this job.

    Default Value

    null
    -

    stacktrace

    stacktrace: string[] = null

    Stacktrace for the error (for failed jobs).

    +

    stacktrace

    stacktrace: string[] = null

    Stacktrace for the error (for failed jobs).

    Default Value

    null
    -

    timestamp

    timestamp: number

    Timestamp when the job was created (unless overridden with job options).

    -

    Optional token

    token?: string

    The token used for locking this job.

    -

    Accessors

    prefix

    queueName

    Methods

    addJob

    asJSON

    asJSONSandbox

    changeDelay

    timestamp

    timestamp: number

    Timestamp when the job was created (unless overridden with job options).

    +

    Optional token

    token?: string

    The token used for locking this job.

    +

    Accessors

    prefix

    queueName

    Methods

    addJob

    asJSON

    asJSONSandbox

    changeDelay

    changePriority

    changePriority

    clearLogs

    clearLogs

    discard

    extendLock

    Returns Promise<void>

    discard

    extendLock

    getChildrenValues

    Returns Promise<number>

    getChildrenValues

    getDependencies

    getDependencies

    getDependenciesCount

    getDependenciesCount

    getFailedChildrenValues

    getFailedChildrenValues

    getState

    getState

    isActive

    isCompleted

    isDelayed

    isFailed

    isWaiting

    isWaitingChildren

    log

    isActive

    isCompleted

    isDelayed

    isFailed

    isWaiting

    isWaitingChildren

    log

    moveToCompleted

    moveToCompleted

    moveToDelayed

    moveToDelayed

    moveToFailed

    Returns Promise<void>

    moveToFailed

    moveToWaitingChildren

    moveToWaitingChildren

    promote

    remove

    promote

    remove

    removeChildDependency

    Returns Promise<void>

    removeChildDependency

    retry

    retry

    toJSON

    updateData

    toJSON

    updateData

    updateProgress

    Returns Promise<void>

    updateProgress

    waitUntilFinished

    Returns Promise<void>

    waitUntilFinished

    Static addJobLog

    Returns Promise<ReturnType>

    Static addJobLog

    Static create

    Static create

    Static createBulk

    Returns Promise<Job<T, R, N>>

    Static createBulk

    Static fromId

    Returns Promise<Job<T, R, N>[]>

    Static fromId

    Static fromJSON

    Returns Promise<Job<T, R, N>>

    Static fromJSON

    Static optsAsJSON

    Static optsFromJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Static optsAsJSON

    Static optsFromJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.JobScheduler.html b/classes/v5.JobScheduler.html index 5936b613da..5ead489f02 100644 --- a/classes/v5.JobScheduler.html +++ b/classes/v5.JobScheduler.html @@ -1,7 +1,7 @@ JobScheduler | bullmq - v5.34.4

    Class JobScheduler

    QueueBase

    Description

    Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -20,17 +20,17 @@ trace upsertJobScheduler waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      -

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      +

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getJobSchedulers

    getScheduler

    getSchedulersCount

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<number>

    • Parameters

      • jobSchedulerId: string

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +
    • Rest ...args: any[]

    Returns boolean

    getJobSchedulers

    getScheduler

    getSchedulersCount

    removeJobScheduler

    trace

    upsertJobScheduler

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    upsertJobScheduler

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Queue.html b/classes/v5.Queue.html index 9a4c770511..4a79fdada4 100644 --- a/classes/v5.Queue.html +++ b/classes/v5.Queue.html @@ -6,7 +6,7 @@

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing jobsOpts keys @@ -91,60 +91,60 @@ updateJobProgress upsertJobScheduler waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    jobsOpts

    jobsOpts: BaseJobOptions

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueOptions

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    token

    token: string = ...

    Accessors

    client

    defaultJobOptions

    jobScheduler

    metaValues

    • get metaValues(): Record<string, string | number>

    • Returns Record<string, string | number>

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    repeat

    Methods

    add

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    jobsOpts

    jobsOpts: BaseJobOptions

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueOptions

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    token

    token: string = ...

    Accessors

    client

    defaultJobOptions

    jobScheduler

    metaValues

    redisVersion

    repeat

    Methods

    add

    addBulk

    Returns Promise<Job<DataType, ResultType, NameType>>

    addBulk

    addJobLog

    Returns Promise<Job<DataType, ResultType, NameType>[]>

    addJobLog

    clean

    clean

    close

    count

    close

    count

    disconnect

    drain

    disconnect

    drain

    emit

    Returns Promise<void>

    emit

    getActive

    Returns boolean

    getActive

    getActiveCount

    getCompleted

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    getDeduplicationJobId

    getDeduplicationJobId

    getDelayed

    Returns Promise<string>

    getDelayed

    getDelayedCount

    getDependencies

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getDelayedCount

    getDependencies

    getFailed

    Returns Promise<{
        items: {
            err?: string;
            id: string;
            v?: any;
        }[];
        jobs: JobJsonRaw[];
        total: number;
    }>

    getFailed

    getFailedCount

    getGlobalConcurrency

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getFailedCount

    getGlobalConcurrency

    getJob

    getJobCountByTypes

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobScheduler

    Returns Promise<{
        count: number;
        logs: string[];
    }>

    getJobScheduler

    getJobSchedulers

    Returns Promise<JobSchedulerJson<DataType>>

    getJobSchedulers

    getJobSchedulersCount

    Returns Promise<JobSchedulerJson<DataType>[]>

    getJobSchedulersCount

    getJobState

    getJobState

    getJobs

    getJobs

    getMetrics

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getRepeatableJobs

    getRepeatableJobs

    getVersion

    getVersion

    getWaiting

    getWaiting

    getWaitingChildren

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    getWorkersCount

    getWorkersCount

    isMaxed

    isPaused

    obliterate

    isMaxed

    isPaused

    obliterate

    off

    on

    once

    pause

    Returns Promise<void>

    off

    on

    once

    pause

    promoteJobs

    rateLimit

    promoteJobs

    rateLimit

    remove

    Returns Promise<void>

    remove

    removeDebounceKey

    removeDebounceKey

    removeDeduplicationKey

    removeDeduplicationKey

    removeDeprecatedPriorityKey

    removeJobScheduler

    removeRateLimitKey

    removeRepeatable

    Returns Promise<number>

    removeDeprecatedPriorityKey

    removeJobScheduler

    removeRateLimitKey

    removeRepeatable

    removeRepeatableByKey

    removeRepeatableByKey

    resume

    resume

    retryJobs

    setGlobalConcurrency

    retryJobs

    setGlobalConcurrency

    trace

    Returns Promise<number>

    trace

    trimEvents

    updateJobProgress

    Returns Promise<T | Promise<T>>

    trimEvents

    updateJobProgress

    upsertJobScheduler

    Returns Promise<void>

    upsertJobScheduler

    Returns Promise<Job<DataType, ResultType, NameType>>

    The next job to be scheduled (would normally be in delayed state).

    -

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueBase.html b/classes/v5.QueueBase.html index 4cb3446a6c..2c84715625 100644 --- a/classes/v5.QueueBase.html +++ b/classes/v5.QueueBase.html @@ -1,7 +1,7 @@ QueueBase | bullmq - v5.34.4

    Class QueueBase

    QueueBase

    Description

    Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    closing keys name @@ -19,17 +19,17 @@
  • opts: QueueBaseOptions = ...

    Options for the queue.

  • Connection: typeof RedisConnection = RedisConnection

    An optional "Connection" class used to instantiate a Connection. This is useful for testing with mockups and/or extending the Connection class and passing an alternate implementation.

    -
  • hasBlockingConnection: boolean = false

    • Returns QueueBase

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      -

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +
    • hasBlockingConnection: boolean = false

    Returns QueueBase

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      +

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +
    • Rest ...args: any[]

    Returns boolean

    trace

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueEvents.html b/classes/v5.QueueEvents.html index 6f9be7e46d..84f882d23a 100644 --- a/classes/v5.QueueEvents.html +++ b/classes/v5.QueueEvents.html @@ -1,7 +1,7 @@ QueueEvents | bullmq - v5.34.4

    Class QueueEvents

    The QueueEvents class is used for listening to the global events emitted by a given queue.

    This class requires a dedicated redis connection.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -19,19 +19,19 @@ run trace waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    disconnect

    emit

    • emit<QEL, U>(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    disconnect

    emit

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not +

    • Rest ...args: CustomParameters<QEL[U]>

    Returns boolean

    off

    on

    once

    run

    trace

    trace

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueEventsProducer.html b/classes/v5.QueueEventsProducer.html index 9ede29874a..7c03cee1dc 100644 --- a/classes/v5.QueueEventsProducer.html +++ b/classes/v5.QueueEventsProducer.html @@ -1,5 +1,5 @@ QueueEventsProducer | bullmq - v5.34.4

    Class QueueEventsProducer

    The QueueEventsProducer class is used for publishing custom events.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -14,20 +14,20 @@ publishEvent trace waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    publishEvent

    • publishEvent<T>(argsObj, maxEvents?): Promise<void>

    • Publish custom event to be processed in QueueEvents.

      +
    • Rest ...args: any[]

    Returns boolean

    publishEvent

    trace

    Returns Promise<void>

    trace

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueGetters.html b/classes/v5.QueueGetters.html index bb6e54274a..9153f925e5 100644 --- a/classes/v5.QueueGetters.html +++ b/classes/v5.QueueGetters.html @@ -1,6 +1,6 @@ QueueGetters | bullmq - v5.34.4

    Class QueueGetters<JobBase>

    QueueGetters

    Description

    Provides different getters for different aspects of a queue.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -49,35 +49,35 @@
  • opts: QueueBaseOptions = ...

    Options for the queue.

  • Connection: typeof RedisConnection = RedisConnection

    An optional "Connection" class used to instantiate a Connection. This is useful for testing with mockups and/or extending the Connection class and passing an alternate implementation.

    -
  • hasBlockingConnection: boolean = false

    • Returns QueueGetters<JobBase>

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      -

      Returns Promise<void>

    count

    • count(): Promise<number>

    • Returns the number of jobs waiting to be processed. This includes jobs that are +

    • hasBlockingConnection: boolean = false

    Returns QueueGetters<JobBase>

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      +

      Returns Promise<void>

    count

    • count(): Promise<number>

    • Returns the number of jobs waiting to be processed. This includes jobs that are "waiting" or "delayed" or "prioritized" or "waiting-children".

      -

      Returns Promise<number>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +

      Returns Promise<number>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getActive

    • getActive(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "active" status.

      +
    • Rest ...args: any[]

    Returns boolean

    getActive

    getActiveCount

    getCompleted

    Returns Promise<JobBase[]>

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    Returns Promise<JobBase[]>

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    getDeduplicationJobId

    getDeduplicationJobId

    getDelayed

    Returns Promise<string>

    getDelayed

    getDelayedCount

    getDependencies

    Returns Promise<JobBase[]>

    getDelayedCount

    getDependencies

    getFailed

    Returns Promise<{
        items: {
            err?: string;
            id: string;
            v?: any;
        }[];
        jobs: JobJsonRaw[];
        total: number;
    }>

    getFailed

    getFailedCount

    getJob

    getJobCountByTypes

    Returns Promise<JobBase[]>

    getFailedCount

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobState

    Returns Promise<{
        count: number;
        logs: string[];
    }>

    getJobState

    getJobs

    getJobs

    getMetrics

    Returns Promise<JobBase[]>

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

    Returns Promise<JobBase[]>

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getWaiting

    getWaiting

    getWaitingChildren

    Returns Promise<JobBase[]>

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    Returns Promise<JobBase[]>

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    getWorkersCount

    getWorkersCount

    trace

    trace

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueKeys.html b/classes/v5.QueueKeys.html index 43abad9fb5..3cd00c696a 100644 --- a/classes/v5.QueueKeys.html +++ b/classes/v5.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.34.4

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.34.4

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getQueueQualifiedName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.RateLimitError.html b/classes/v5.RateLimitError.html index dfb9dc9138..d74813917e 100644 --- a/classes/v5.RateLimitError.html +++ b/classes/v5.RateLimitError.html @@ -1,4 +1,4 @@ RateLimitError | bullmq - v5.34.4

    Class RateLimitError

    RateLimitError

    Error to be thrown when queue reaches a rate limit.

    -

    Hierarchy

    • Error
      • RateLimitError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.RedisConnection.html b/classes/v5.RedisConnection.html index 7ecb504f2e..97d6fc5330 100644 --- a/classes/v5.RedisConnection.html +++ b/classes/v5.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.34.4

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.34.4

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

    capabilities closing status @@ -10,5 +10,5 @@ disconnect reconnect waitUntilReady -

    Constructors

    constructor

    Properties

    capabilities

    capabilities: RedisCapabilities = ...

    closing

    closing: boolean

    status

    status: "closed" | "closing" | "ready" | "initializing" = 'initializing'

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    capabilities

    capabilities: RedisCapabilities = ...

    closing

    closing: boolean

    status

    status: "closed" | "closing" | "ready" | "initializing" = 'initializing'

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Repeat.html b/classes/v5.Repeat.html index f411492513..543bf9a64f 100644 --- a/classes/v5.Repeat.html +++ b/classes/v5.Repeat.html @@ -1,7 +1,7 @@ Repeat | bullmq - v5.34.4

    Class Repeat

    QueueBase

    Description

    Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -21,17 +21,17 @@ trace updateRepeatableJob waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      -

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

    • Closes the connection and returns a promise that resolves when the connection is closed.

      +

      Returns Promise<void>

    disconnect

    emit

    • emit(event, ...args): boolean

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatJobKey

    • getRepeatJobKey<T, N>(name, nextMillis, repeatJobKey, data): string

    • Type Parameters

      • T = any
      • N extends string = string

      Parameters

      • name: N
      • nextMillis: number
      • repeatJobKey: string
      • data: T

      Returns string

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

    • removeRepeatable(name, repeat, jobId?): Promise<number>

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +
    • Rest ...args: any[]

    Returns boolean

    getRepeatJobKey

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

    removeRepeatableByKey

    trace

    updateRepeatableJob

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    updateRepeatableJob

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Scripts.html b/classes/v5.Scripts.html index 1958b5a847..397a16918a 100644 --- a/classes/v5.Scripts.html +++ b/classes/v5.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.34.4

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.34.4

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

    addJob addJobScheduler @@ -52,19 +52,19 @@ updateJobSchedulerNextMillis updateProgress updateRepeatableJobMillis -

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addJobScheduler

    addLog

    • addLog(jobId, logRow, keepLogs?): Promise<number>

    • Parameters

      • jobId: string
      • logRow: string
      • Optional keepLogs: number

      Returns Promise<number>

    addRepeatableJob

    • addRepeatableJob(customKey, nextMillis, opts, legacyCustomKey): Promise<string>

    • Parameters

      Returns Promise<string>

    changeDelay

    • changeDelay(jobId, delay): Promise<void>

    • Parameters

      • jobId: string
      • delay: number

      Returns Promise<void>

    changePriority

    • changePriority(jobId, priority?, lifo?): Promise<void>

    • Parameters

      • jobId: string
      • priority: number = 0
      • lifo: boolean = false

      Returns Promise<void>

    cleanJobsInSet

    • cleanJobsInSet(set, timestamp, limit?): Promise<string[]>

    • Remove jobs in a specific state.

      +

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addJobScheduler

    addLog

    • addLog(jobId, logRow, keepLogs?): Promise<number>

    • Parameters

      • jobId: string
      • logRow: string
      • Optional keepLogs: number

      Returns Promise<number>

    addRepeatableJob

    • addRepeatableJob(customKey, nextMillis, opts, legacyCustomKey): Promise<string>

    • Parameters

      Returns Promise<string>

    changeDelay

    • changeDelay(jobId, delay): Promise<void>

    • Parameters

      • jobId: string
      • delay: number

      Returns Promise<void>

    changePriority

    • changePriority(jobId, priority?, lifo?): Promise<void>

    • Parameters

      • jobId: string
      • priority: number = 0
      • lifo: boolean = false

      Returns Promise<void>

    cleanJobsInSet

    • cleanJobsInSet(set, timestamp, limit?): Promise<string[]>

    • Remove jobs in a specific state.

      Parameters

      • set: string
      • timestamp: number
      • limit: number = 0

      Returns Promise<string[]>

      Id jobs from the deleted records.

      -

    drain

    execCommand

    • execCommand(client, commandName, args): any

    • Parameters

      • client: ChainableCommander | RedisClient
      • commandName: string
      • args: any[]

      Returns any

    extendLock

    • extendLock(jobId, token, duration, client?): Promise<number>

    • Parameters

      • jobId: string
      • token: string
      • duration: number
      • Optional client: ChainableCommander | RedisClient

      Returns Promise<number>

    extendLocks

    • extendLocks(jobIds, tokens, duration): Promise<string[]>

    • Parameters

      • jobIds: string[]
      • tokens: string[]
      • duration: number

      Returns Promise<string[]>

    finishedErrors

    • finishedErrors(__namedParameters): Error

    • Parameters

      • __namedParameters: {
            code: number;
            command: string;
            jobId?: string;
            parentKey?: string;
            state?: string;
        }
        • code: number
        • command: string
        • Optional jobId?: string
        • Optional parentKey?: string
        • Optional state?: string

      Returns Error

    getCounts

    getCountsPerPriority

    • getCountsPerPriority(priorities): Promise<number[]>

    • Parameters

      • priorities: number[]

      Returns Promise<number[]>

    getJobScheduler

    • getJobScheduler(id): Promise<[any, string]>

    • Parameters

      • id: string

      Returns Promise<[any, string]>

    getJobSchedulerArgs

    getRanges

    • getRanges(types, start?, end?, asc?): Promise<[string][]>

    • Parameters

      • types: JobType[]
      • start: number = 0
      • end: number = 1
      • asc: boolean = false

      Returns Promise<[string][]>

    getRateLimitTtl

    • getRateLimitTtl(maxJobs?): Promise<number>

    • Parameters

      • Optional maxJobs: number

      Returns Promise<number>

    getRateLimitTtlArgs

    • getRateLimitTtlArgs(maxJobs?): (string | number)[]

    • Parameters

      • Optional maxJobs: number

      Returns (string | number)[]

    getRepeatConcatOptions

    • getRepeatConcatOptions(repeatConcatOptions, repeatJobKey): string

    • Parameters

      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns string

    getState

    isFinished

    • isFinished(jobId, returnValue?): Promise<number | [number, string]>

    • Parameters

      • jobId: string
      • returnValue: boolean = false

      Returns Promise<number | [number, string]>

    isJobInList

    • isJobInList(listKey, jobId): Promise<boolean>

    • Parameters

      • listKey: string
      • jobId: string

      Returns Promise<boolean>

    isMaxed

    isMaxedArgs

    moveJobFromActiveToWait

    • moveJobFromActiveToWait(jobId, token): Promise<any>

    • Moves a job back from Active to Wait. +

    drain

    execCommand

    • execCommand(client, commandName, args): any

    • Parameters

      • client: ChainableCommander | RedisClient
      • commandName: string
      • args: any[]

      Returns any

    extendLock

    • extendLock(jobId, token, duration, client?): Promise<number>

    • Parameters

      • jobId: string
      • token: string
      • duration: number
      • Optional client: ChainableCommander | RedisClient

      Returns Promise<number>

    extendLocks

    • extendLocks(jobIds, tokens, duration): Promise<string[]>

    • Parameters

      • jobIds: string[]
      • tokens: string[]
      • duration: number

      Returns Promise<string[]>

    finishedErrors

    • finishedErrors(__namedParameters): Error

    • Parameters

      • __namedParameters: {
            code: number;
            command: string;
            jobId?: string;
            parentKey?: string;
            state?: string;
        }
        • code: number
        • command: string
        • Optional jobId?: string
        • Optional parentKey?: string
        • Optional state?: string

      Returns Error

    getCounts

    getCountsPerPriority

    • getCountsPerPriority(priorities): Promise<number[]>

    • Parameters

      • priorities: number[]

      Returns Promise<number[]>

    getJobScheduler

    • getJobScheduler(id): Promise<[any, string]>

    • Parameters

      • id: string

      Returns Promise<[any, string]>

    getJobSchedulerArgs

    getRanges

    • getRanges(types, start?, end?, asc?): Promise<[string][]>

    • Parameters

      • types: JobType[]
      • start: number = 0
      • end: number = 1
      • asc: boolean = false

      Returns Promise<[string][]>

    getRateLimitTtl

    • getRateLimitTtl(maxJobs?): Promise<number>

    • Parameters

      • Optional maxJobs: number

      Returns Promise<number>

    getRateLimitTtlArgs

    • getRateLimitTtlArgs(maxJobs?): (string | number)[]

    • Parameters

      • Optional maxJobs: number

      Returns (string | number)[]

    getRepeatConcatOptions

    • getRepeatConcatOptions(repeatConcatOptions, repeatJobKey): string

    • Parameters

      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns string

    getState

    isFinished

    • isFinished(jobId, returnValue?): Promise<number | [number, string]>

    • Parameters

      • jobId: string
      • returnValue: boolean = false

      Returns Promise<number | [number, string]>

    isJobInList

    • isJobInList(listKey, jobId): Promise<boolean>

    • Parameters

      • listKey: string
      • jobId: string

      Returns Promise<boolean>

    isMaxed

    isMaxedArgs

    moveJobFromActiveToWait

    • moveJobFromActiveToWait(jobId, token): Promise<any>

    • Moves a job back from Active to Wait. This script is used when a job has been manually rate limited and needs to be moved back to wait from active status.

      Parameters

      • jobId: string

        Job id

        -
      • token: string

      Returns Promise<any>

    moveStalledJobsToWait

    • moveStalledJobsToWait(): Promise<[string[], string[]]>

    • Looks for unlocked jobs in the active queue.

      +
    • token: string

    Returns Promise<any>

    moveStalledJobsToWait

    moveToActive

    moveToCompletedArgs

    moveToDelayed

    moveToDelayedArgs

    moveToFailedArgs

    moveToFinished

    moveToWaitingChildren

    moveToActive

    moveToCompletedArgs

    moveToDelayed

    moveToDelayedArgs

    moveToFailedArgs

    moveToFinished

    moveToWaitingChildren

    moveToWaitingChildrenArgs

    obliterate

    paginate

    pause

    promote

    promoteJobs

    remove

    removeChildDependency

    removeJobScheduler

    removeRepeatable

    reprocessJob

    moveToWaitingChildrenArgs

    obliterate

    paginate

    pause

    promote

    promoteJobs

    remove

    removeChildDependency

    removeJobScheduler

    removeRepeatable

    reprocessJob

    retryJob

    retryJobArgs

    retryJobs

    updateData

    updateJobSchedulerNextMillis

    updateProgress

    updateRepeatableJobMillis

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJob

    retryJobArgs

    retryJobs

    updateData

    updateJobSchedulerNextMillis

    updateProgress

    updateRepeatableJobMillis

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.UnrecoverableError.html b/classes/v5.UnrecoverableError.html index 75b8f72922..ddb3578644 100644 --- a/classes/v5.UnrecoverableError.html +++ b/classes/v5.UnrecoverableError.html @@ -1,5 +1,5 @@ UnrecoverableError | bullmq - v5.34.4

    Class UnrecoverableError

    UnrecoverableError

    Error to move a job to failed even if the attemptsMade are lower than the expected limit.

    -

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.WaitingChildrenError.html b/classes/v5.WaitingChildrenError.html index e0b408cb39..21dd6d03f6 100644 --- a/classes/v5.WaitingChildrenError.html +++ b/classes/v5.WaitingChildrenError.html @@ -1,5 +1,5 @@ WaitingChildrenError | bullmq - v5.34.4

    Class WaitingChildrenError

    WaitingChildrenError

    Error to be thrown when job is moved to waiting-children state from job in active state.

    -

    Hierarchy

    • Error
      • WaitingChildrenError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Worker.html b/classes/v5.Worker.html index 738a6e825e..d27d967ae6 100644 --- a/classes/v5.Worker.html +++ b/classes/v5.Worker.html @@ -1,7 +1,7 @@ Worker | bullmq - v5.34.4

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. As soon as the class is instantiated and a connection to Redis is established it will start processing jobs.

    -

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing id keys @@ -34,33 +34,33 @@ trace waitUntilReady RateLimitError -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    Readonly id

    id: string

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    Readonly opts

    opts: WorkerOptions

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    concurrency

    jobScheduler

    minimumBlockTimeout

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      -

      Returns string

    repeat

    Methods

    close

    • close(force?): Promise<void>

    • Closes the worker and related redis connections.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    Readonly id

    id: string

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    Readonly opts

    opts: WorkerOptions

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    concurrency

    jobScheduler

    minimumBlockTimeout

    redisVersion

    • get redisVersion(): string

    • Returns the version of the Redis instance the client is connected to,

      +

      Returns string

    repeat

    Methods

    close

    • close(force?): Promise<void>

    • Closes the worker and related redis connections.

      This method waits for current jobs to finalize before returning.

      Parameters

      • force: boolean = false

        Use force boolean parameter if you do not want to wait for current jobs to be processed. When using telemetry, be mindful that it can interfere with the proper closure of spans, potentially preventing them from being exported.

      Returns Promise<void>

      Promise that resolves when the worker has been closed.

      -

    delay

    • delay(milliseconds?, abortController?): Promise<void>

    • This function is exposed only for testing purposes.

      -

      Parameters

      • Optional milliseconds: number
      • Optional abortController: AbortController

      Returns Promise<void>

    disconnect

    emit

    delay

    • delay(milliseconds?, abortController?): Promise<void>

    • This function is exposed only for testing purposes.

      +

      Parameters

      • Optional milliseconds: number
      • Optional abortController: AbortController

      Returns Promise<void>

    disconnect

    emit

    getNextJob

    Returns boolean

    getNextJob

    isPaused

    isPaused

    isRunning

    isRunning

    off

    on

    once

    pause

    processJob

    rateLimit

    off

    on

    once

    pause

    processJob

    rateLimit

    resume

    run

    startStalledCheckTimer

    resume

    run

    startStalledCheckTimer

    trace

    trace

    waitUntilReady

    Returns Promise<T | Promise<T>>

    waitUntilReady

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ChildCommand.html b/enums/v5.ChildCommand.html index 80c679669a..7e5c84812b 100644 --- a/enums/v5.ChildCommand.html +++ b/enums/v5.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.34.4

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.34.4

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ClientType.html b/enums/v5.ClientType.html index 30c854c20e..8ad9205997 100644 --- a/enums/v5.ClientType.html +++ b/enums/v5.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.34.4

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.34.4

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ErrorCode.html b/enums/v5.ErrorCode.html index f24f124d01..22a52dae7b 100644 --- a/enums/v5.ErrorCode.html +++ b/enums/v5.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | bullmq - v5.34.4

    Enumeration ErrorCode

    Enumeration Members

    JobBelongsToJobScheduler +ErrorCode | bullmq - v5.34.4

    Enumeration ErrorCode

    Enumeration Members

    JobBelongsToJobScheduler JobLockMismatch JobLockNotExist JobNotExist @@ -6,4 +6,4 @@ JobPendingDependencies ParentJobCannotBeReplaced ParentJobNotExist -

    Enumeration Members

    JobBelongsToJobScheduler

    JobBelongsToJobScheduler: -8

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobCannotBeReplaced

    ParentJobCannotBeReplaced: -7

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobBelongsToJobScheduler

    JobBelongsToJobScheduler: -8

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobCannotBeReplaced

    ParentJobCannotBeReplaced: -7

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.MetricsTime.html b/enums/v5.MetricsTime.html index f30582c619..f46744e260 100644 --- a/enums/v5.MetricsTime.html +++ b/enums/v5.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.34.4

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.34.4

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES FIVE_MINUTES ONE_HOUR ONE_MINUTE @@ -6,4 +6,4 @@ ONE_WEEK THIRTY_MINUTES TWO_WEEKS -

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ParentCommand.html b/enums/v5.ParentCommand.html index de47c6a89a..e1e9b4cfc6 100644 --- a/enums/v5.ParentCommand.html +++ b/enums/v5.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.34.4

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.34.4

    Enumeration ParentCommand

    Enumeration Members

    Completed Error Failed InitCompleted @@ -7,4 +7,4 @@ MoveToDelayed Progress Update -

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.SpanKind.html b/enums/v5.SpanKind.html index dc4d7d15ef..9a01900c9a 100644 --- a/enums/v5.SpanKind.html +++ b/enums/v5.SpanKind.html @@ -1,6 +1,6 @@ -SpanKind | bullmq - v5.34.4

    Enumeration SpanKind

    Enumeration Members

    CLIENT +SpanKind | bullmq - v5.34.4

    Enumeration SpanKind

    Enumeration Members

    CLIENT CONSUMER INTERNAL PRODUCER SERVER -

    Enumeration Members

    CLIENT

    CLIENT: 2

    CONSUMER

    CONSUMER: 4

    INTERNAL

    INTERNAL: 0

    PRODUCER

    PRODUCER: 3

    SERVER

    SERVER: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CLIENT

    CLIENT: 2

    CONSUMER

    CONSUMER: 4

    INTERNAL

    INTERNAL: 0

    PRODUCER

    PRODUCER: 3

    SERVER

    SERVER: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.TelemetryAttributes.html b/enums/v5.TelemetryAttributes.html index c62c8b61c8..1c21b8e067 100644 --- a/enums/v5.TelemetryAttributes.html +++ b/enums/v5.TelemetryAttributes.html @@ -1,4 +1,4 @@ -TelemetryAttributes | bullmq - v5.34.4

    Enumeration TelemetryAttributes

    Enumeration Members

    BulkCount +TelemetryAttributes | bullmq - v5.34.4

    Enumeration TelemetryAttributes

    Enumeration Members

    BulkCount BulkNames DeduplicationKey FlowName @@ -31,4 +31,4 @@ WorkerOptions WorkerRateLimit WorkerStalledJobs -

    Enumeration Members

    BulkCount

    BulkCount: "bullmq.job.bulk.count"

    BulkNames

    BulkNames: "bullmq.job.bulk.names"

    DeduplicationKey

    DeduplicationKey: "bullmq.job.deduplication.key"

    FlowName

    FlowName: "bullmq.flow.name"

    JobFailedReason

    JobFailedReason: "bullmq.job.failed.reason"

    JobFinishedTimestamp

    JobFinishedTimestamp: "bullmq.job.finished.timestamp"

    JobId

    JobId: "bullmq.job.id"

    JobIds

    JobIds: "bullmq.job.ids"

    JobKey

    JobKey: "bullmq.job.key"

    JobName

    JobName: "bullmq.job.name"

    JobOptions

    JobOptions: "bullmq.job.options"

    JobProcessedTimestamp

    JobProcessedTimestamp: "bullmq.job.processed.timestamp"

    JobProgress

    JobProgress: "bullmq.job.progress"

    JobResult

    JobResult: "bullmq.job.result"

    JobSchedulerId

    JobSchedulerId: "bullmq.job.scheduler.id"

    JobType

    JobType: "bullmq.job.type"

    QueueCleanLimit

    QueueCleanLimit: "bullmq.queue.clean.limit"

    QueueDrainDelay

    QueueDrainDelay: "bullmq.queue.drain.delay"

    QueueEventMaxLength

    QueueEventMaxLength: "bullmq.queue.event.max.length"

    QueueGrace

    QueueGrace: "bullmq.queue.grace"

    QueueName

    QueueName: "bullmq.queue.name"

    QueueOperation

    QueueOperation: "bullmq.queue.operation"

    QueueOptions

    QueueOptions: "bullmq.queue.options"

    QueueRateLimit

    QueueRateLimit: "bullmq.queue.rate.limit"

    WorkerDoNotWaitActive

    WorkerDoNotWaitActive: "bullmq.worker.do.not.wait.active"

    WorkerFailedJobs

    WorkerFailedJobs: "bullmq.worker.failed.jobs"

    WorkerForceClose

    WorkerForceClose: "bullmq.worker.force.close"

    WorkerId

    WorkerId: "bullmq.worker.id"

    WorkerJobsToExtendLocks

    WorkerJobsToExtendLocks: "bullmq.worker.jobs.to.extend.locks"

    WorkerName

    WorkerName: "bullmq.worker.name"

    WorkerOptions

    WorkerOptions: "bullmq.worker.options"

    WorkerRateLimit

    WorkerRateLimit: "bullmq.worker.rate.limit"

    WorkerStalledJobs

    WorkerStalledJobs: "bullmq.worker.stalled.jobs"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    BulkCount

    BulkCount: "bullmq.job.bulk.count"

    BulkNames

    BulkNames: "bullmq.job.bulk.names"

    DeduplicationKey

    DeduplicationKey: "bullmq.job.deduplication.key"

    FlowName

    FlowName: "bullmq.flow.name"

    JobFailedReason

    JobFailedReason: "bullmq.job.failed.reason"

    JobFinishedTimestamp

    JobFinishedTimestamp: "bullmq.job.finished.timestamp"

    JobId

    JobId: "bullmq.job.id"

    JobIds

    JobIds: "bullmq.job.ids"

    JobKey

    JobKey: "bullmq.job.key"

    JobName

    JobName: "bullmq.job.name"

    JobOptions

    JobOptions: "bullmq.job.options"

    JobProcessedTimestamp

    JobProcessedTimestamp: "bullmq.job.processed.timestamp"

    JobProgress

    JobProgress: "bullmq.job.progress"

    JobResult

    JobResult: "bullmq.job.result"

    JobSchedulerId

    JobSchedulerId: "bullmq.job.scheduler.id"

    JobType

    JobType: "bullmq.job.type"

    QueueCleanLimit

    QueueCleanLimit: "bullmq.queue.clean.limit"

    QueueDrainDelay

    QueueDrainDelay: "bullmq.queue.drain.delay"

    QueueEventMaxLength

    QueueEventMaxLength: "bullmq.queue.event.max.length"

    QueueGrace

    QueueGrace: "bullmq.queue.grace"

    QueueName

    QueueName: "bullmq.queue.name"

    QueueOperation

    QueueOperation: "bullmq.queue.operation"

    QueueOptions

    QueueOptions: "bullmq.queue.options"

    QueueRateLimit

    QueueRateLimit: "bullmq.queue.rate.limit"

    WorkerDoNotWaitActive

    WorkerDoNotWaitActive: "bullmq.worker.do.not.wait.active"

    WorkerFailedJobs

    WorkerFailedJobs: "bullmq.worker.failed.jobs"

    WorkerForceClose

    WorkerForceClose: "bullmq.worker.force.close"

    WorkerId

    WorkerId: "bullmq.worker.id"

    WorkerJobsToExtendLocks

    WorkerJobsToExtendLocks: "bullmq.worker.jobs.to.extend.locks"

    WorkerName

    WorkerName: "bullmq.worker.name"

    WorkerOptions

    WorkerOptions: "bullmq.worker.options"

    WorkerRateLimit

    WorkerRateLimit: "bullmq.worker.rate.limit"

    WorkerStalledJobs

    WorkerStalledJobs: "bullmq.worker.stalled.jobs"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.array2obj.html b/functions/v5.array2obj.html index debfc761d8..7eae2c4ce4 100644 --- a/functions/v5.array2obj.html +++ b/functions/v5.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.34.4

    Function array2obj

    • array2obj(arr): Record<string, string>

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +array2obj | bullmq - v5.34.4

    Function array2obj

    • array2obj(arr): Record<string, string>

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.asyncSend.html b/functions/v5.asyncSend.html index a82c2f7f66..8420adee95 100644 --- a/functions/v5.asyncSend.html +++ b/functions/v5.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.34.4

    Function asyncSend

    • asyncSend<T>(proc, msg): Promise<void>

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +asyncSend | bullmq - v5.34.4

    Function asyncSend

    • asyncSend<T>(proc, msg): Promise<void>

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.childSend.html b/functions/v5.childSend.html index cad2d0982f..1261529e7f 100644 --- a/functions/v5.childSend.html +++ b/functions/v5.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.34.4

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +childSend | bullmq - v5.34.4

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.decreaseMaxListeners.html b/functions/v5.decreaseMaxListeners.html index fb4a7ce97f..27973212e2 100644 --- a/functions/v5.decreaseMaxListeners.html +++ b/functions/v5.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.34.4

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decreaseMaxListeners | bullmq - v5.34.4

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.defaultRepeatStrategy.html b/functions/v5.defaultRepeatStrategy.html index bdba187f22..fc9534bed6 100644 --- a/functions/v5.defaultRepeatStrategy.html +++ b/functions/v5.defaultRepeatStrategy.html @@ -1 +1 @@ -defaultRepeatStrategy | bullmq - v5.34.4

    Function defaultRepeatStrategy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +defaultRepeatStrategy | bullmq - v5.34.4

    Function defaultRepeatStrategy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.delay.html b/functions/v5.delay.html index b8daca01fb..52d5ffbe81 100644 --- a/functions/v5.delay.html +++ b/functions/v5.delay.html @@ -1 +1 @@ -delay | bullmq - v5.34.4

    Function delay

    • delay(ms, abortController?): Promise<void>

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +delay | bullmq - v5.34.4

    Function delay

    • delay(ms, abortController?): Promise<void>

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.errorToJSON.html b/functions/v5.errorToJSON.html index 8a4f2ec501..3cd9f85e65 100644 --- a/functions/v5.errorToJSON.html +++ b/functions/v5.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.34.4

    Function errorToJSON

    • errorToJSON(value): Record<string, any>

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +errorToJSON | bullmq - v5.34.4

    Function errorToJSON

    • errorToJSON(value): Record<string, any>

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.getNextMillis.html b/functions/v5.getNextMillis.html index 66f5e94385..11a46f9bcd 100644 --- a/functions/v5.getNextMillis.html +++ b/functions/v5.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.34.4

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getNextMillis | bullmq - v5.34.4

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.getParentKey.html b/functions/v5.getParentKey.html index 6260311545..04eda5751b 100644 --- a/functions/v5.getParentKey.html +++ b/functions/v5.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.34.4

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

      • opts: {
            id: string;
            queue: string;
        }
        • id: string
        • queue: string

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getParentKey | bullmq - v5.34.4

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

      • opts: {
            id: string;
            queue: string;
        }
        • id: string
        • queue: string

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.increaseMaxListeners.html b/functions/v5.increaseMaxListeners.html index 65c9149a51..326d302337 100644 --- a/functions/v5.increaseMaxListeners.html +++ b/functions/v5.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.34.4

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +increaseMaxListeners | bullmq - v5.34.4

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.invertObject.html b/functions/v5.invertObject.html index c00b94dad6..87b0f236f3 100644 --- a/functions/v5.invertObject.html +++ b/functions/v5.invertObject.html @@ -1 +1 @@ -invertObject | bullmq - v5.34.4

    Function invertObject

    • invertObject<T>(obj): Invert<T>

    • Type Parameters

      • T extends Record<PropertyKey, PropertyKey>

      Parameters

      • obj: T

      Returns Invert<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +invertObject | bullmq - v5.34.4

    Function invertObject

    • invertObject<T>(obj): Invert<T>

    • Type Parameters

      • T extends Record<PropertyKey, PropertyKey>

      Parameters

      • obj: T

      Returns Invert<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isEmpty.html b/functions/v5.isEmpty.html index c244b3ba7b..a87e5b5f6a 100644 --- a/functions/v5.isEmpty.html +++ b/functions/v5.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.34.4

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isEmpty | bullmq - v5.34.4

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isNotConnectionError.html b/functions/v5.isNotConnectionError.html index 8d24812106..03e72ac2fe 100644 --- a/functions/v5.isNotConnectionError.html +++ b/functions/v5.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.34.4

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isNotConnectionError | bullmq - v5.34.4

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisCluster.html b/functions/v5.isRedisCluster.html index f79e2db3e1..47eb5e5dcd 100644 --- a/functions/v5.isRedisCluster.html +++ b/functions/v5.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.34.4

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isRedisCluster | bullmq - v5.34.4

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisInstance.html b/functions/v5.isRedisInstance.html index b8a22de17f..8679bea04d 100644 --- a/functions/v5.isRedisInstance.html +++ b/functions/v5.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.34.4

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isRedisInstance | bullmq - v5.34.4

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisVersionLowerThan.html b/functions/v5.isRedisVersionLowerThan.html index 930c418783..c27ffa3473 100644 --- a/functions/v5.isRedisVersionLowerThan.html +++ b/functions/v5.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.34.4

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isRedisVersionLowerThan | bullmq - v5.34.4

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.lengthInUtf8Bytes.html b/functions/v5.lengthInUtf8Bytes.html index a4d5246add..7376f59c30 100644 --- a/functions/v5.lengthInUtf8Bytes.html +++ b/functions/v5.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ lengthInUtf8Bytes | bullmq - v5.34.4

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.objectToFlatArray.html b/functions/v5.objectToFlatArray.html index 95f919ca6d..16962da1b7 100644 --- a/functions/v5.objectToFlatArray.html +++ b/functions/v5.objectToFlatArray.html @@ -1 +1 @@ -objectToFlatArray | bullmq - v5.34.4

    Function objectToFlatArray

    • objectToFlatArray(obj): string[]

    • Parameters

      • obj: Record<string, any>

      Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +objectToFlatArray | bullmq - v5.34.4

    Function objectToFlatArray

    • objectToFlatArray(obj): string[]

    • Parameters

      • obj: Record<string, any>

      Returns string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.parseObjectValues.html b/functions/v5.parseObjectValues.html index 8eb7f109d2..ef05a9117f 100644 --- a/functions/v5.parseObjectValues.html +++ b/functions/v5.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.34.4

    Function parseObjectValues

    • parseObjectValues(obj): Record<string, any>

    • Parameters

      • obj: {
            [key: string]: string;
        }
        • [key: string]: string

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +parseObjectValues | bullmq - v5.34.4

    Function parseObjectValues

    • parseObjectValues(obj): Record<string, any>

    • Parameters

      • obj: {
            [key: string]: string;
        }
        • [key: string]: string

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.raw2NextJobData.html b/functions/v5.raw2NextJobData.html index 13c909d3fd..82cba3d2c2 100644 --- a/functions/v5.raw2NextJobData.html +++ b/functions/v5.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.34.4

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +raw2NextJobData | bullmq - v5.34.4

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.removeAllQueueData.html b/functions/v5.removeAllQueueData.html index 82e533dde1..c5f5febe39 100644 --- a/functions/v5.removeAllQueueData.html +++ b/functions/v5.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.34.4

    Function removeAllQueueData

    • removeAllQueueData(client, queueName, prefix?): Promise<void | boolean>

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = ...

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +removeAllQueueData | bullmq - v5.34.4

    Function removeAllQueueData

    • removeAllQueueData(client, queueName, prefix?): Promise<void | boolean>

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = ...

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.removeUndefinedFields.html b/functions/v5.removeUndefinedFields.html index eae0a012e9..7081d7332f 100644 --- a/functions/v5.removeUndefinedFields.html +++ b/functions/v5.removeUndefinedFields.html @@ -1 +1 @@ -removeUndefinedFields | bullmq - v5.34.4

    Function removeUndefinedFields

    • removeUndefinedFields<T>(obj): T

    • Type Parameters

      • T extends Record<string, any>

      Parameters

      • obj: Record<string, any>

      Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +removeUndefinedFields | bullmq - v5.34.4

    Function removeUndefinedFields

    • removeUndefinedFields<T>(obj): T

    • Type Parameters

      • T extends Record<string, any>

      Parameters

      • obj: Record<string, any>

      Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.toString.html b/functions/v5.toString.html index d9f496067e..e323804cf1 100644 --- a/functions/v5.toString.html +++ b/functions/v5.toString.html @@ -1 +1 @@ -toString | bullmq - v5.34.4

    Function toString

    • toString(value): string

    • Parameters

      • value: any

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +toString | bullmq - v5.34.4

    Function toString

    • toString(value): string

    • Parameters

      • value: any

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.trace.html b/functions/v5.trace.html index 90d23e4419..0d82c3733d 100644 --- a/functions/v5.trace.html +++ b/functions/v5.trace.html @@ -5,4 +5,4 @@
  • operation: string

    operation name (such as add, process, etc)

  • destination: string

    destination name (normally the queue name)

  • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

    code to wrap with telemetry

    -
  • Optional srcPropagationMetadata: string

    • Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.tryCatch.html b/functions/v5.tryCatch.html index b14a6e9c79..321b8d9065 100644 --- a/functions/v5.tryCatch.html +++ b/functions/v5.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.34.4

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

      • fn: ((...args) => any)
          • (...args): any

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +tryCatch | bullmq - v5.34.4

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

      • fn: ((...args) => any)
          • (...args): any

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.AddChildrenOpts.html b/interfaces/v5.AddChildrenOpts.html index 80d892dce2..0a6363366d 100644 --- a/interfaces/v5.AddChildrenOpts.html +++ b/interfaces/v5.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.34.4

    Interface AddChildrenOpts

    interface AddChildrenOpts {
        multi: ChainableCommander;
        nodes: FlowJob[];
        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        };
        queuesOpts?: FlowQueuesOpts;
    }

    Properties

    multi +AddChildrenOpts | bullmq - v5.34.4

    Interface AddChildrenOpts

    interface AddChildrenOpts {
        multi: ChainableCommander;
        nodes: FlowJob[];
        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        };
        queuesOpts?: FlowQueuesOpts;
    }

    Properties

    multi nodes parent queuesOpts? -

    Properties

    multi

    multi: ChainableCommander

    nodes

    nodes: FlowJob[]

    parent

    parent: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }

    Type declaration

    • parentDependenciesKey: string
    • parentOpts: {
          id: string;
          queue: string;
      }
      • id: string
      • queue: string

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    multi

    multi: ChainableCommander

    nodes

    nodes: FlowJob[]

    parent

    parent: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }

    Type declaration

    • parentDependenciesKey: string
    • parentOpts: {
          id: string;
          queue: string;
      }
      • id: string
      • queue: string

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.AddNodeOpts.html b/interfaces/v5.AddNodeOpts.html index 14aa46de05..c1948526db 100644 --- a/interfaces/v5.AddNodeOpts.html +++ b/interfaces/v5.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.34.4

    Interface AddNodeOpts

    interface AddNodeOpts {
        multi: ChainableCommander;
        node: FlowJob;
        parent?: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        };
        queuesOpts?: FlowQueuesOpts;
    }

    Properties

    multi +AddNodeOpts | bullmq - v5.34.4

    Interface AddNodeOpts

    interface AddNodeOpts {
        multi: ChainableCommander;
        node: FlowJob;
        parent?: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        };
        queuesOpts?: FlowQueuesOpts;
    }

    Properties

    multi node parent? queuesOpts? -

    Properties

    multi

    multi: ChainableCommander

    node

    node: FlowJob

    Optional parent

    parent?: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }

    Type declaration

    • parentDependenciesKey: string
    • parentOpts: {
          id: string;
          queue: string;
      }
      • id: string
      • queue: string

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Queues options that will be applied in each node depending on queue name presence.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    multi

    multi: ChainableCommander

    node

    node: FlowJob

    Optional parent

    parent?: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }

    Type declaration

    • parentDependenciesKey: string
    • parentOpts: {
          id: string;
          queue: string;
      }
      • id: string
      • queue: string

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Queues options that will be applied in each node depending on queue name presence.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.AdvancedOptions.html b/interfaces/v5.AdvancedOptions.html index ca401f600a..dd6b5ae933 100644 --- a/interfaces/v5.AdvancedOptions.html +++ b/interfaces/v5.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.34.4

    Interface AdvancedOptions

    interface AdvancedOptions {
        backoffStrategy?: BackoffStrategy;
        repeatKeyHashAlgorithm?: string;
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    backoffStrategy? +AdvancedOptions | bullmq - v5.34.4

    Interface AdvancedOptions

    interface AdvancedOptions {
        backoffStrategy?: BackoffStrategy;
        repeatKeyHashAlgorithm?: string;
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    backoffStrategy? repeatKeyHashAlgorithm? repeatStrategy?

    Properties

    Optional backoffStrategy

    backoffStrategy?: BackoffStrategy

    A custom backoff strategy.

    -

    Optional repeatKeyHashAlgorithm

    repeatKeyHashAlgorithm?: string

    A hash algorithm to be used when trying to create the job redis key. +

    Optional repeatKeyHashAlgorithm

    repeatKeyHashAlgorithm?: string

    A hash algorithm to be used when trying to create the job redis key. Default - md5

    -

    Optional repeatStrategy

    repeatStrategy?: RepeatStrategy

    A custom cron strategy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional repeatStrategy

    repeatStrategy?: RepeatStrategy

    A custom cron strategy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.AdvancedRepeatOptions.html b/interfaces/v5.AdvancedRepeatOptions.html index c901e35302..f9eab727b8 100644 --- a/interfaces/v5.AdvancedRepeatOptions.html +++ b/interfaces/v5.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.34.4

    Interface AdvancedRepeatOptions

    interface AdvancedRepeatOptions {
        repeatKeyHashAlgorithm?: string;
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.34.4

    Interface AdvancedRepeatOptions

    interface AdvancedRepeatOptions {
        repeatKeyHashAlgorithm?: string;
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    repeatKeyHashAlgorithm? repeatStrategy?

    Properties

    Optional repeatKeyHashAlgorithm

    repeatKeyHashAlgorithm?: string

    A hash algorithm to be used when trying to create the job redis key. Default - md5

    -

    Optional repeatStrategy

    repeatStrategy?: RepeatStrategy

    A custom cron strategy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional repeatStrategy

    repeatStrategy?: RepeatStrategy

    A custom cron strategy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Attributes.html b/interfaces/v5.Attributes.html index 3cfffa6250..9c7c7534cd 100644 --- a/interfaces/v5.Attributes.html +++ b/interfaces/v5.Attributes.html @@ -1 +1 @@ -Attributes | bullmq - v5.34.4

    Interface Attributes

    interface Attributes {
        [attribute: string]: AttributeValue | undefined;
    }

    Indexable

    [attribute: string]: AttributeValue | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Attributes | bullmq - v5.34.4

    Interface Attributes

    interface Attributes {
        [attribute: string]: AttributeValue | undefined;
    }

    Indexable

    [attribute: string]: AttributeValue | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.BackoffOptions.html b/interfaces/v5.BackoffOptions.html index c090fa8fa1..4b7ea65519 100644 --- a/interfaces/v5.BackoffOptions.html +++ b/interfaces/v5.BackoffOptions.html @@ -1,7 +1,7 @@ BackoffOptions | bullmq - v5.34.4

    Interface BackoffOptions

    Settings for backing off failed jobs.

    See

    https://docs.bullmq.io/guide/retrying-failing-jobs

    -
    interface BackoffOptions {
        delay?: number;
        type: "fixed" | "exponential" | string & {};
    }

    Properties

    delay? +
    interface BackoffOptions {
        delay?: number;
        type: "fixed" | "exponential" | string & {};
    }

    Properties

    delay? type

    Properties

    Optional delay

    delay?: number

    Delay in milliseconds.

    -

    type

    type: "fixed" | "exponential" | string & {}

    Name of the backoff strategy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: "fixed" | "exponential" | string & {}

    Name of the backoff strategy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.BaseJobOptions.html b/interfaces/v5.BaseJobOptions.html index 25ec3e6746..638fcca685 100644 --- a/interfaces/v5.BaseJobOptions.html +++ b/interfaces/v5.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.34.4

    Interface BaseJobOptions

    interface BaseJobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        delay?: number;
        jobId?: string;
        keepLogs?: number;
        lifo?: boolean;
        parent?: {
            id: string;
            queue: string;
        };
        prevMillis?: number;
        priority?: number;
        removeOnComplete?: number | boolean | KeepJobs;
        removeOnFail?: number | boolean | KeepJobs;
        repeat?: RepeatOptions;
        repeatJobKey?: string;
        sizeLimit?: number;
        stackTraceLimit?: number;
        timestamp?: number;
    }

    Hierarchy (view full)

    Properties

    attempts? +BaseJobOptions | bullmq - v5.34.4

    Interface BaseJobOptions

    interface BaseJobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        delay?: number;
        jobId?: string;
        keepLogs?: number;
        lifo?: boolean;
        parent?: {
            id: string;
            queue: string;
        };
        prevMillis?: number;
        priority?: number;
        removeOnComplete?: number | boolean | KeepJobs;
        removeOnFail?: number | boolean | KeepJobs;
        repeat?: RepeatOptions;
        repeatJobKey?: string;
        sizeLimit?: number;
        stackTraceLimit?: number;
        timestamp?: number;
    }

    Hierarchy (view full)

    Properties

    attempts? backoff? delay? jobId? @@ -17,43 +17,43 @@

    Properties

    Optional attempts

    attempts?: number

    The total number of attempts to try the job until it completes.

    Default Value

    0
    -

    Optional backoff

    backoff?: number | BackoffOptions

    Backoff setting for automatic retries if the job fails

    -

    Optional delay

    delay?: number

    An amount of milliseconds to wait until this job can be processed. +

    Optional backoff

    backoff?: number | BackoffOptions

    Backoff setting for automatic retries if the job fails

    +

    Optional delay

    delay?: number

    An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

    Default Value

    0
    -

    Optional jobId

    jobId?: string

    Override the job ID - by default, the job ID is a unique +

    Optional jobId

    jobId?: string

    Override the job ID - by default, the job ID is a unique integer, but you can use this setting to override it. If you use this option, it is up to you to ensure the jobId is unique. If you attempt to add a job with an id that already exists, it will not be added.

    -

    Optional keepLogs

    keepLogs?: number

    Maximum amount of log entries that will be preserved

    -

    Optional lifo

    lifo?: boolean

    If true, adds the job to the right of the queue instead of the left (default false)

    +

    Optional keepLogs

    keepLogs?: number

    Maximum amount of log entries that will be preserved

    +

    Optional lifo

    lifo?: boolean

    If true, adds the job to the right of the queue instead of the left (default false)

    See

    https://docs.bullmq.io/guide/jobs/lifo

    -

    Optional parent

    parent?: {
        id: string;
        queue: string;
    }

    Type declaration

    Optional parent

    parent?: {
        id: string;
        queue: string;
    }

    Type declaration

    Optional prevMillis

    prevMillis?: number

    Internal property used by repeatable jobs.

    -

    Optional priority

    priority?: number

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that +

    Optional prevMillis

    prevMillis?: number

    Internal property used by repeatable jobs.

    +

    Optional priority

    priority?: number

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

    Default Value

    0
    -

    Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs

    If true, removes the job when it successfully completes +

    Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs

    If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.

    -

    Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs

    If true, removes the job when it fails after all attempts. +

    Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs

    If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.

    -

    Optional repeat

    repeat?: RepeatOptions

    Repeat this job, for example based on a cron schedule.

    -

    Optional repeatJobKey

    repeatJobKey?: string

    Internal property used by repeatable jobs to save base repeat job key.

    -

    Optional sizeLimit

    sizeLimit?: number

    Limits the size in bytes of the job's data payload (as a JSON serialized string).

    -

    Optional stackTraceLimit

    stackTraceLimit?: number

    Limits the amount of stack trace lines that will be recorded in the stacktrace.

    -

    Optional timestamp

    timestamp?: number

    Timestamp when the job was created.

    +

    Optional repeat

    repeat?: RepeatOptions

    Repeat this job, for example based on a cron schedule.

    +

    Optional repeatJobKey

    repeatJobKey?: string

    Internal property used by repeatable jobs to save base repeat job key.

    +

    Optional sizeLimit

    sizeLimit?: number

    Limits the size in bytes of the job's data payload (as a JSON serialized string).

    +

    Optional stackTraceLimit

    stackTraceLimit?: number

    Limits the amount of stack trace lines that will be recorded in the stacktrace.

    +

    Optional timestamp

    timestamp?: number

    Timestamp when the job was created.

    Default Value

    Date.now()
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.BaseOptions.html b/interfaces/v5.BaseOptions.html index 0338be34e2..c52d8312b4 100644 --- a/interfaces/v5.BaseOptions.html +++ b/interfaces/v5.BaseOptions.html @@ -1,3 +1,3 @@ -BaseOptions | bullmq - v5.34.4

    Interface BaseOptions

    interface BaseOptions {
        skipVersionCheck?: boolean;
        url?: string;
    }

    Properties

    skipVersionCheck? +BaseOptions | bullmq - v5.34.4

    Interface BaseOptions

    interface BaseOptions {
        skipVersionCheck?: boolean;
        url?: string;
    }

    Properties

    skipVersionCheck? url? -

    Properties

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.BuiltInStrategies.html b/interfaces/v5.BuiltInStrategies.html index 040bf9c41d..fecbe6f92b 100644 --- a/interfaces/v5.BuiltInStrategies.html +++ b/interfaces/v5.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.34.4

    Interface BuiltInStrategies

    interface BuiltInStrategies {
        [index: string]: ((delay) => BackoffStrategy);
    }

    Indexable

    [index: string]: ((delay) => BackoffStrategy)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BuiltInStrategies | bullmq - v5.34.4

    Interface BuiltInStrategies

    interface BuiltInStrategies {
        [index: string]: ((delay) => BackoffStrategy);
    }

    Indexable

    [index: string]: ((delay) => BackoffStrategy)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.ChildMessage.html b/interfaces/v5.ChildMessage.html index d60a6d6a52..aa42d07bab 100644 --- a/interfaces/v5.ChildMessage.html +++ b/interfaces/v5.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.34.4

    Interface ChildMessage

    interface ChildMessage {
        cmd: ParentCommand;
        err?: Record<string, any>;
        value?: any;
    }

    Properties

    cmd +ChildMessage | bullmq - v5.34.4

    Interface ChildMessage

    interface ChildMessage {
        cmd: ParentCommand;
        err?: Record<string, any>;
        value?: any;
    }

    Properties

    cmd err? value? -

    Properties

    cmd

    cmd: ParentCommand

    Optional err

    err?: Record<string, any>

    Optional value

    value?: any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cmd

    cmd: ParentCommand

    Optional err

    err?: Record<string, any>

    Optional value

    value?: any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.ContextManager.html b/interfaces/v5.ContextManager.html index cd2db1dd75..bb3b888047 100644 --- a/interfaces/v5.ContextManager.html +++ b/interfaces/v5.ContextManager.html @@ -1,15 +1,15 @@ ContextManager | bullmq - v5.34.4

    Interface ContextManager<Context>

    Context manager interface

    The context manager is responsible for managing the context and propagating it across the application.

    -
    interface ContextManager<Context> {
        active(): Context;
        fromMetadata(activeContext, metadata): Context;
        getMetadata(context): string;
        with<A>(context, fn): ReturnType<A>;
    }

    Type Parameters

    • Context = any

    Methods

    active +
    interface ContextManager<Context> {
        active(): Context;
        fromMetadata(activeContext, metadata): Context;
        getMetadata(context): string;
        with<A>(context, fn): ReturnType<A>;
    }

    Type Parameters

    • Context = any

    Methods

    active fromMetadata getMetadata with

    Methods

    active

    fromMetadata

    fromMetadata

    • fromMetadata(activeContext, metadata): Context

    • Creates a new context from a serialized version effectively linking the new context to the parent context.

      -

      Parameters

      • activeContext: Context
      • metadata: string

      Returns Context

    getMetadata

    getMetadata

    • getMetadata(context): string

    • Returns a serialized version of the current context. The metadata is the mechanism used to propagate the context across a distributed application.

      -

      Parameters

      Returns string

    with

    • with<A>(context, fn): ReturnType<A>

    • Creates a new context and sets it as active for the fn passed as last argument

      -

      Type Parameters

      • A extends ((...args) => any)

      Parameters

      Returns ReturnType<A>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    with

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.DebounceOptions.html b/interfaces/v5.DebounceOptions.html index 785eceeadf..aa3ed8be51 100644 --- a/interfaces/v5.DebounceOptions.html +++ b/interfaces/v5.DebounceOptions.html @@ -1,6 +1,6 @@ DebounceOptions | bullmq - v5.34.4

    Interface DebounceOptions

    Debounce options

    -
    interface DebounceOptions {
        id: string;
        ttl?: number;
    }

    Properties

    id +
    interface DebounceOptions {
        id: string;
        ttl?: number;
    }

    Properties

    id ttl?

    Properties

    id

    id: string

    Identifier

    -

    Optional ttl

    ttl?: number

    ttl in milliseconds

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional ttl

    ttl?: number

    ttl in milliseconds

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.DefaultJobOptions.html b/interfaces/v5.DefaultJobOptions.html index 5dbf7f23b6..8fc25ce229 100644 --- a/interfaces/v5.DefaultJobOptions.html +++ b/interfaces/v5.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.34.4

    Interface DefaultJobOptions

    interface DefaultJobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        delay?: number;
        keepLogs?: number;
        lifo?: boolean;
        priority?: number;
        removeOnComplete?: number | boolean | KeepJobs;
        removeOnFail?: number | boolean | KeepJobs;
        sizeLimit?: number;
        stackTraceLimit?: number;
        timestamp?: number;
    }

    Hierarchy (view full)

    Properties

    attempts? +DefaultJobOptions | bullmq - v5.34.4

    Interface DefaultJobOptions

    interface DefaultJobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        delay?: number;
        keepLogs?: number;
        lifo?: boolean;
        priority?: number;
        removeOnComplete?: number | boolean | KeepJobs;
        removeOnFail?: number | boolean | KeepJobs;
        sizeLimit?: number;
        stackTraceLimit?: number;
        timestamp?: number;
    }

    Hierarchy (view full)

    Properties

    attempts? backoff? delay? keepLogs? @@ -12,33 +12,33 @@

    Properties

    Optional attempts

    attempts?: number

    The total number of attempts to try the job until it completes.

    Default Value

    0
    -

    Optional backoff

    backoff?: number | BackoffOptions

    Backoff setting for automatic retries if the job fails

    -

    Optional delay

    delay?: number

    An amount of milliseconds to wait until this job can be processed. +

    Optional backoff

    backoff?: number | BackoffOptions

    Backoff setting for automatic retries if the job fails

    +

    Optional delay

    delay?: number

    An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

    Default Value

    0
    -

    Optional keepLogs

    keepLogs?: number

    Maximum amount of log entries that will be preserved

    -

    Optional lifo

    lifo?: boolean

    If true, adds the job to the right of the queue instead of the left (default false)

    +

    Optional keepLogs

    keepLogs?: number

    Maximum amount of log entries that will be preserved

    +

    Optional lifo

    lifo?: boolean

    If true, adds the job to the right of the queue instead of the left (default false)

    See

    https://docs.bullmq.io/guide/jobs/lifo

    -

    Optional priority

    priority?: number

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that +

    Optional priority

    priority?: number

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

    Default Value

    0
    -

    Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs

    If true, removes the job when it successfully completes +

    Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs

    If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.

    -

    Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs

    If true, removes the job when it fails after all attempts. +

    Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs

    If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.

    -

    Optional sizeLimit

    sizeLimit?: number

    Limits the size in bytes of the job's data payload (as a JSON serialized string).

    -

    Optional stackTraceLimit

    stackTraceLimit?: number

    Limits the amount of stack trace lines that will be recorded in the stacktrace.

    -

    Optional timestamp

    timestamp?: number

    Timestamp when the job was created.

    +

    Optional sizeLimit

    sizeLimit?: number

    Limits the size in bytes of the job's data payload (as a JSON serialized string).

    +

    Optional stackTraceLimit

    stackTraceLimit?: number

    Limits the amount of stack trace lines that will be recorded in the stacktrace.

    +

    Optional timestamp

    timestamp?: number

    Timestamp when the job was created.

    Default Value

    Date.now()
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.DependenciesOpts.html b/interfaces/v5.DependenciesOpts.html index 0bb9573927..bcd3c32e96 100644 --- a/interfaces/v5.DependenciesOpts.html +++ b/interfaces/v5.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.34.4

    Interface DependenciesOpts

    interface DependenciesOpts {
        processed?: {
            count?: number;
            cursor?: number;
        };
        unprocessed?: {
            count?: number;
            cursor?: number;
        };
    }

    Properties

    processed? +DependenciesOpts | bullmq - v5.34.4

    Interface DependenciesOpts

    interface DependenciesOpts {
        processed?: {
            count?: number;
            cursor?: number;
        };
        unprocessed?: {
            count?: number;
            cursor?: number;
        };
    }

    Properties

    processed? unprocessed? -

    Properties

    Optional processed

    processed?: {
        count?: number;
        cursor?: number;
    }

    Type declaration

    • Optional count?: number
    • Optional cursor?: number

    Optional unprocessed

    unprocessed?: {
        count?: number;
        cursor?: number;
    }

    Type declaration

    • Optional count?: number
    • Optional cursor?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional processed

    processed?: {
        count?: number;
        cursor?: number;
    }

    Type declaration

    • Optional count?: number
    • Optional cursor?: number

    Optional unprocessed

    unprocessed?: {
        count?: number;
        cursor?: number;
    }

    Type declaration

    • Optional count?: number
    • Optional cursor?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.FlowJobBase.html b/interfaces/v5.FlowJobBase.html index ee54794966..26f69b226c 100644 --- a/interfaces/v5.FlowJobBase.html +++ b/interfaces/v5.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.34.4

    Interface FlowJobBase<T>

    interface FlowJobBase<T> {
        children?: FlowChildJob[];
        data?: any;
        name: string;
        opts?: Omit<T, "repeat">;
        prefix?: string;
        queueName: string;
    }

    Type Parameters

    • T

    Properties

    children? +FlowJobBase | bullmq - v5.34.4

    Interface FlowJobBase<T>

    interface FlowJobBase<T> {
        children?: FlowChildJob[];
        data?: any;
        name: string;
        opts?: Omit<T, "repeat">;
        prefix?: string;
        queueName: string;
    }

    Type Parameters

    • T

    Properties

    children? data? name opts? prefix? queueName -

    Properties

    Optional children

    children?: FlowChildJob[]

    Optional data

    data?: any

    name

    name: string

    Optional opts

    opts?: Omit<T, "repeat">

    Optional prefix

    prefix?: string

    queueName

    queueName: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional children

    children?: FlowChildJob[]

    Optional data

    data?: any

    name

    name: string

    Optional opts

    opts?: Omit<T, "repeat">

    Optional prefix

    prefix?: string

    queueName

    queueName: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.FlowOpts.html b/interfaces/v5.FlowOpts.html index 35c3a805ef..3f7ba2fff8 100644 --- a/interfaces/v5.FlowOpts.html +++ b/interfaces/v5.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.34.4

    Interface FlowOpts

    interface FlowOpts {
        queuesOptions: FlowQueuesOpts;
    }

    Properties

    queuesOptions +FlowOpts | bullmq - v5.34.4

    Interface FlowOpts

    interface FlowOpts {
        queuesOptions: FlowQueuesOpts;
    }

    Properties

    queuesOptions

    Properties

    queuesOptions

    queuesOptions: FlowQueuesOpts

    Map of options for Queue classes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.FlowProducerListener.html b/interfaces/v5.FlowProducerListener.html index 2df2753fae..bcb82e54d3 100644 --- a/interfaces/v5.FlowProducerListener.html +++ b/interfaces/v5.FlowProducerListener.html @@ -1,11 +1,11 @@ -FlowProducerListener | bullmq - v5.34.4

    Interface FlowProducerListener

    interface FlowProducerListener {
        error: ((failedReason) => void);
        ioredis:close: (() => void);
    }

    Hierarchy (view full)

    Properties

    error +FlowProducerListener | bullmq - v5.34.4

    Interface FlowProducerListener

    interface FlowProducerListener {
        error: ((failedReason) => void);
        ioredis:close: (() => void);
    }

    Hierarchy (view full)

    Properties

    error ioredis:close

    Properties

    error

    error: ((failedReason) => void)

    Listen to 'error' event.

    This event is triggered when an error is throw.

    Type declaration

      • (failedReason): void

      • Listen to 'error' event.

        This event is triggered when an error is throw.

        -

        Parameters

        • failedReason: Error

        Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    +

    Parameters

    • failedReason: Error

    Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    Type declaration

      • (): void

      • Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        -

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.GetNextJobOptions.html b/interfaces/v5.GetNextJobOptions.html index 9db9b325f9..5530475caa 100644 --- a/interfaces/v5.GetNextJobOptions.html +++ b/interfaces/v5.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.34.4

    Interface GetNextJobOptions

    interface GetNextJobOptions {
        block?: boolean;
    }

    Properties

    block? -

    Properties

    Optional block

    block?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +GetNextJobOptions | bullmq - v5.34.4

    Interface GetNextJobOptions

    interface GetNextJobOptions {
        block?: boolean;
    }

    Properties

    block? +

    Properties

    Optional block

    block?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.IConnection.html b/interfaces/v5.IConnection.html index 1fc231b8fd..3b56bf2ae0 100644 --- a/interfaces/v5.IConnection.html +++ b/interfaces/v5.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.34.4

    Interface IConnection

    interface IConnection {
        client: Promise<RedisClient>;
        waitUntilReady(): Promise<boolean>;
    }

    Hierarchy

    • EventEmitter
      • IConnection

    Properties

    client +IConnection | bullmq - v5.34.4

    Interface IConnection

    interface IConnection {
        client: Promise<RedisClient>;
        waitUntilReady(): Promise<boolean>;
    }

    Hierarchy

    • EventEmitter
      • IConnection

    Properties

    client

    Methods

    waitUntilReady -

    Properties

    client

    client: Promise<RedisClient>

    Methods

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    client

    client: Promise<RedisClient>

    Methods

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.IoredisListener.html b/interfaces/v5.IoredisListener.html index 0ac9ab9a30..f4c19a61ef 100644 --- a/interfaces/v5.IoredisListener.html +++ b/interfaces/v5.IoredisListener.html @@ -1,6 +1,6 @@ -IoredisListener | bullmq - v5.34.4

    Interface IoredisListener

    interface IoredisListener {
        ioredis:close: (() => void);
    }

    Hierarchy (view full)

    Properties

    ioredis:close +IoredisListener | bullmq - v5.34.4

    Interface IoredisListener

    interface IoredisListener {
        ioredis:close: (() => void);
    }

    Hierarchy (view full)

    Properties

    ioredis:close

    Properties

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    Type declaration

      • (): void

      • Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        -

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.JobJson.html b/interfaces/v5.JobJson.html index 1c5a6160e6..1234df2cf3 100644 --- a/interfaces/v5.JobJson.html +++ b/interfaces/v5.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.34.4

    Interface JobJson

    interface JobJson {
        attemptsMade: number;
        attemptsStarted: number;
        data: string;
        debounceId?: string;
        deduplicationId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        name: string;
        nextRepeatableJobKey?: string;
        opts: RedisJobOptions;
        parent?: ParentKeys;
        parentKey?: string;
        processedBy?: string;
        processedOn?: number;
        progress: number | object;
        repeatJobKey?: string;
        returnvalue: string;
        stacktrace: string;
        timestamp: number;
    }

    Properties

    attemptsMade +JobJson | bullmq - v5.34.4

    Interface JobJson

    interface JobJson {
        attemptsMade: number;
        attemptsStarted: number;
        data: string;
        debounceId?: string;
        deduplicationId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        name: string;
        nextRepeatableJobKey?: string;
        opts: RedisJobOptions;
        parent?: ParentKeys;
        parentKey?: string;
        processedBy?: string;
        processedOn?: number;
        progress: number | object;
        repeatJobKey?: string;
        returnvalue: string;
        stacktrace: string;
        timestamp: number;
    }

    Properties

    attemptsMade attemptsStarted data debounceId? @@ -18,4 +18,4 @@ returnvalue stacktrace timestamp -

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: string

    Optional debounceId

    debounceId?: string

    Optional deduplicationId

    deduplicationId?: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    name

    name: string

    Optional nextRepeatableJobKey

    nextRepeatableJobKey?: string

    opts

    opts: RedisJobOptions

    Optional parent

    parent?: ParentKeys

    Optional parentKey

    parentKey?: string

    Optional processedBy

    processedBy?: string

    Optional processedOn

    processedOn?: number

    progress

    progress: number | object

    Optional repeatJobKey

    repeatJobKey?: string

    returnvalue

    returnvalue: string

    stacktrace

    stacktrace: string

    timestamp

    timestamp: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: string

    Optional debounceId

    debounceId?: string

    Optional deduplicationId

    deduplicationId?: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    name

    name: string

    Optional nextRepeatableJobKey

    nextRepeatableJobKey?: string

    opts

    opts: RedisJobOptions

    Optional parent

    parent?: ParentKeys

    Optional parentKey

    parentKey?: string

    Optional processedBy

    processedBy?: string

    Optional processedOn

    processedOn?: number

    progress

    progress: number | object

    Optional repeatJobKey

    repeatJobKey?: string

    returnvalue

    returnvalue: string

    stacktrace

    stacktrace: string

    timestamp

    timestamp: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.JobJsonRaw.html b/interfaces/v5.JobJsonRaw.html index 9e0364e781..2754743ce9 100644 --- a/interfaces/v5.JobJsonRaw.html +++ b/interfaces/v5.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.34.4

    Interface JobJsonRaw

    interface JobJsonRaw {
        atm?: string;
        ats?: string;
        attemptsMade?: string;
        data: string;
        deid?: string;
        delay: string;
        failedReason: string;
        finishedOn?: string;
        id: string;
        name: string;
        nrjid?: string;
        opts: string;
        parent?: string;
        parentKey?: string;
        pb?: string;
        processedOn?: string;
        progress: string;
        returnvalue: string;
        rjk?: string;
        stacktrace: string[];
        timestamp: string;
    }

    Properties

    atm? +JobJsonRaw | bullmq - v5.34.4

    Interface JobJsonRaw

    interface JobJsonRaw {
        atm?: string;
        ats?: string;
        attemptsMade?: string;
        data: string;
        deid?: string;
        delay: string;
        failedReason: string;
        finishedOn?: string;
        id: string;
        name: string;
        nrjid?: string;
        opts: string;
        parent?: string;
        parentKey?: string;
        pb?: string;
        processedOn?: string;
        progress: string;
        returnvalue: string;
        rjk?: string;
        stacktrace: string[];
        timestamp: string;
    }

    Properties

    atm? ats? attemptsMade? data @@ -19,4 +19,4 @@ rjk? stacktrace timestamp -

    Properties

    Optional atm

    atm?: string

    Optional ats

    ats?: string

    Optional attemptsMade

    attemptsMade?: string

    data

    data: string

    Optional deid

    deid?: string

    delay

    delay: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: string

    id

    id: string

    name

    name: string

    Optional nrjid

    nrjid?: string

    opts

    opts: string

    Optional parent

    parent?: string

    Optional parentKey

    parentKey?: string

    Optional pb

    pb?: string

    Optional processedOn

    processedOn?: string

    progress

    progress: string

    returnvalue

    returnvalue: string

    Optional rjk

    rjk?: string

    stacktrace

    stacktrace: string[]

    timestamp

    timestamp: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional atm

    atm?: string

    Optional ats

    ats?: string

    Optional attemptsMade

    attemptsMade?: string

    data

    data: string

    Optional deid

    deid?: string

    delay

    delay: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: string

    id

    id: string

    name

    name: string

    Optional nrjid

    nrjid?: string

    opts

    opts: string

    Optional parent

    parent?: string

    Optional parentKey

    parentKey?: string

    Optional pb

    pb?: string

    Optional processedOn

    processedOn?: string

    progress

    progress: string

    returnvalue

    returnvalue: string

    Optional rjk

    rjk?: string

    stacktrace

    stacktrace: string[]

    timestamp

    timestamp: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.JobNode.html b/interfaces/v5.JobNode.html index 6ad76e4277..1dcea52db4 100644 --- a/interfaces/v5.JobNode.html +++ b/interfaces/v5.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.34.4

    Interface JobNode

    interface JobNode {
        children?: JobNode[];
        job: Job<any, any, string>;
    }

    Properties

    children? +JobNode | bullmq - v5.34.4

    Interface JobNode

    interface JobNode {
        children?: JobNode[];
        job: Job<any, any, string>;
    }

    Properties

    children? job -

    Properties

    Optional children

    children?: JobNode[]

    job

    job: Job<any, any, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional children

    children?: JobNode[]

    job

    job: Job<any, any, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.JobSchedulerJson.html b/interfaces/v5.JobSchedulerJson.html index c6f9476ee0..63da8d7e69 100644 --- a/interfaces/v5.JobSchedulerJson.html +++ b/interfaces/v5.JobSchedulerJson.html @@ -1,4 +1,4 @@ -JobSchedulerJson | bullmq - v5.34.4

    Interface JobSchedulerJson<D>

    interface JobSchedulerJson<D> {
        endDate: number;
        every?: string;
        id?: string;
        key: string;
        name: string;
        next?: number;
        pattern: string;
        template?: JobSchedulerTemplateJson<D>;
        tz: string;
    }

    Type Parameters

    • D = any

    Properties

    endDate +JobSchedulerJson | bullmq - v5.34.4

    Interface JobSchedulerJson<D>

    interface JobSchedulerJson<D> {
        endDate: number;
        every?: string;
        id?: string;
        key: string;
        name: string;
        next?: number;
        pattern: string;
        template?: JobSchedulerTemplateJson<D>;
        tz: string;
    }

    Type Parameters

    • D = any

    Properties

    endDate every? id? key @@ -7,4 +7,4 @@ pattern template? tz -

    Properties

    endDate

    endDate: number

    Optional every

    every?: string

    Optional id

    id?: string

    key

    key: string

    name

    name: string

    Optional next

    next?: number

    pattern

    pattern: string

    Optional template

    template?: JobSchedulerTemplateJson<D>

    tz

    tz: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endDate

    endDate: number

    Optional every

    every?: string

    Optional id

    id?: string

    key

    key: string

    name

    name: string

    Optional next

    next?: number

    pattern

    pattern: string

    Optional template

    template?: JobSchedulerTemplateJson<D>

    tz

    tz: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.JobSchedulerTemplateJson.html b/interfaces/v5.JobSchedulerTemplateJson.html index ad865da403..ff65e86e16 100644 --- a/interfaces/v5.JobSchedulerTemplateJson.html +++ b/interfaces/v5.JobSchedulerTemplateJson.html @@ -1,3 +1,3 @@ -JobSchedulerTemplateJson | bullmq - v5.34.4

    Interface JobSchedulerTemplateJson<D>

    interface JobSchedulerTemplateJson<D> {
        data?: D;
        opts?: JobSchedulerTemplateOptions;
    }

    Type Parameters

    • D = any

    Properties

    data? +JobSchedulerTemplateJson | bullmq - v5.34.4

    Interface JobSchedulerTemplateJson<D>

    interface JobSchedulerTemplateJson<D> {
        data?: D;
        opts?: JobSchedulerTemplateOptions;
    }

    Type Parameters

    • D = any

    Properties

    data? opts? -

    Properties

    Optional data

    data?: D

    Optional opts

    opts?: JobSchedulerTemplateOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional data

    data?: D

    Optional opts

    opts?: JobSchedulerTemplateOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.KeepJobs.html b/interfaces/v5.KeepJobs.html index bb42155b8b..990c07ca3b 100644 --- a/interfaces/v5.KeepJobs.html +++ b/interfaces/v5.KeepJobs.html @@ -2,8 +2,8 @@

    Specify which jobs to keep after finishing. If both age and count are specified, then the jobs kept will be the ones that satisfies both properties.

    -
    interface KeepJobs {
        age?: number;
        count?: number;
    }

    Properties

    age? +
    interface KeepJobs {
        age?: number;
        count?: number;
    }

    Properties

    age? count?

    Properties

    Optional age

    age?: number

    Maximum age in seconds for job to be kept.

    -

    Optional count

    count?: number

    Maximum count of jobs to be kept.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional count

    count?: number

    Maximum count of jobs to be kept.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Metrics.html b/interfaces/v5.Metrics.html index 6131314832..d5f7e1079b 100644 --- a/interfaces/v5.Metrics.html +++ b/interfaces/v5.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.34.4

    Interface Metrics

    interface Metrics {
        count: number;
        data: number[];
        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        };
    }

    Properties

    count +Metrics | bullmq - v5.34.4

    Interface Metrics

    interface Metrics {
        count: number;
        data: number[];
        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        };
    }

    Properties

    count data meta -

    Properties

    count

    count: number

    data

    data: number[]

    meta

    meta: {
        count: number;
        prevCount: number;
        prevTS: number;
    }

    Type declaration

    • count: number
    • prevCount: number
    • prevTS: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    count

    count: number

    data

    data: number[]

    meta

    meta: {
        count: number;
        prevCount: number;
        prevTS: number;
    }

    Type declaration

    • count: number
    • prevCount: number
    • prevTS: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.MetricsOptions.html b/interfaces/v5.MetricsOptions.html index b388380957..3b4b624857 100644 --- a/interfaces/v5.MetricsOptions.html +++ b/interfaces/v5.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.34.4

    Interface MetricsOptions

    interface MetricsOptions {
        maxDataPoints?: number;
    }

    Properties

    maxDataPoints? +MetricsOptions | bullmq - v5.34.4

    Interface MetricsOptions

    interface MetricsOptions {
        maxDataPoints?: number;
    }

    Properties

    maxDataPoints?

    Properties

    Optional maxDataPoints

    maxDataPoints?: number

    Enable gathering metrics for finished jobs. Output refers to all finished jobs, completed or failed.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.MinimalJob.html b/interfaces/v5.MinimalJob.html index bbb86caf37..7a43353c3d 100644 --- a/interfaces/v5.MinimalJob.html +++ b/interfaces/v5.MinimalJob.html @@ -1,5 +1,5 @@ MinimalJob | bullmq - v5.34.4

    Interface MinimalJob<DataType, ReturnType, NameType>

    MinimalJob

    -
    interface MinimalJob<DataType, ReturnType, NameType> {
        attemptsMade: number;
        data: DataType;
        delay: number;
        failedReason: string;
        finishedOn?: number;
        id?: string;
        name: NameType;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        processedOn?: number;
        progress: number | object;
        repeatJobKey?: string;
        returnvalue: ReturnType;
        stacktrace: string[];
        timestamp: number;
        get prefix(): string;
        get queueName(): string;
        get queueQualifiedName(): string;
        asJSON(): JobJson;
        asJSONSandbox(): JobJsonSandbox;
        log(logRow): Promise<number>;
        updateData(data): Promise<void>;
        updateProgress(progress): Promise<void>;
    }

    Type Parameters

    • DataType = any
    • ReturnType = any
    • NameType extends string = string

    Implemented by

    Properties

    attemptsMade +
    interface MinimalJob<DataType, ReturnType, NameType> {
        attemptsMade: number;
        data: DataType;
        delay: number;
        failedReason: string;
        finishedOn?: number;
        id?: string;
        name: NameType;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        processedOn?: number;
        progress: number | object;
        repeatJobKey?: string;
        returnvalue: ReturnType;
        stacktrace: string[];
        timestamp: number;
        get prefix(): string;
        get queueName(): string;
        get queueQualifiedName(): string;
        asJSON(): JobJson;
        asJSONSandbox(): JobJsonSandbox;
        log(logRow): Promise<number>;
        updateData(data): Promise<void>;
        updateProgress(progress): Promise<void>;
    }

    Type Parameters

    • DataType = any
    • ReturnType = any
    • NameType extends string = string

    Implemented by

    Properties

    attemptsMade data delay failedReason @@ -26,37 +26,37 @@

    Properties

    attemptsMade

    attemptsMade: number

    Number of attempts after the job has failed.

    Default Value

    0
    -

    data

    data: DataType

    The payload for this job.

    -

    delay

    delay: number

    An amount of milliseconds to wait until this job can be processed.

    +

    data

    data: DataType

    The payload for this job.

    +

    delay

    delay: number

    An amount of milliseconds to wait until this job can be processed.

    Default Value

    0
    -

    failedReason

    failedReason: string

    Reason for failing.

    -

    Optional finishedOn

    finishedOn?: number

    Timestamp for when the job finished (completed or failed).

    -

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    -

    opts

    opts: JobsOptions

    The options object for this job.

    -

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    -

    Optional parentKey

    parentKey?: string

    Fully qualified key (including the queue prefix) pointing to the parent of this job.

    -

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    -

    progress

    progress: number | object

    The progress a job has performed so far.

    +

    failedReason

    failedReason: string

    Reason for failing.

    +

    Optional finishedOn

    finishedOn?: number

    Timestamp for when the job finished (completed or failed).

    +

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    +

    opts

    opts: JobsOptions

    The options object for this job.

    +

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    +

    Optional parentKey

    parentKey?: string

    Fully qualified key (including the queue prefix) pointing to the parent of this job.

    +

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    +

    progress

    progress: number | object

    The progress a job has performed so far.

    Default Value

    0
    -

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    -

    returnvalue

    returnvalue: ReturnType

    The value returned by the processor when processing this job.

    +

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    +

    returnvalue

    returnvalue: ReturnType

    The value returned by the processor when processing this job.

    Default Value

    null
    -

    stacktrace

    stacktrace: string[]

    Stacktrace for the error (for failed jobs).

    +

    stacktrace

    stacktrace: string[]

    Stacktrace for the error (for failed jobs).

    Default Value

    null
    -

    timestamp

    timestamp: number

    Timestamp when the job was created (unless overridden with job options).

    -

    Accessors

    prefix

    queueName

    queueQualifiedName

    • get queueQualifiedName(): string

    • Returns string

      it includes the prefix, the namespace separator :, and queue name.

      +

    timestamp

    timestamp: number

    Timestamp when the job was created (unless overridden with job options).

    +

    Accessors

    prefix

    queueName

    queueQualifiedName

    Methods

    asJSON

    asJSONSandbox

    log

    Methods

    asJSON

    asJSONSandbox

    log

    • log(logRow): Promise<number>

    • Logs one row of log data.

      Parameters

      • logRow: string

        string with log data to be logged.

        -

      Returns Promise<number>

    updateData

    • updateData(data): Promise<void>

    • Updates a job's data

      +

    Returns Promise<number>

    updateData

    updateProgress

    Returns Promise<void>

    updateProgress

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.MoveToDelayedOpts.html b/interfaces/v5.MoveToDelayedOpts.html index fdff63047c..e99d855850 100644 --- a/interfaces/v5.MoveToDelayedOpts.html +++ b/interfaces/v5.MoveToDelayedOpts.html @@ -1,3 +1,3 @@ -MoveToDelayedOpts | bullmq - v5.34.4

    Interface MoveToDelayedOpts

    interface MoveToDelayedOpts {
        fieldsToUpdate?: Record<string, any>;
        skipAttempt?: boolean;
    }

    Properties

    fieldsToUpdate? +MoveToDelayedOpts | bullmq - v5.34.4

    Interface MoveToDelayedOpts

    interface MoveToDelayedOpts {
        fieldsToUpdate?: Record<string, any>;
        skipAttempt?: boolean;
    }

    Properties

    fieldsToUpdate? skipAttempt? -

    Properties

    Optional fieldsToUpdate

    fieldsToUpdate?: Record<string, any>

    Optional skipAttempt

    skipAttempt?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional fieldsToUpdate

    fieldsToUpdate?: Record<string, any>

    Optional skipAttempt

    skipAttempt?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.MoveToWaitingChildrenOpts.html b/interfaces/v5.MoveToWaitingChildrenOpts.html index c6f83f8c39..18cf5c5b78 100644 --- a/interfaces/v5.MoveToWaitingChildrenOpts.html +++ b/interfaces/v5.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.34.4

    Interface MoveToWaitingChildrenOpts

    interface MoveToWaitingChildrenOpts {
        child?: {
            id: string;
            queue: string;
        };
    }

    Properties

    child? -

    Properties

    Optional child

    child?: {
        id: string;
        queue: string;
    }

    Type declaration

    • id: string
    • queue: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +MoveToWaitingChildrenOpts | bullmq - v5.34.4

    Interface MoveToWaitingChildrenOpts

    interface MoveToWaitingChildrenOpts {
        child?: {
            id: string;
            queue: string;
        };
    }

    Properties

    child? +

    Properties

    Optional child

    child?: {
        id: string;
        queue: string;
    }

    Type declaration

    • id: string
    • queue: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.NodeOpts.html b/interfaces/v5.NodeOpts.html index f3b91f2a4d..4117276a92 100644 --- a/interfaces/v5.NodeOpts.html +++ b/interfaces/v5.NodeOpts.html @@ -1,11 +1,11 @@ -NodeOpts | bullmq - v5.34.4

    Interface NodeOpts

    interface NodeOpts {
        depth?: number;
        id: string;
        maxChildren?: number;
        prefix?: string;
        queueName: string;
    }

    Properties

    depth? +NodeOpts | bullmq - v5.34.4

    Interface NodeOpts

    interface NodeOpts {
        depth?: number;
        id: string;
        maxChildren?: number;
        prefix?: string;
        queueName: string;
    }

    Properties

    depth? id maxChildren? prefix? queueName

    Properties

    Optional depth

    depth?: number

    Maximum depth or levels to visit in the tree.

    -

    id

    id: string

    Root job id.

    -

    Optional maxChildren

    maxChildren?: number

    Maximum quantity of children per type (processed, unprocessed).

    -

    Optional prefix

    prefix?: string

    Prefix included in job key.

    -

    queueName

    queueName: string

    Root job queue name.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    id

    id: string

    Root job id.

    +

    Optional maxChildren

    maxChildren?: number

    Maximum quantity of children per type (processed, unprocessed).

    +

    Optional prefix

    prefix?: string

    Prefix included in job key.

    +

    queueName

    queueName: string

    Root job queue name.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.ObliterateOpts.html b/interfaces/v5.ObliterateOpts.html index baeb2f7e7f..de648e5f13 100644 --- a/interfaces/v5.ObliterateOpts.html +++ b/interfaces/v5.ObliterateOpts.html @@ -1,9 +1,9 @@ -ObliterateOpts | bullmq - v5.34.4

    Interface ObliterateOpts

    interface ObliterateOpts {
        count?: number;
        force?: boolean;
    }

    Properties

    count? +ObliterateOpts | bullmq - v5.34.4

    Interface ObliterateOpts

    interface ObliterateOpts {
        count?: number;
        force?: boolean;
    }

    Properties

    count? force?

    Properties

    Optional count

    count?: number

    Use count with the maximum number of deleted keys per iteration

    Default Value

    1000
    -

    Optional force

    force?: boolean

    Use force = true to force obliteration even with active jobs in the queue

    +

    Optional force

    force?: boolean

    Use force = true to force obliteration even with active jobs in the queue

    Default Value

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Parent.html b/interfaces/v5.Parent.html index 4852bff09a..9edcd26b22 100644 --- a/interfaces/v5.Parent.html +++ b/interfaces/v5.Parent.html @@ -1,7 +1,7 @@ Parent | bullmq - v5.34.4

    Interface Parent<T>

    Describes the parent for a Job.

    -
    interface Parent<T> {
        data?: T;
        name: string;
        opts?: JobsOptions;
        prefix?: string;
        queue?: string;
    }

    Type Parameters

    • T

    Properties

    data? +
    interface Parent<T> {
        data?: T;
        name: string;
        opts?: JobsOptions;
        prefix?: string;
        queue?: string;
    }

    Type Parameters

    • T

    Properties

    data? name opts? prefix? queue? -

    Properties

    Optional data

    data?: T

    name

    name: string

    Optional opts

    opts?: JobsOptions

    Optional prefix

    prefix?: string

    Optional queue

    queue?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional data

    data?: T

    name

    name: string

    Optional opts

    opts?: JobsOptions

    Optional prefix

    prefix?: string

    Optional queue

    queue?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.ParentKeys.html b/interfaces/v5.ParentKeys.html index 1d3a0f12c6..24b7af293f 100644 --- a/interfaces/v5.ParentKeys.html +++ b/interfaces/v5.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.34.4

    Interface ParentKeys

    interface ParentKeys {
        id: string;
        queueKey: string;
    }

    Properties

    id +ParentKeys | bullmq - v5.34.4

    Interface ParentKeys

    interface ParentKeys {
        id: string;
        queueKey: string;
    }

    Properties

    id queueKey -

    Properties

    id

    id: string

    queueKey

    queueKey: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id

    id: string

    queueKey

    queueKey: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.ParentMessage.html b/interfaces/v5.ParentMessage.html index a0fbf2593b..0845436407 100644 --- a/interfaces/v5.ParentMessage.html +++ b/interfaces/v5.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.34.4

    Interface ParentMessage

    interface ParentMessage {
        cmd: ChildCommand;
        err?: Error;
        job?: JobJson;
        value?: any;
    }

    Properties

    cmd +ParentMessage | bullmq - v5.34.4

    Interface ParentMessage

    interface ParentMessage {
        cmd: ChildCommand;
        err?: Error;
        job?: JobJson;
        value?: any;
    }

    Properties

    cmd err? job? value? -

    Properties

    cmd

    cmd: ChildCommand

    Optional err

    err?: Error

    Optional job

    job?: JobJson

    Optional value

    value?: any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cmd

    cmd: ChildCommand

    Optional err

    err?: Error

    Optional job

    job?: JobJson

    Optional value

    value?: any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.QueueBaseOptions.html b/interfaces/v5.QueueBaseOptions.html index cccf889245..6dab25ea5d 100644 --- a/interfaces/v5.QueueBaseOptions.html +++ b/interfaces/v5.QueueBaseOptions.html @@ -1,14 +1,14 @@ QueueBaseOptions | bullmq - v5.34.4

    Interface QueueBaseOptions

    Base Queue options

    -
    interface QueueBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface QueueBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection prefix? skipVersionCheck? telemetry?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    -

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    +

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    +

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    Default Value

    false
    -

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.QueueEventsListener.html b/interfaces/v5.QueueEventsListener.html index 396cf95029..6ed49a8f60 100644 --- a/interfaces/v5.QueueEventsListener.html +++ b/interfaces/v5.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.34.4

    Interface QueueEventsListener

    interface QueueEventsListener {
        active: ((args, id) => void);
        added: ((args, id) => void);
        cleaned: ((args, id) => void);
        completed: ((args, id) => void);
        debounced: ((args, id) => void);
        deduplicated: ((args, id) => void);
        delayed: ((args, id) => void);
        drained: ((id) => void);
        duplicated: ((args, id) => void);
        error: ((args) => void);
        failed: ((args, id) => void);
        ioredis:close: (() => void);
        paused: ((args, id) => void);
        progress: ((args, id) => void);
        removed: ((args, id) => void);
        resumed: ((args, id) => void);
        retries-exhausted: ((args, id) => void);
        stalled: ((args, id) => void);
        waiting: ((args, id) => void);
        waiting-children: ((args, id) => void);
    }

    Hierarchy (view full)

    Properties

    active +QueueEventsListener | bullmq - v5.34.4

    Interface QueueEventsListener

    interface QueueEventsListener {
        active: ((args, id) => void);
        added: ((args, id) => void);
        cleaned: ((args, id) => void);
        completed: ((args, id) => void);
        debounced: ((args, id) => void);
        deduplicated: ((args, id) => void);
        delayed: ((args, id) => void);
        drained: ((id) => void);
        duplicated: ((args, id) => void);
        error: ((args) => void);
        failed: ((args, id) => void);
        ioredis:close: (() => void);
        paused: ((args, id) => void);
        progress: ((args, id) => void);
        removed: ((args, id) => void);
        resumed: ((args, id) => void);
        retries-exhausted: ((args, id) => void);
        stalled: ((args, id) => void);
        waiting: ((args, id) => void);
        waiting-children: ((args, id) => void);
    }

    Hierarchy (view full)

    Properties

    active added cleaned completed @@ -22,33 +22,33 @@

    This event is triggered when a job enters the 'active' state.

    Type declaration

      • (args, id): void

      • Listen to 'active' event.

        This event is triggered when a job enters the 'active' state.

        -

        Parameters

        • args: {
              jobId: string;
              prev?: string;
          }
          • jobId: string
          • Optional prev?: string
        • id: string

        Returns void

    added

    added: ((args, id) => void)

    Listen to 'added' event.

    +

    Parameters

    • args: {
          jobId: string;
          prev?: string;
      }
      • jobId: string
      • Optional prev?: string
    • id: string

    Returns void

    added

    added: ((args, id) => void)

    Listen to 'added' event.

    This event is triggered when a job is created.

    Type declaration

      • (args, id): void

      • Listen to 'added' event.

        This event is triggered when a job is created.

        -

        Parameters

        • args: {
              jobId: string;
              name: string;
          }
          • jobId: string
          • name: string
        • id: string

        Returns void

    cleaned

    cleaned: ((args, id) => void)

    Listen to 'cleaned' event.

    +

    Parameters

    • args: {
          jobId: string;
          name: string;
      }
      • jobId: string
      • name: string
    • id: string

    Returns void

    cleaned

    cleaned: ((args, id) => void)

    Listen to 'cleaned' event.

    This event is triggered when a cleaned method is triggered.

    Type declaration

      • (args, id): void

      • Listen to 'cleaned' event.

        This event is triggered when a cleaned method is triggered.

        -

        Parameters

        • args: {
              count: string;
          }
          • count: string
        • id: string

        Returns void

    completed

    completed: ((args, id) => void)

    Listen to 'completed' event.

    +

    Parameters

    • args: {
          count: string;
      }
      • count: string
    • id: string

    Returns void

    completed

    completed: ((args, id) => void)

    Listen to 'completed' event.

    This event is triggered when a job has successfully completed.

    Type declaration

      • (args, id): void

      • Listen to 'completed' event.

        This event is triggered when a job has successfully completed.

        -

        Parameters

        • args: {
              jobId: string;
              prev?: string;
              returnvalue: string;
          }
          • jobId: string
          • Optional prev?: string
          • returnvalue: string
        • id: string

        Returns void

    debounced

    debounced: ((args, id) => void)

    Listen to 'debounced' event.

    +

    Parameters

    • args: {
          jobId: string;
          prev?: string;
          returnvalue: string;
      }
      • jobId: string
      • Optional prev?: string
      • returnvalue: string
    • id: string

    Returns void

    debounced

    debounced: ((args, id) => void)

    Listen to 'debounced' event.

    Type declaration

      • (args, id): void

      • Listen to 'debounced' event.

        Parameters

        • args: {
              debounceId: string;
              jobId: string;
          }
          • debounceId: string
          • jobId: string
        • id: string

        Returns void

        Deprecated

        use deduplicated event

        This event is triggered when a job is debounced because debounceId still existed.

    Deprecated

    use deduplicated event

    This event is triggered when a job is debounced because debounceId still existed.

    -

    deduplicated

    deduplicated: ((args, id) => void)

    Listen to 'deduplicated' event.

    +

    deduplicated

    deduplicated: ((args, id) => void)

    Listen to 'deduplicated' event.

    This event is triggered when a job is deduplicated because deduplicatedId still existed.

    Type declaration

      • (args, id): void

      • Listen to 'deduplicated' event.

        This event is triggered when a job is deduplicated because deduplicatedId still existed.

        -

        Parameters

        • args: {
              deduplicationId: string;
              jobId: string;
          }
          • deduplicationId: string
          • jobId: string
        • id: string

        Returns void

    delayed

    delayed: ((args, id) => void)

    Listen to 'delayed' event.

    +

    Parameters

    • args: {
          deduplicationId: string;
          jobId: string;
      }
      • deduplicationId: string
      • jobId: string
    • id: string

    Returns void

    delayed

    delayed: ((args, id) => void)

    Listen to 'delayed' event.

    This event is triggered when a job is delayed.

    Type declaration

    drained

    drained: ((id) => void)

    Listen to 'drained' event.

    +

    Parameters

    Returns void

    drained

    drained: ((id) => void)

    Listen to 'drained' event.

    This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

    @@ -56,27 +56,27 @@

    This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

    -

    Parameters

    Returns void

    duplicated

    duplicated: ((args, id) => void)

    Listen to 'duplicated' event.

    +

    Parameters

    Returns void

    duplicated

    duplicated: ((args, id) => void)

    Listen to 'duplicated' event.

    This event is triggered when a job is not created because it already exist.

    Type declaration

    error

    error: ((args) => void)

    Listen to 'error' event.

    +

    Parameters

    Returns void

    error

    error: ((args) => void)

    Listen to 'error' event.

    This event is triggered when an exception is thrown.

    Type declaration

    failed

    failed: ((args, id) => void)

    Listen to 'failed' event.

    +

    Parameters

    Returns void

    failed

    failed: ((args, id) => void)

    Listen to 'failed' event.

    This event is triggered when a job has thrown an exception.

    Type declaration

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    +

    Parameters

    Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    Type declaration

    paused

    paused: ((args, id) => void)

    Listen to 'paused' event.

    +

    Returns void

    paused

    paused: ((args, id) => void)

    Listen to 'paused' event.

    This event is triggered when a queue is paused.

    Type declaration

    progress

    progress: ((args, id) => void)

    Listen to 'progress' event.

    +

    Parameters

    Returns void

    progress

    progress: ((args, id) => void)

    Listen to 'progress' event.

    This event is triggered when a job updates it progress, i.e. the Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the @@ -86,21 +86,21 @@ Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world.

    -

    Parameters

    Returns void

    removed

    removed: ((args, id) => void)

    Listen to 'removed' event.

    +

    Parameters

    Returns void

    removed

    removed: ((args, id) => void)

    Listen to 'removed' event.

    This event is triggered when a job has been manually removed from the queue.

    Type declaration

    resumed

    resumed: ((args, id) => void)

    Listen to 'resumed' event.

    +

    Parameters

    Returns void

    resumed

    resumed: ((args, id) => void)

    Listen to 'resumed' event.

    This event is triggered when a queue is resumed.

    Type declaration

    retries-exhausted

    retries-exhausted: ((args, id) => void)

    Listen to 'retries-exhausted' event.

    +

    Parameters

    Returns void

    retries-exhausted

    retries-exhausted: ((args, id) => void)

    Listen to 'retries-exhausted' event.

    This event is triggered when a job has retried the maximum attempts.

    Type declaration

    stalled

    stalled: ((args, id) => void)

    Listen to 'stalled' event.

    +

    Parameters

    Returns void

    stalled

    stalled: ((args, id) => void)

    Listen to 'stalled' event.

    This event is triggered when a job has been moved from 'active' back to 'waiting'/'failed' due to the processor not being able to renew the lock on the said job.

    @@ -108,12 +108,12 @@

    This event is triggered when a job has been moved from 'active' back to 'waiting'/'failed' due to the processor not being able to renew the lock on the said job.

    -

    Parameters

    Returns void

    waiting

    waiting: ((args, id) => void)

    Listen to 'waiting' event.

    +

    Parameters

    Returns void

    waiting

    waiting: ((args, id) => void)

    Listen to 'waiting' event.

    This event is triggered when a job enters the 'waiting' state.

    Type declaration

    waiting-children

    waiting-children: ((args, id) => void)

    Listen to 'waiting-children' event.

    +

    Parameters

    Returns void

    waiting-children

    waiting-children: ((args, id) => void)

    Listen to 'waiting-children' event.

    This event is triggered when a job enters the 'waiting-children' state.

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.QueueEventsOptions.html b/interfaces/v5.QueueEventsOptions.html index 96ff4a41cc..829cc30f2e 100644 --- a/interfaces/v5.QueueEventsOptions.html +++ b/interfaces/v5.QueueEventsOptions.html @@ -1,5 +1,5 @@ QueueEventsOptions | bullmq - v5.34.4

    Interface QueueEventsOptions

    Options for QueueEvents

    -
    interface QueueEventsOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        blockingTimeout?: number;
        connection: ConnectionOptions;
        lastEventId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    autorun? +
    interface QueueEventsOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        blockingTimeout?: number;
        connection: ConnectionOptions;
        lastEventId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    autorun? blockingConnection? blockingTimeout? connection @@ -8,15 +8,15 @@ skipVersionCheck? telemetry?

    Properties

    Optional autorun

    autorun?: boolean

    Condition to start listening to events at instance creation.

    -

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Deprecated

    Optional blockingTimeout

    blockingTimeout?: number

    Timeout for the blocking XREAD call to the events stream.

    -

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    -

    Optional lastEventId

    lastEventId?: string

    Last event Id. If provided it is possible to continue +

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    +

    Deprecated

    Optional blockingTimeout

    blockingTimeout?: number

    Timeout for the blocking XREAD call to the events stream.

    +

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    +

    Optional lastEventId

    lastEventId?: string

    Last event Id. If provided it is possible to continue consuming events from a known Id instead of from the last produced event.

    -

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    +

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    Default Value

    false
    -

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.QueueListener.html b/interfaces/v5.QueueListener.html index 34ec3d3bf4..74ab146e05 100644 --- a/interfaces/v5.QueueListener.html +++ b/interfaces/v5.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.34.4

    Interface QueueListener<JobBase>

    interface QueueListener<JobBase> {
        cleaned: ((jobs, type) => void);
        error: ((err) => void);
        ioredis:close: (() => void);
        paused: (() => void);
        progress: ((job, progress) => void);
        removed: ((job) => void);
        resumed: (() => void);
        waiting: ((job) => void);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    cleaned +QueueListener | bullmq - v5.34.4

    Interface QueueListener<JobBase>

    interface QueueListener<JobBase> {
        cleaned: ((jobs, type) => void);
        error: ((err) => void);
        ioredis:close: (() => void);
        paused: (() => void);
        progress: ((job, progress) => void);
        removed: ((job) => void);
        resumed: (() => void);
        waiting: ((job) => void);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    cleaned error ioredis:close paused @@ -10,32 +10,32 @@

    This event is triggered when the queue calls clean method.

    Type declaration

      • (jobs, type): void

      • Listen to 'cleaned' event.

        This event is triggered when the queue calls clean method.

        -

        Parameters

        • jobs: string[]
        • type: string

        Returns void

    error

    error: ((err) => void)

    Listen to 'error' event.

    +

    Parameters

    • jobs: string[]
    • type: string

    Returns void

    error

    error: ((err) => void)

    Listen to 'error' event.

    This event is triggered when an error is thrown.

    Type declaration

      • (err): void

      • Listen to 'error' event.

        This event is triggered when an error is thrown.

        -

        Parameters

        • err: Error

        Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    +

    Parameters

    • err: Error

    Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    Type declaration

      • (): void

      • Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        -

        Returns void

    paused

    paused: (() => void)

    Listen to 'paused' event.

    +

    Returns void

    paused

    paused: (() => void)

    Listen to 'paused' event.

    This event is triggered when the queue is paused.

    Type declaration

      • (): void

      • Listen to 'paused' event.

        This event is triggered when the queue is paused.

        -

        Returns void

    progress

    progress: ((job, progress) => void)

    Listen to 'progress' event.

    +

    Returns void

    progress

    progress: ((job, progress) => void)

    Listen to 'progress' event.

    This event is triggered when the job updates its progress.

    Type declaration

      • (job, progress): void

      • Listen to 'progress' event.

        This event is triggered when the job updates its progress.

        -

        Parameters

        • job: JobBase
        • progress: number | object

        Returns void

    removed

    removed: ((job) => void)

    Listen to 'removed' event.

    +

    Parameters

    • job: JobBase
    • progress: number | object

    Returns void

    removed

    removed: ((job) => void)

    Listen to 'removed' event.

    This event is triggered when a job is removed.

    Type declaration

    resumed

    resumed: (() => void)

    Listen to 'resumed' event.

    +

    Parameters

    Returns void

    resumed

    resumed: (() => void)

    Listen to 'resumed' event.

    This event is triggered when the queue is resumed.

    Type declaration

    waiting

    waiting: ((job) => void)

    Listen to 'waiting' event.

    +

    Returns void

    waiting

    waiting: ((job) => void)

    Listen to 'waiting' event.

    This event is triggered when the queue creates a new job.

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.QueueOptions.html b/interfaces/v5.QueueOptions.html index 982e2e1538..6083a8cb79 100644 --- a/interfaces/v5.QueueOptions.html +++ b/interfaces/v5.QueueOptions.html @@ -1,5 +1,5 @@ QueueOptions | bullmq - v5.34.4

    Interface QueueOptions

    Options for the Queue class.

    -
    interface QueueOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        defaultJobOptions?: DefaultJobOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipMetasUpdate?: boolean;
        skipVersionCheck?: boolean;
        streams?: {
            events: {
                maxLen: number;
            };
        };
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface QueueOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        defaultJobOptions?: DefaultJobOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipMetasUpdate?: boolean;
        skipVersionCheck?: boolean;
        streams?: {
            events: {
                maxLen: number;
            };
        };
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection defaultJobOptions? prefix? @@ -9,19 +9,19 @@ streams? telemetry?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    -

    Optional defaultJobOptions

    defaultJobOptions?: DefaultJobOptions

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    -

    Optional settings

    settings?: AdvancedRepeatOptions

    Advanced options for the repeatable jobs.

    -

    Optional skipMetasUpdate

    skipMetasUpdate?: boolean

    Skip Meta update.

    +

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    +

    Optional defaultJobOptions

    defaultJobOptions?: DefaultJobOptions

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    +

    Optional settings

    settings?: AdvancedRepeatOptions

    Advanced options for the repeatable jobs.

    +

    Optional skipMetasUpdate

    skipMetasUpdate?: boolean

    Skip Meta update.

    If true, the queue will not update the metadata of the queue. Useful for read-only systems that do should not update the metadata.

    Default Value

    false
    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    Default Value

    false
    -

    Optional streams

    streams?: {
        events: {
            maxLen: number;
        };
    }

    Options for the streams used internally in BullMQ.

    +

    Optional streams

    streams?: {
        events: {
            maxLen: number;
        };
    }

    Options for the streams used internally in BullMQ.

    Type declaration

    • events: {
          maxLen: number;
      }

      Options for the events stream.

      • maxLen: number

        Max approximated length for streams. Default is 10 000 events.

        -

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.RateLimiterOptions.html b/interfaces/v5.RateLimiterOptions.html index 49955f043e..55c2a432e1 100644 --- a/interfaces/v5.RateLimiterOptions.html +++ b/interfaces/v5.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.34.4

    Interface RateLimiterOptions

    interface RateLimiterOptions {
        duration: number;
        max: number;
    }

    Properties

    duration +RateLimiterOptions | bullmq - v5.34.4

    Interface RateLimiterOptions

    interface RateLimiterOptions {
        duration: number;
        max: number;
    }

    Properties

    duration max

    Properties

    duration

    duration: number

    Time in milliseconds. During this time, a maximum of max jobs will be processed.

    -

    max

    max: number

    Max number of jobs to process in the time period +

    max

    max: number

    Max number of jobs to process in the time period specified in duration.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.RawCommand.html b/interfaces/v5.RawCommand.html index 785b73dafd..f98b71465e 100644 --- a/interfaces/v5.RawCommand.html +++ b/interfaces/v5.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.34.4

    Interface RawCommand

    interface RawCommand {
        content: string;
        keys: number;
        name: string;
    }

    Properties

    content +RawCommand | bullmq - v5.34.4

    Interface RawCommand

    interface RawCommand {
        content: string;
        keys: number;
        name: string;
    }

    Properties

    content keys name -

    Properties

    content

    content: string

    keys

    keys: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    content

    content: string

    keys

    keys: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.RepeatBaseOptions.html b/interfaces/v5.RepeatBaseOptions.html index 594124ef68..7e2860e5f4 100644 --- a/interfaces/v5.RepeatBaseOptions.html +++ b/interfaces/v5.RepeatBaseOptions.html @@ -1,15 +1,15 @@ RepeatBaseOptions | bullmq - v5.34.4

    Interface RepeatBaseOptions

    Options for the Repeat class.

    -
    interface RepeatBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface RepeatBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
        telemetry?: Telemetry<any>;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection prefix? settings? skipVersionCheck? telemetry?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    -

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    -

    Optional settings

    settings?: AdvancedRepeatOptions

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    +

    Deprecated

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    +

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    +

    Optional settings

    settings?: AdvancedRepeatOptions

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    Default Value

    false
    -

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry client

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.RepeatOptions.html b/interfaces/v5.RepeatOptions.html index 1a333d0c10..85712d0764 100644 --- a/interfaces/v5.RepeatOptions.html +++ b/interfaces/v5.RepeatOptions.html @@ -1,6 +1,6 @@ RepeatOptions | bullmq - v5.34.4

    Interface RepeatOptions

    Settings for repeatable jobs

    See

    https://docs.bullmq.io/guide/jobs/repeatable

    -
    interface RepeatOptions {
        count?: number;
        every?: number;
        immediately?: boolean;
        jobId?: string;
        key?: string;
        limit?: number;
        offset?: number;
        pattern?: string;
        prevMillis?: number;
    }

    Hierarchy

    • Omit<ParserOptions, "iterator">
      • RepeatOptions

    Properties

    count? +
    interface RepeatOptions {
        count?: number;
        every?: number;
        immediately?: boolean;
        jobId?: string;
        key?: string;
        limit?: number;
        offset?: number;
        pattern?: string;
        prevMillis?: number;
    }

    Hierarchy

    • Omit<ParserOptions, "iterator">
      • RepeatOptions

    Properties

    count? every? immediately? jobId? @@ -10,17 +10,17 @@ pattern? prevMillis?

    Properties

    Optional count

    count?: number

    The start value for the repeat iteration count.

    -

    Optional every

    every?: number

    Repeat after this amount of milliseconds +

    Optional every

    every?: number

    Repeat after this amount of milliseconds (pattern setting cannot be used together with this setting.)

    -

    Optional immediately

    immediately?: boolean

    Repeated job should start right now +

    Optional immediately

    immediately?: boolean

    Repeated job should start right now ( work only with cron settings)

    -

    Optional jobId

    jobId?: string

    Internal property to store de job id

    -

    Deprecated

    Optional key

    key?: string

    Custom repeatable key. This is the key that holds the "metadata" +

    Optional jobId

    jobId?: string

    Internal property to store de job id

    +

    Deprecated

    Optional key

    key?: string

    Custom repeatable key. This is the key that holds the "metadata" of a given repeatable job. This key is normally auto-generated but it is sometimes useful to specify a custom key for easier retrieval of repeatable jobs.

    -

    Optional limit

    limit?: number

    Number of times the job should repeat at max.

    -

    Optional offset

    offset?: number

    Offset in milliseconds to affect the next iteration time

    -

    Optional pattern

    pattern?: string

    A repeat pattern

    -

    Optional prevMillis

    prevMillis?: number

    Internal property to store the previous time the job was executed.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional limit

    limit?: number

    Number of times the job should repeat at max.

    +

    Optional offset

    offset?: number

    Offset in milliseconds to affect the next iteration time

    +

    Optional pattern

    pattern?: string

    A repeat pattern

    +

    Optional prevMillis

    prevMillis?: number

    Internal property to store the previous time the job was executed.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.SandboxedJob.html b/interfaces/v5.SandboxedJob.html index 423f625f00..2a6c81a679 100644 --- a/interfaces/v5.SandboxedJob.html +++ b/interfaces/v5.SandboxedJob.html @@ -1,5 +1,5 @@ SandboxedJob | bullmq - v5.34.4

    Interface SandboxedJob<T, R>

    See

    https://docs.bullmq.io/guide/workers/sandboxed-processors

    -
    interface SandboxedJob<T, R> {
        attemptsMade: number;
        attemptsStarted: number;
        data: T;
        debounceId?: string;
        deduplicationId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        log: ((row) => void);
        moveToDelayed: ((timestamp, token?) => Promise<void>);
        name: string;
        nextRepeatableJobKey?: string;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        prefix: string;
        processedBy?: string;
        processedOn?: number;
        progress: number | object;
        queueName: string;
        repeatJobKey?: string;
        returnValue: R;
        returnvalue: string;
        stacktrace: string;
        timestamp: number;
        updateData: ((data) => Promise<void>);
        updateProgress: ((value) => Promise<void>);
    }

    Type Parameters

    • T = any
    • R = any

    Hierarchy

    Properties

    attemptsMade +
    interface SandboxedJob<T, R> {
        attemptsMade: number;
        attemptsStarted: number;
        data: T;
        debounceId?: string;
        deduplicationId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        log: ((row) => void);
        moveToDelayed: ((timestamp, token?) => Promise<void>);
        name: string;
        nextRepeatableJobKey?: string;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        prefix: string;
        processedBy?: string;
        processedOn?: number;
        progress: number | object;
        queueName: string;
        repeatJobKey?: string;
        returnValue: R;
        returnvalue: string;
        stacktrace: string;
        timestamp: number;
        updateData: ((data) => Promise<void>);
        updateProgress: ((value) => Promise<void>);
    }

    Type Parameters

    • T = any
    • R = any

    Hierarchy

    Properties

    attemptsMade attemptsStarted data debounceId? @@ -26,4 +26,4 @@ timestamp updateData updateProgress -

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: T

    Optional debounceId

    debounceId?: string

    Optional deduplicationId

    deduplicationId?: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    log

    log: ((row) => void)

    Type declaration

      • (row): void

      • Parameters

        • row: any

        Returns void

    moveToDelayed

    moveToDelayed: ((timestamp, token?) => Promise<void>)

    Type declaration

      • (timestamp, token?): Promise<void>

      • Parameters

        • timestamp: number
        • Optional token: string

        Returns Promise<void>

    name

    name: string

    Optional nextRepeatableJobKey

    nextRepeatableJobKey?: string

    opts

    opts: JobsOptions

    Optional parent

    parent?: ParentKeys

    Optional parentKey

    parentKey?: string

    prefix

    prefix: string

    Optional processedBy

    processedBy?: string

    Optional processedOn

    processedOn?: number

    progress

    progress: number | object

    queueName

    queueName: string

    Optional repeatJobKey

    repeatJobKey?: string

    returnValue

    returnValue: R

    returnvalue

    returnvalue: string

    stacktrace

    stacktrace: string

    timestamp

    timestamp: number

    updateData

    updateData: ((data) => Promise<void>)

    Type declaration

      • (data): Promise<void>

      • Parameters

        • data: any

        Returns Promise<void>

    updateProgress

    updateProgress: ((value) => Promise<void>)

    Type declaration

      • (value): Promise<void>

      • Parameters

        • value: number | object

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: T

    Optional debounceId

    debounceId?: string

    Optional deduplicationId

    deduplicationId?: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    log

    log: ((row) => void)

    Type declaration

      • (row): void

      • Parameters

        • row: any

        Returns void

    moveToDelayed

    moveToDelayed: ((timestamp, token?) => Promise<void>)

    Type declaration

      • (timestamp, token?): Promise<void>

      • Parameters

        • timestamp: number
        • Optional token: string

        Returns Promise<void>

    name

    name: string

    Optional nextRepeatableJobKey

    nextRepeatableJobKey?: string

    opts

    opts: JobsOptions

    Optional parent

    parent?: ParentKeys

    Optional parentKey

    parentKey?: string

    prefix

    prefix: string

    Optional processedBy

    processedBy?: string

    Optional processedOn

    processedOn?: number

    progress

    progress: number | object

    queueName

    queueName: string

    Optional repeatJobKey

    repeatJobKey?: string

    returnValue

    returnValue: R

    returnvalue

    returnvalue: string

    stacktrace

    stacktrace: string

    timestamp

    timestamp: number

    updateData

    updateData: ((data) => Promise<void>)

    Type declaration

      • (data): Promise<void>

      • Parameters

        • data: any

        Returns Promise<void>

    updateProgress

    updateProgress: ((value) => Promise<void>)

    Type declaration

      • (value): Promise<void>

      • Parameters

        • value: number | object

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.SandboxedOptions.html b/interfaces/v5.SandboxedOptions.html index c913724b2c..60766ad977 100644 --- a/interfaces/v5.SandboxedOptions.html +++ b/interfaces/v5.SandboxedOptions.html @@ -1,4 +1,4 @@ -SandboxedOptions | bullmq - v5.34.4

    Interface SandboxedOptions

    interface SandboxedOptions {
        useWorkerThreads?: boolean;
        workerForkOptions?: ForkOptions;
        workerThreadsOptions?: WorkerOptions;
    }

    Hierarchy (view full)

    Properties

    useWorkerThreads? +SandboxedOptions | bullmq - v5.34.4

    Interface SandboxedOptions

    interface SandboxedOptions {
        useWorkerThreads?: boolean;
        workerForkOptions?: ForkOptions;
        workerThreadsOptions?: WorkerOptions;
    }

    Hierarchy (view full)

    Properties

    useWorkerThreads? workerForkOptions? workerThreadsOptions?

    Properties

    Optional useWorkerThreads

    useWorkerThreads?: boolean

    Use Worker Threads instead of Child Processes. @@ -6,12 +6,12 @@ a file for the processor argument.

    Default

    false
    -

    Optional workerForkOptions

    workerForkOptions?: ForkOptions

    Support passing Worker Fork Options. +

    Optional workerForkOptions

    workerForkOptions?: ForkOptions

    Support passing Worker Fork Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as false (default value).

    See

    https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options

    -

    Optional workerThreadsOptions

    workerThreadsOptions?: WorkerOptions

    Support passing Worker Threads Options. +

    Optional workerThreadsOptions

    workerThreadsOptions?: WorkerOptions

    Support passing Worker Threads Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as true.

    See

    https://nodejs.org/api/worker_threads.html#new-workerfilename-options

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Span.html b/interfaces/v5.Span.html index 23735dc6e1..0ab715fc18 100644 --- a/interfaces/v5.Span.html +++ b/interfaces/v5.Span.html @@ -1,16 +1,16 @@ Span | bullmq - v5.34.4

    Interface Span<Context>

    Span interface

    -
    interface Span<Context> {
        addEvent(name, attributes?): void;
        end(): void;
        recordException(exception, time?): void;
        setAttribute(key, value): void;
        setAttributes(attributes): void;
        setSpanOnContext(ctx): Context;
    }

    Type Parameters

    • Context = any

    Methods

    addEvent +
    interface Span<Context> {
        addEvent(name, attributes?): void;
        end(): void;
        recordException(exception, time?): void;
        setAttribute(key, value): void;
        setAttributes(attributes): void;
        setSpanOnContext(ctx): Context;
    }

    Type Parameters

    • Context = any

    Methods

    addEvent end recordException setAttribute setAttributes setSpanOnContext

    Methods

    addEvent

    end

    end

    • end(): void

    • end ends the span.

      Note: spans must be ended so that they can be exported.

      -

      Returns void

    recordException

    setAttribute

    setAttributes

    setSpanOnContext

    recordException

    setAttribute

    setAttributes

    setSpanOnContext

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Context

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.SpanOptions.html b/interfaces/v5.SpanOptions.html index 0e80092d7f..ce1277012b 100644 --- a/interfaces/v5.SpanOptions.html +++ b/interfaces/v5.SpanOptions.html @@ -1,2 +1,2 @@ -SpanOptions | bullmq - v5.34.4

    Interface SpanOptions

    interface SpanOptions {
        kind: SpanKind;
    }

    Properties

    kind -

    Properties

    kind

    kind: SpanKind

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SpanOptions | bullmq - v5.34.4

    Interface SpanOptions

    interface SpanOptions {
        kind: SpanKind;
    }

    Properties

    kind +

    Properties

    kind

    kind: SpanKind

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Telemetry.html b/interfaces/v5.Telemetry.html index fdb05c4f42..b3dab03563 100644 --- a/interfaces/v5.Telemetry.html +++ b/interfaces/v5.Telemetry.html @@ -2,12 +2,12 @@

    This interface allows third-party libraries to integrate their own telemetry system. The interface is heavily inspired by OpenTelemetry but it's not limited to it.

    -
    interface Telemetry<Context> {
        contextManager: ContextManager<any>;
        tracer: Tracer<Context>;
    }

    Type Parameters

    Properties

    contextManager +
    interface Telemetry<Context> {
        contextManager: ContextManager<any>;
        tracer: Tracer<Context>;
    }

    Type Parameters

    • Context = any

    Properties

    contextManager tracer

    Properties

    contextManager

    contextManager: ContextManager<any>

    Context manager instance

    The context manager is responsible for managing the context and propagating it across the application.

    -

    tracer

    tracer: Tracer<Context>

    Tracer instance

    +

    tracer

    tracer: Tracer<Context>

    Tracer instance

    The tracer is responsible for creating spans and propagating the context across the application.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.Tracer.html b/interfaces/v5.Tracer.html index 250c5d1a31..b3d5623d69 100644 --- a/interfaces/v5.Tracer.html +++ b/interfaces/v5.Tracer.html @@ -1,6 +1,6 @@ Tracer | bullmq - v5.34.4

    Interface Tracer<Context>

    Tracer interface

    -
    interface Tracer<Context> {
        startSpan(name, options?, context?): Span<any>;
    }

    Type Parameters

    • Context = any

    Methods

    startSpan +
    interface Tracer<Context> {
        startSpan(name, options?, context?): Span<any>;
    }

    Type Parameters

    • Context = any

    Methods

    startSpan

    Methods

    startSpan

    • startSpan(name, options?, context?): Span<any>

    • startSpan creates a new Span with the given name and options on an optional context. If the context is not provided, the current active context should be used.

      -

      Parameters

      Returns Span<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Span<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.WorkerListener.html b/interfaces/v5.WorkerListener.html index a95b34622e..dd6f3abc2d 100644 --- a/interfaces/v5.WorkerListener.html +++ b/interfaces/v5.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.34.4

    Interface WorkerListener<DataType, ResultType, NameType>

    interface WorkerListener<DataType, ResultType, NameType> {
        active: ((job, prev) => void);
        closed: (() => void);
        closing: ((msg) => void);
        completed: ((job, result, prev) => void);
        drained: (() => void);
        error: ((failedReason) => void);
        failed: ((job, error, prev) => void);
        ioredis:close: (() => void);
        paused: (() => void);
        progress: ((job, progress) => void);
        ready: (() => void);
        resumed: (() => void);
        stalled: ((jobId, prev) => void);
    }

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy (view full)

    Properties

    active +WorkerListener | bullmq - v5.34.4

    Interface WorkerListener<DataType, ResultType, NameType>

    interface WorkerListener<DataType, ResultType, NameType> {
        active: ((job, prev) => void);
        closed: (() => void);
        closing: ((msg) => void);
        completed: ((job, result, prev) => void);
        drained: (() => void);
        error: ((failedReason) => void);
        failed: ((job, error, prev) => void);
        ioredis:close: (() => void);
        paused: (() => void);
        progress: ((job, progress) => void);
        ready: (() => void);
        resumed: (() => void);
        stalled: ((jobId, prev) => void);
    }

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy (view full)

    Properties

    active closed closing completed @@ -15,19 +15,19 @@

    This event is triggered when a job enters the 'active' state.

    Type declaration

      • (job, prev): void

      • Listen to 'active' event.

        This event is triggered when a job enters the 'active' state.

        -

        Parameters

        Returns void

    closed

    closed: (() => void)

    Listen to 'closing' event.

    +

    Parameters

    Returns void

    closed

    closed: (() => void)

    Listen to 'closing' event.

    This event is triggered when the worker is closed.

    Type declaration

      • (): void

      • Listen to 'closing' event.

        This event is triggered when the worker is closed.

        -

        Returns void

    closing

    closing: ((msg) => void)

    Listen to 'closing' event.

    +

    Returns void

    closing

    closing: ((msg) => void)

    Listen to 'closing' event.

    This event is triggered when the worker is closing.

    Type declaration

      • (msg): void

      • Listen to 'closing' event.

        This event is triggered when the worker is closing.

        -

        Parameters

        • msg: string

        Returns void

    completed

    completed: ((job, result, prev) => void)

    Listen to 'completed' event.

    +

    Parameters

    • msg: string

    Returns void

    completed

    completed: ((job, result, prev) => void)

    Listen to 'completed' event.

    This event is triggered when a job has successfully completed.

    Type declaration

      • (job, result, prev): void

      • Listen to 'completed' event.

        This event is triggered when a job has successfully completed.

        -

        Parameters

        Returns void

    drained

    drained: (() => void)

    Listen to 'drained' event.

    +

    Parameters

    Returns void

    drained

    drained: (() => void)

    Listen to 'drained' event.

    This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

    @@ -35,11 +35,11 @@

    This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

    -

    Returns void

    error

    error: ((failedReason) => void)

    Listen to 'error' event.

    +

    Returns void

    error

    error: ((failedReason) => void)

    Listen to 'error' event.

    This event is triggered when an error is throw.

    Type declaration

    failed

    failed: ((job, error, prev) => void)

    Listen to 'failed' event.

    +

    Parameters

    Returns void

    failed

    failed: ((job, error, prev) => void)

    Listen to 'failed' event.

    This event is triggered when a job has thrown an exception. Note: job parameter could be received as undefined when an stalled job reaches the stalled limit and it is deleted by the removeOnFail option.

    @@ -47,15 +47,15 @@

    This event is triggered when a job has thrown an exception. Note: job parameter could be received as undefined when an stalled job reaches the stalled limit and it is deleted by the removeOnFail option.

    -

    Parameters

    Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    +

    Parameters

    Returns void

    ioredis:close

    ioredis:close: (() => void)

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    Type declaration

    paused

    paused: (() => void)

    Listen to 'paused' event.

    +

    Returns void

    paused

    paused: (() => void)

    Listen to 'paused' event.

    This event is triggered when the queue is paused.

    Type declaration

    progress

    progress: ((job, progress) => void)

    Listen to 'progress' event.

    +

    Returns void

    progress

    progress: ((job, progress) => void)

    Listen to 'progress' event.

    This event is triggered when a job updates it progress, i.e. the Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the @@ -65,18 +65,18 @@ Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world.

    -

    Parameters

    Returns void

    ready

    ready: (() => void)

    Listen to 'ready' event.

    +

    Parameters

    Returns void

    ready

    ready: (() => void)

    Listen to 'ready' event.

    This event is triggered when blockingConnection is ready.

    Type declaration

    resumed

    resumed: (() => void)

    Listen to 'resumed' event.

    +

    Returns void

    resumed

    resumed: (() => void)

    Listen to 'resumed' event.

    This event is triggered when the queue is resumed.

    Type declaration

    stalled

    stalled: ((jobId, prev) => void)

    Listen to 'stalled' event.

    +

    Returns void

    stalled

    stalled: ((jobId, prev) => void)

    Listen to 'stalled' event.

    This event is triggered when a job has stalled and has been moved back to the wait list.

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v5.WorkerOptions.html b/interfaces/v5.WorkerOptions.html index ef0b117b7c..f0f2c0a038 100644 --- a/interfaces/v5.WorkerOptions.html +++ b/interfaces/v5.WorkerOptions.html @@ -1,5 +1,5 @@ WorkerOptions | bullmq - v5.34.4

    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;
        name?: string;
        prefix?: string;
        removeOnComplete?: KeepJobs;
        removeOnFail?: KeepJobs;
        runRetryDelay?: number;
        settings?: AdvancedOptions;
        skipLockRenewal?: boolean;
        skipStalledCheck?: boolean;
        skipVersionCheck?: boolean;
        stalledInterval?: number;
        telemetry?: Telemetry<any>;
        useWorkerThreads?: boolean;
        workerForkOptions?: ForkOptions;
        workerThreadsOptions?: WorkerOptions;
    }

    Hierarchy (view full)

    Properties

    autorun? +
    interface WorkerOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        concurrency?: number;
        connection: ConnectionOptions;
        drainDelay?: number;
        limiter?: RateLimiterOptions;
        lockDuration?: number;
        lockRenewTime?: number;
        maxStalledCount?: number;
        metrics?: MetricsOptions;
        name?: string;
        prefix?: string;
        removeOnComplete?: KeepJobs;
        removeOnFail?: KeepJobs;
        runRetryDelay?: number;
        settings?: AdvancedOptions;
        skipLockRenewal?: boolean;
        skipStalledCheck?: boolean;
        skipVersionCheck?: boolean;
        stalledInterval?: number;
        telemetry?: Telemetry<any>;
        useWorkerThreads?: boolean;
        workerForkOptions?: ForkOptions;
        workerThreadsOptions?: WorkerOptions;
    }

    Hierarchy (view full)

    Properties

    autorun? blockingConnection? concurrency? connection @@ -26,76 +26,76 @@

    Properties

    Optional autorun

    autorun?: boolean

    Condition to start processor at instance creation.

    Default

    true
    -

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Deprecated

    Optional concurrency

    concurrency?: number

    Amount of jobs that a single worker is allowed to work on +

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    +

    Deprecated

    Optional concurrency

    concurrency?: number

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

    Default

    1

    See

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

    -

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    -

    Optional drainDelay

    drainDelay?: number

    Number of seconds to long poll for jobs when the queue is empty.

    +

    connection

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    +

    Optional drainDelay

    drainDelay?: number

    Number of seconds to long poll for jobs when the queue is empty.

    Default

    5
    -

    Optional limiter

    limiter?: RateLimiterOptions

    Enable rate limiter

    +

    Optional limiter

    limiter?: RateLimiterOptions

    Enable rate limiter

    See

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

    -

    Optional lockDuration

    lockDuration?: number

    Duration of the lock for the job in milliseconds. The lock represents that +

    Optional lockDuration

    lockDuration?: number

    Duration of the lock for the job in milliseconds. The lock represents that a worker is processing the job. If the lock is lost, the job will be eventually be picked up by the stalled checker and move back to wait so that another worker can process it again.

    Default

    30000
    -

    Optional lockRenewTime

    lockRenewTime?: number

    The time in milliseconds before the lock is automatically renewed.

    +

    Optional lockRenewTime

    lockRenewTime?: number

    The time in milliseconds before the lock is automatically renewed.

    It is not recommended to modify this value, which is by default set to halv the lockDuration value, which is optimal for most use cases.

    -

    Optional maxStalledCount

    maxStalledCount?: number

    Amount of times a job can be recovered from a stalled state +

    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.

    Default

    1
    -

    Optional metrics

    metrics?: MetricsOptions

    Enable collect metrics.

    +

    Optional metrics

    metrics?: MetricsOptions

    Enable collect metrics.

    See

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

    -

    Optional name

    name?: string

    Optional worker name. The name will be stored on every job +

    Optional name

    name?: string

    Optional worker name. The name will be stored on every job processed by this worker instance, and can be used to monitor which worker is processing or has processed a given job.

    -

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    -

    Optional removeOnComplete

    removeOnComplete?: KeepJobs

    You can provide an object specifying max +

    Optional prefix

    prefix?: string

    Prefix for all queue keys.

    +

    Optional removeOnComplete

    removeOnComplete?: KeepJobs

    You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.

    -

    Optional removeOnFail

    removeOnFail?: KeepJobs

    You can provide an object specifying max +

    Optional removeOnFail

    removeOnFail?: KeepJobs

    You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the failed set.

    -

    Optional runRetryDelay

    runRetryDelay?: number

    This is an internal option that should not be modified.

    +

    Optional runRetryDelay

    runRetryDelay?: number

    This is an internal option that should not be modified.

    Default

    15000
    -

    Optional settings

    settings?: AdvancedOptions

    More advanced options.

    -

    Optional skipLockRenewal

    skipLockRenewal?: boolean

    Skip lock renewal for this worker. If set to true, the lock will expire +

    Optional settings

    settings?: AdvancedOptions

    More advanced options.

    +

    Optional skipLockRenewal

    skipLockRenewal?: boolean

    Skip lock renewal for this worker. If set to true, the lock will expire after lockDuration and moved back to the wait queue (if the stalled check is not disabled)

    Default

    false
    -

    Optional skipStalledCheck

    skipStalledCheck?: boolean

    Skip stalled check for this worker. Note that other workers could still +

    Optional skipStalledCheck

    skipStalledCheck?: boolean

    Skip stalled check for this worker. Note that other workers could still perform stalled checkd and move jobs back to wait for jobs being processed by this worker.

    Default

    false
    -

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    +

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Avoid version validation to be greater or equal than v5.0.0.

    Default Value

    false
    -

    Optional stalledInterval

    stalledInterval?: number

    Number of milliseconds between stallness checks.

    +

    Optional stalledInterval

    stalledInterval?: number

    Number of milliseconds between stallness checks.

    Default

    30000
    -

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry Addon

    -

    Optional useWorkerThreads

    useWorkerThreads?: boolean

    Use Worker Threads instead of Child Processes. +

    Optional telemetry

    telemetry?: Telemetry<any>

    Telemetry Addon

    +

    Optional useWorkerThreads

    useWorkerThreads?: boolean

    Use Worker Threads instead of Child Processes. Note: This option can only be used when specifying a file for the processor argument.

    Default

    false
    -

    Optional workerForkOptions

    workerForkOptions?: ForkOptions

    Support passing Worker Fork Options. +

    Optional workerForkOptions

    workerForkOptions?: ForkOptions

    Support passing Worker Fork Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as false (default value).

    See

    https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options

    -

    Optional workerThreadsOptions

    workerThreadsOptions?: WorkerOptions

    Support passing Worker Threads Options. +

    Optional workerThreadsOptions

    workerThreadsOptions?: WorkerOptions

    Support passing Worker Threads Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as true.

    See

    https://nodejs.org/api/worker_threads.html#new-workerfilename-options

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.AttributeValue.html b/types/v5.AttributeValue.html index 2b35ae834a..71c1b7aa73 100644 --- a/types/v5.AttributeValue.html +++ b/types/v5.AttributeValue.html @@ -1 +1 @@ -AttributeValue | bullmq - v5.34.4

    Type alias AttributeValue

    AttributeValue: string | number | boolean | (null | undefined | string)[] | (null | undefined | number)[] | (null | undefined | boolean)[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AttributeValue | bullmq - v5.34.4

    Type alias AttributeValue

    AttributeValue: string | number | boolean | (null | undefined | string)[] | (null | undefined | number)[] | (null | undefined | boolean)[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.BackoffStrategy.html b/types/v5.BackoffStrategy.html index 9de2409018..7b4e570769 100644 --- a/types/v5.BackoffStrategy.html +++ b/types/v5.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.34.4

    Type alias BackoffStrategy

    BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

    Type declaration

      • (attemptsMade, type?, err?, job?): Promise<number> | number

      • Parameters

        • attemptsMade: number
        • Optional type: string
        • Optional err: Error
        • Optional job: MinimalJob

        Returns Promise<number> | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BackoffStrategy | bullmq - v5.34.4

    Type alias BackoffStrategy

    BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

    Type declaration

      • (attemptsMade, type?, err?, job?): Promise<number> | number

      • Parameters

        • attemptsMade: number
        • Optional type: string
        • Optional err: Error
        • Optional job: MinimalJob

        Returns Promise<number> | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.BulkJobOptions.html b/types/v5.BulkJobOptions.html index fbac105502..167d6a0df5 100644 --- a/types/v5.BulkJobOptions.html +++ b/types/v5.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.34.4

    Type alias BulkJobOptions

    BulkJobOptions: Omit<JobsOptions, "repeat">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BulkJobOptions | bullmq - v5.34.4

    Type alias BulkJobOptions

    BulkJobOptions: Omit<JobsOptions, "repeat">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.ClusterOptions.html b/types/v5.ClusterOptions.html index 8c23cca442..96b41eef5c 100644 --- a/types/v5.ClusterOptions.html +++ b/types/v5.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.34.4

    Type alias ClusterOptions

    ClusterOptions: IORedis.ClusterOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ClusterOptions | bullmq - v5.34.4

    Type alias ClusterOptions

    ClusterOptions: IORedis.ClusterOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.CompressableJobOptions.html b/types/v5.CompressableJobOptions.html index 89af78b21a..4e667221d4 100644 --- a/types/v5.CompressableJobOptions.html +++ b/types/v5.CompressableJobOptions.html @@ -11,4 +11,4 @@
  • Optional omitContext?: boolean

    If true telemetry will omit the context propagation

    Default

    false
    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.ConnectionOptions.html b/types/v5.ConnectionOptions.html index b34d82a514..f3c02b0b23 100644 --- a/types/v5.ConnectionOptions.html +++ b/types/v5.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.34.4

    Type alias ConnectionOptions

    ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConnectionOptions | bullmq - v5.34.4

    Type alias ConnectionOptions

    ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.EntryId.html b/types/v5.EntryId.html index f885c91873..a9bfe70aad 100644 --- a/types/v5.EntryId.html +++ b/types/v5.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.34.4

    Type alias EntryId

    EntryId: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EntryId | bullmq - v5.34.4

    Type alias EntryId

    EntryId: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.EntryRaw.html b/types/v5.EntryRaw.html index e00269b1f4..654dd0ad42 100644 --- a/types/v5.EntryRaw.html +++ b/types/v5.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.34.4

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EntryRaw | bullmq - v5.34.4

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.Exception.html b/types/v5.Exception.html index 0e0556a610..61f7e25c5c 100644 --- a/types/v5.Exception.html +++ b/types/v5.Exception.html @@ -1 +1 @@ -Exception | bullmq - v5.34.4

    Type alias Exception

    Exception: string | ExceptionType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Exception | bullmq - v5.34.4

    Type alias Exception

    Exception: string | ExceptionType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.ExceptionType.html b/types/v5.ExceptionType.html index 745b1374c7..b59ff126d0 100644 --- a/types/v5.ExceptionType.html +++ b/types/v5.ExceptionType.html @@ -1 +1 @@ -ExceptionType | bullmq - v5.34.4

    Type alias ExceptionType

    ExceptionType: CodeException | MessageException | NameException

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ExceptionType | bullmq - v5.34.4

    Type alias ExceptionType

    ExceptionType: CodeException | MessageException | NameException

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.FinishedPropValAttribute.html b/types/v5.FinishedPropValAttribute.html index d7a88d5e30..fab6696ab0 100644 --- a/types/v5.FinishedPropValAttribute.html +++ b/types/v5.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.34.4

    Type alias FinishedPropValAttribute

    FinishedPropValAttribute: "returnvalue" | "failedReason"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FinishedPropValAttribute | bullmq - v5.34.4

    Type alias FinishedPropValAttribute

    FinishedPropValAttribute: "returnvalue" | "failedReason"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.FinishedStatus.html b/types/v5.FinishedStatus.html index 184ec7987a..6bc3352199 100644 --- a/types/v5.FinishedStatus.html +++ b/types/v5.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.34.4

    Type alias FinishedStatus

    FinishedStatus: "completed" | "failed"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FinishedStatus | bullmq - v5.34.4

    Type alias FinishedStatus

    FinishedStatus: "completed" | "failed"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.FlowChildJob.html b/types/v5.FlowChildJob.html index 7cc8f6a500..75bf970f0b 100644 --- a/types/v5.FlowChildJob.html +++ b/types/v5.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.34.4

    Type alias FlowChildJob

    FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlowChildJob | bullmq - v5.34.4

    Type alias FlowChildJob

    FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.FlowJob.html b/types/v5.FlowJob.html index 2bd683ebf7..3b9554abce 100644 --- a/types/v5.FlowJob.html +++ b/types/v5.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.34.4

    Type alias FlowJob

    FlowJob: FlowJobBase<JobsOptions>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlowJob | bullmq - v5.34.4

    Type alias FlowJob

    FlowJob: FlowJobBase<JobsOptions>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.FlowQueuesOpts.html b/types/v5.FlowQueuesOpts.html index 595bfcde82..e9b62fb8f6 100644 --- a/types/v5.FlowQueuesOpts.html +++ b/types/v5.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.34.4

    Type alias FlowQueuesOpts

    FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlowQueuesOpts | bullmq - v5.34.4

    Type alias FlowQueuesOpts

    FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobData.html b/types/v5.JobData.html index 976766d464..2bf5626dc7 100644 --- a/types/v5.JobData.html +++ b/types/v5.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.34.4

    Type alias JobData

    JobData: [JobJsonRaw | number, string?]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobData | bullmq - v5.34.4

    Type alias JobData

    JobData: [JobJsonRaw | number, string?]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobJsonSandbox.html b/types/v5.JobJsonSandbox.html index ec0ad280c1..f435cd1d64 100644 --- a/types/v5.JobJsonSandbox.html +++ b/types/v5.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.34.4

    Type alias JobJsonSandbox

    JobJsonSandbox: JobJson & {
        prefix: string;
        queueName: string;
    }

    Type declaration

    • prefix: string
    • queueName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobJsonSandbox | bullmq - v5.34.4

    Type alias JobJsonSandbox

    JobJsonSandbox: JobJson & {
        prefix: string;
        queueName: string;
    }

    Type declaration

    • prefix: string
    • queueName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobSchedulerTemplateOptions.html b/types/v5.JobSchedulerTemplateOptions.html index ce9b83662f..8af37e241f 100644 --- a/types/v5.JobSchedulerTemplateOptions.html +++ b/types/v5.JobSchedulerTemplateOptions.html @@ -1 +1 @@ -JobSchedulerTemplateOptions | bullmq - v5.34.4

    Type alias JobSchedulerTemplateOptions

    JobSchedulerTemplateOptions: Omit<JobsOptions, "jobId" | "repeat" | "delay" | "deduplication" | "debounce">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobSchedulerTemplateOptions | bullmq - v5.34.4

    Type alias JobSchedulerTemplateOptions

    JobSchedulerTemplateOptions: Omit<JobsOptions, "jobId" | "repeat" | "delay" | "deduplication" | "debounce">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobState.html b/types/v5.JobState.html index 4b0855f822..1ac2192082 100644 --- a/types/v5.JobState.html +++ b/types/v5.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.34.4

    Type alias JobState

    JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobState | bullmq - v5.34.4

    Type alias JobState

    JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobType.html b/types/v5.JobType.html index 4e839ec927..bbec55b4d2 100644 --- a/types/v5.JobType.html +++ b/types/v5.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.34.4

    Type alias JobType

    JobType: JobState | "paused" | "repeat" | "wait"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobType | bullmq - v5.34.4

    Type alias JobType

    JobType: JobState | "paused" | "repeat" | "wait"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.JobsOptions.html b/types/v5.JobsOptions.html index 989d251311..984cb5e129 100644 --- a/types/v5.JobsOptions.html +++ b/types/v5.JobsOptions.html @@ -1 +1 @@ -JobsOptions | bullmq - v5.34.4

    Type alias JobsOptions

    JobsOptions: BaseJobOptions & CompressableJobOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JobsOptions | bullmq - v5.34.4

    Type alias JobsOptions

    JobsOptions: BaseJobOptions & CompressableJobOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.KeysMap.html b/types/v5.KeysMap.html index 65e69aebb5..518f8ca04a 100644 --- a/types/v5.KeysMap.html +++ b/types/v5.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.34.4

    Type alias KeysMap

    KeysMap: {
        [index in string]: string
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KeysMap | bullmq - v5.34.4

    Type alias KeysMap

    KeysMap: {
        [index in string]: string
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.MinimalQueue.html b/types/v5.MinimalQueue.html index f4d7d9df2c..38cdb81b92 100644 --- a/types/v5.MinimalQueue.html +++ b/types/v5.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.34.4

    Type alias MinimalQueue

    MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion" | "trace">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MinimalQueue | bullmq - v5.34.4

    Type alias MinimalQueue

    MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion" | "trace">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.ParentOpts.html b/types/v5.ParentOpts.html index 60432f2c12..98925a5619 100644 --- a/types/v5.ParentOpts.html +++ b/types/v5.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.34.4

    Type alias ParentOpts

    ParentOpts: {
        parentDependenciesKey?: string;
        parentKey?: string;
        waitChildrenKey?: string;
    }

    Type declaration

    • Optional parentDependenciesKey?: string
    • Optional parentKey?: string
    • Optional waitChildrenKey?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ParentOpts | bullmq - v5.34.4

    Type alias ParentOpts

    ParentOpts: {
        parentDependenciesKey?: string;
        parentKey?: string;
        waitChildrenKey?: string;
    }

    Type declaration

    • Optional parentDependenciesKey?: string
    • Optional parentKey?: string
    • Optional waitChildrenKey?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.Processor.html b/types/v5.Processor.html index a99d49f333..5cf1acc950 100644 --- a/types/v5.Processor.html +++ b/types/v5.Processor.html @@ -1,2 +1,2 @@ Processor | bullmq - v5.34.4

    Type alias Processor<T, R, N>

    Processor<T, R, N>: ((job, token?) => Promise<R>)

    An async function that receives Jobs and handles them.

    -

    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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RedisClient.html b/types/v5.RedisClient.html index 377cb7c3d0..f6583cdccd 100644 --- a/types/v5.RedisClient.html +++ b/types/v5.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.34.4

    Type alias RedisClient

    RedisClient: Redis | Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RedisClient | bullmq - v5.34.4

    Type alias RedisClient

    RedisClient: Redis | Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RedisJobOptions.html b/types/v5.RedisJobOptions.html index a22a61ba47..24afdb7826 100644 --- a/types/v5.RedisJobOptions.html +++ b/types/v5.RedisJobOptions.html @@ -8,4 +8,4 @@
  • Optional omc?: boolean

    Omit Context Propagation

  • Optional rdof?: boolean

    If true, removes the job from its parent dependencies when it fails after all attempts.

  • Optional tm?: string

    TelemetryMetadata, provide for context propagation.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RedisOptions.html b/types/v5.RedisOptions.html index 88e9a07d9d..23042aa8cc 100644 --- a/types/v5.RedisOptions.html +++ b/types/v5.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.34.4

    Type alias RedisOptions

    RedisOptions: IORedis.RedisOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RedisOptions | bullmq - v5.34.4

    Type alias RedisOptions

    RedisOptions: IORedis.RedisOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RepeatStrategy.html b/types/v5.RepeatStrategy.html index 7f7a411686..0a930badf0 100644 --- a/types/v5.RepeatStrategy.html +++ b/types/v5.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.34.4

    Type alias RepeatStrategy

    RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

    Type declaration

      • (millis, opts, name?): number | undefined | Promise<number | undefined>

      • Parameters

        Returns number | undefined | Promise<number | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RepeatStrategy | bullmq - v5.34.4

    Type alias RepeatStrategy

    RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

    Type declaration

      • (millis, opts, name?): number | undefined | Promise<number | undefined>

      • Parameters

        Returns number | undefined | Promise<number | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RepeatableJob.html b/types/v5.RepeatableJob.html index 8304dd8800..1780258a17 100644 --- a/types/v5.RepeatableJob.html +++ b/types/v5.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.34.4

    Type alias RepeatableJob

    RepeatableJob: {
        endDate: number | null;
        every?: string | null;
        id?: string | null;
        key: string;
        name: string;
        next?: number;
        pattern: string | null;
        tz: string | null;
    }

    Type declaration

    • endDate: number | null
    • Optional every?: string | null
    • Optional id?: string | null
    • key: string
    • name: string
    • Optional next?: number
    • pattern: string | null
    • tz: string | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RepeatableJob | bullmq - v5.34.4

    Type alias RepeatableJob

    RepeatableJob: {
        endDate: number | null;
        every?: string | null;
        id?: string | null;
        key: string;
        name: string;
        next?: number;
        pattern: string | null;
        tz: string | null;
    }

    Type declaration

    • endDate: number | null
    • Optional every?: string | null
    • Optional id?: string | null
    • key: string
    • name: string
    • Optional next?: number
    • pattern: string | null
    • tz: string | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.RepeatableOptions.html b/types/v5.RepeatableOptions.html index db03dd4ddc..52bdd4f9f1 100644 --- a/types/v5.RepeatableOptions.html +++ b/types/v5.RepeatableOptions.html @@ -1 +1 @@ -RepeatableOptions | bullmq - v5.34.4

    Type alias RepeatableOptions

    RepeatableOptions: {
        endDate?: number;
        every?: number;
        name: string;
        pattern?: string;
        tz?: string;
    }

    Type declaration

    • Optional endDate?: number
    • Optional every?: number
    • name: string
    • Optional pattern?: string
    • Optional tz?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RepeatableOptions | bullmq - v5.34.4

    Type alias RepeatableOptions

    RepeatableOptions: {
        endDate?: number;
        every?: number;
        name: string;
        pattern?: string;
        tz?: string;
    }

    Type declaration

    • Optional endDate?: number
    • Optional every?: number
    • name: string
    • Optional pattern?: string
    • Optional tz?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.SandboxedJobProcessor.html b/types/v5.SandboxedJobProcessor.html index afab16d73a..73299ef774 100644 --- a/types/v5.SandboxedJobProcessor.html +++ b/types/v5.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ SandboxedJobProcessor | bullmq - v5.34.4

    Type alias SandboxedJobProcessor<T, R>

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

    Type Parameters

    • T = any
    • R = any

    Type declaration

    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

    See

    https://docs.bullmq.io/guide/workers/sandboxed-processors

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.StreamName.html b/types/v5.StreamName.html index d79b751f53..20aede52e8 100644 --- a/types/v5.StreamName.html +++ b/types/v5.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.34.4

    Type alias StreamName

    StreamName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StreamName | bullmq - v5.34.4

    Type alias StreamName

    StreamName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.StreamReadRaw.html b/types/v5.StreamReadRaw.html index c92934edd9..74cab90f77 100644 --- a/types/v5.StreamReadRaw.html +++ b/types/v5.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.34.4

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StreamReadRaw | bullmq - v5.34.4

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/v5.Time.html b/types/v5.Time.html index 01b99bf761..1db5a1b047 100644 --- a/types/v5.Time.html +++ b/types/v5.Time.html @@ -1 +1 @@ -Time | bullmq - v5.34.4

    Type alias Time

    Time: HighResolutionTime | number | Date

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Time | bullmq - v5.34.4

    Type alias Time

    Time: HighResolutionTime | number | Date

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.DELAYED_ERROR.html b/variables/v5.DELAYED_ERROR.html index 20a568bcea..4b3ff39a49 100644 --- a/variables/v5.DELAYED_ERROR.html +++ b/variables/v5.DELAYED_ERROR.html @@ -1 +1 @@ -DELAYED_ERROR | bullmq - v5.34.4

    Variable DELAYED_ERRORConst

    DELAYED_ERROR: "bullmq:movedToDelayed" = 'bullmq:movedToDelayed'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DELAYED_ERROR | bullmq - v5.34.4

    Variable DELAYED_ERRORConst

    DELAYED_ERROR: "bullmq:movedToDelayed" = 'bullmq:movedToDelayed'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.DELAY_TIME_1.html b/variables/v5.DELAY_TIME_1.html index 7cec73e563..fefcbca94a 100644 --- a/variables/v5.DELAY_TIME_1.html +++ b/variables/v5.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.34.4

    Variable DELAY_TIME_1Const

    DELAY_TIME_1: 100 = 100

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.34.4

    Variable DELAY_TIME_1Const

    DELAY_TIME_1: 100 = 100

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.DELAY_TIME_5.html b/variables/v5.DELAY_TIME_5.html index 461a988177..1c0df1d46a 100644 --- a/variables/v5.DELAY_TIME_5.html +++ b/variables/v5.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.34.4

    Variable DELAY_TIME_5Const

    DELAY_TIME_5: 5000 = 5000

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.34.4

    Variable DELAY_TIME_5Const

    DELAY_TIME_5: 5000 = 5000

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.PRIORITY_LIMIT.html b/variables/v5.PRIORITY_LIMIT.html index 40dff8e07a..26c71a1fa0 100644 --- a/variables/v5.PRIORITY_LIMIT.html +++ b/variables/v5.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.34.4

    Variable PRIORITY_LIMITConst

    PRIORITY_LIMIT: number = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PRIORITY_LIMIT | bullmq - v5.34.4

    Variable PRIORITY_LIMITConst

    PRIORITY_LIMIT: number = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.QUEUE_EVENT_SUFFIX.html b/variables/v5.QUEUE_EVENT_SUFFIX.html index 9c4ed2236a..b612e40dc4 100644 --- a/variables/v5.QUEUE_EVENT_SUFFIX.html +++ b/variables/v5.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.34.4

    Variable QUEUE_EVENT_SUFFIXConst

    QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.34.4

    Variable QUEUE_EVENT_SUFFIXConst

    QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.RATE_LIMIT_ERROR.html b/variables/v5.RATE_LIMIT_ERROR.html index 746648ebfc..2ee932d153 100644 --- a/variables/v5.RATE_LIMIT_ERROR.html +++ b/variables/v5.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.34.4

    Variable RATE_LIMIT_ERRORConst

    RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RATE_LIMIT_ERROR | bullmq - v5.34.4

    Variable RATE_LIMIT_ERRORConst

    RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.UNRECOVERABLE_ERROR.html b/variables/v5.UNRECOVERABLE_ERROR.html index 9a77513443..61b0c60325 100644 --- a/variables/v5.UNRECOVERABLE_ERROR.html +++ b/variables/v5.UNRECOVERABLE_ERROR.html @@ -1 +1 @@ -UNRECOVERABLE_ERROR | bullmq - v5.34.4

    Variable UNRECOVERABLE_ERRORConst

    UNRECOVERABLE_ERROR: "bullmq:unrecoverable" = 'bullmq:unrecoverable'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UNRECOVERABLE_ERROR | bullmq - v5.34.4

    Variable UNRECOVERABLE_ERRORConst

    UNRECOVERABLE_ERROR: "bullmq:unrecoverable" = 'bullmq:unrecoverable'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.WAITING_CHILDREN_ERROR.html b/variables/v5.WAITING_CHILDREN_ERROR.html index e5cd916bd2..56e4b705d8 100644 --- a/variables/v5.WAITING_CHILDREN_ERROR.html +++ b/variables/v5.WAITING_CHILDREN_ERROR.html @@ -1 +1 @@ -WAITING_CHILDREN_ERROR | bullmq - v5.34.4

    Variable WAITING_CHILDREN_ERRORConst

    WAITING_CHILDREN_ERROR: "bullmq:movedToWaitingChildren" = 'bullmq:movedToWaitingChildren'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WAITING_CHILDREN_ERROR | bullmq - v5.34.4

    Variable WAITING_CHILDREN_ERRORConst

    WAITING_CHILDREN_ERROR: "bullmq:movedToWaitingChildren" = 'bullmq:movedToWaitingChildren'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.clientCommandMessageReg.html b/variables/v5.clientCommandMessageReg.html index beb88ae99d..b466b4aefd 100644 --- a/variables/v5.clientCommandMessageReg.html +++ b/variables/v5.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.34.4

    Variable clientCommandMessageRegConst

    clientCommandMessageReg: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +clientCommandMessageReg | bullmq - v5.34.4

    Variable clientCommandMessageRegConst

    clientCommandMessageReg: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/v5.errorObject.html b/variables/v5.errorObject.html index 26da2bd65b..22fc9d45bc 100644 --- a/variables/v5.errorObject.html +++ b/variables/v5.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.34.4

    Variable errorObjectConst

    errorObject: {
        [index: string]: any;
    } = ...

    Type declaration

    • [index: string]: any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +errorObject | bullmq - v5.34.4

    Variable errorObjectConst

    errorObject: {
        [index: string]: any;
    } = ...

    Type declaration

    • [index: string]: any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file