diff --git a/classes/v5.AsyncFifoQueue.html b/classes/v5.AsyncFifoQueue.html index 610a7d8eac..70a00a1cc5 100644 --- a/classes/v5.AsyncFifoQueue.html +++ b/classes/v5.AsyncFifoQueue.html @@ -1,11 +1,11 @@ AsyncFifoQueue | bullmq - v5.12.12

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 ba51e663c6..1337d32d93 100644 --- a/classes/v5.Backoffs.html +++ b/classes/v5.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.12

Class Backoffs

Constructors

constructor +Backoffs | bullmq - v5.12.12

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.ChildPool.html b/classes/v5.ChildPool.html index 97b70a420e..8fc493a17e 100644 --- a/classes/v5.ChildPool.html +++ b/classes/v5.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.12

Class ChildPool

Constructors

constructor +ChildPool | bullmq - v5.12.12

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

  • [key: string]: Child[]

retained

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

Type declaration

  • [key: number]: Child

Methods

clean

getAllFree

getFree

kill

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

  • Parameters

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

    Returns Promise<void>

release

remove

retain

  • retain(processFile): Promise<Child>

  • Parameters

    • processFile: string

    Returns Promise<Child>

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

  • [key: string]: Child[]

retained

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

Type declaration

  • [key: number]: Child

Methods

clean

getAllFree

getFree

kill

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

  • Parameters

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

    Returns Promise<void>

release

remove

retain

  • retain(processFile): Promise<Child>

  • Parameters

    • processFile: string

    Returns Promise<Child>

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 df930b18ed..e2c0163741 100644 --- a/classes/v5.ChildProcessor.html +++ b/classes/v5.ChildProcessor.html @@ -1,7 +1,7 @@ ChildProcessor | bullmq - v5.12.12

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 e153cd88b7..348987518f 100644 --- a/classes/v5.DelayedError.html +++ b/classes/v5.DelayedError.html @@ -1,5 +1,5 @@ DelayedError | bullmq - v5.12.12

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 75b6a85067..781a77c843 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 83e1d2e1f8..c3036be8e8 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 @@ -67,137 +67,137 @@

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.

    -

    delay

    delay: number

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

    +

    data

    data: DataType

    The payload for this job.

    +

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    +

    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 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.

    +

    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 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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    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 d7513b5733..e362fdc44b 100644 --- a/classes/v5.Queue.html +++ b/classes/v5.Queue.html @@ -1,7 +1,7 @@ Queue | bullmq - v5.12.12

    Class Queue<DataType, ResultType, NameType>

    Queue

    This class provides methods to add jobs to a queue and some other high-level administration such as pausing or deleting queues.

    -

    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 jobsOpts keys @@ -73,55 +73,55 @@ trimEvents updateJobProgress 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

    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

    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

    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<Job<DataType, ResultType, NameType>[]>

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDelayed

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

    getCompletedCount

    getCountsPerPriority

    getDelayed

    getDelayedCount

    getDependencies

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

    getDelayedCount

    getDependencies

    getFailed

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

    getFailed

    getFailedCount

    getGlobalConcurrency

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

    getFailedCount

    getGlobalConcurrency

    getJob

    getJobCountByTypes

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobState

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

    getJobState

    getJobs

    getJobs

    getMetrics

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

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

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

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getRepeatableJobs

    getRepeatableJobs

    getWaiting

    Returns Promise<RepeatableJob[]>

    getWaiting

    getWaitingChildren

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

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    Returns Promise<Job<DataType, 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

    remove

    promoteJobs

    remove

    removeDebounceKey

    removeDebounceKey

    removeDeprecatedPriorityKey

    removeRepeatable

    Returns Promise<number>

    removeDeprecatedPriorityKey

    removeRepeatable

    removeRepeatableByKey

    removeRepeatableByKey

    resume

    resume

    retryJobs

    setGlobalConcurrency

    retryJobs

    setGlobalConcurrency

    trimEvents

    updateJobProgress

    Returns Promise<number>

    trimEvents

    updateJobProgress

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    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 a97e7b4fa2..70e3fc3908 100644 --- a/classes/v5.QueueBase.html +++ b/classes/v5.QueueBase.html @@ -1,7 +1,7 @@ QueueBase | bullmq - v5.12.12

    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 @@ -18,12 +18,12 @@
  • 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.

    -

    • 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.

      +

    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

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Rest ...args: any[]

    • Returns boolean

    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 ce165996a3..5cad83e14c 100644 --- a/classes/v5.QueueEvents.html +++ b/classes/v5.QueueEvents.html @@ -1,7 +1,7 @@ QueueEvents | bullmq - v5.12.12

    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 @@ -18,14 +18,14 @@ once run 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<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: Parameters<QueueEventsListener[U]>

    Returns boolean

    off

    on

    once

    run

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    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 93fa74a87d..595f07fb33 100644 --- a/classes/v5.QueueGetters.html +++ b/classes/v5.QueueGetters.html @@ -1,6 +1,6 @@ QueueGetters | bullmq - v5.12.12

    Class QueueGetters<DataType, ResultType, NameType>

    QueueGetters

    Description

    Provides different getters for different aspects of a queue.

    -

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -46,30 +46,30 @@
  • 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.

    -

    • Returns QueueGetters<DataType, ResultType, NameType>

    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 +

    Returns QueueGetters<DataType, ResultType, NameType>

    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

    Returns boolean

    getActive

    getActiveCount

    getCompleted

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

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDelayed

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

    getCompletedCount

    getCountsPerPriority

    getDelayed

    getDelayedCount

    getDependencies

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

    getDelayedCount

    getDependencies

    getFailed

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

    getFailed

    getFailedCount

    getJob

    getJobCountByTypes

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

    getFailedCount

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobState

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

    getJobState

    getJobs

    getJobs

    getMetrics

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

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

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

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getWaiting

    getWaiting

    getWaitingChildren

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

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

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

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    getWorkersCount

    getWorkersCount

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<number>

    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 1cf36c93e1..1a3500b126 100644 --- a/classes/v5.QueueKeys.html +++ b/classes/v5.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.12

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.12

    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 4e13c39ad0..cdb9d51d0c 100644 --- a/classes/v5.RateLimitError.html +++ b/classes/v5.RateLimitError.html @@ -1,4 +1,4 @@ RateLimitError | bullmq - v5.12.12

    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 6d20ed4ba5..34e8eaab47 100644 --- a/classes/v5.RedisConnection.html +++ b/classes/v5.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.12

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.12

    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 91a3243471..7141b85cca 100644 --- a/classes/v5.Repeat.html +++ b/classes/v5.Repeat.html @@ -1,7 +1,7 @@ Repeat | bullmq - v5.12.12

    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 @@ -20,12 +20,12 @@ removeRepeatable removeRepeatableByKey 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

    addNextRepeatableJob

    • addNextRepeatableJob<T, R, N>(name, data, opts, skipCheckExists?): Promise<Job<T, R, N>>

    • Type Parameters

      • T = any
      • R = any
      • N extends string = string

      Parameters

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

    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

    addNextRepeatableJob

    • addNextRepeatableJob<T, R, N>(name, data, opts, skipCheckExists?): Promise<Job<T, R, N>>

    • Type Parameters

      • T = any
      • R = any
      • N extends string = string

      Parameters

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

    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>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Rest ...args: any[]

    • Returns boolean

    getRepeatJobKey

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

    removeRepeatableByKey

    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 813742a8f1..c4124da03f 100644 --- a/classes/v5.Scripts.html +++ b/classes/v5.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.12

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.12

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

    addJob addLog @@ -44,19 +44,19 @@ saveStacktraceArgs updateData updateProgress -

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

      • customKey: string
      • nextMillis: number
      • opts: RepeatableOptions
      • legacyCustomKey: string
      • skipCheckExists: boolean

      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

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

      • customKey: string
      • nextMillis: number
      • opts: RepeatableOptions
      • legacyCustomKey: string
      • skipCheckExists: boolean

      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

    extendLock

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

    • Parameters

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

      Returns Promise<number>

    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[]>

    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

    extendLock

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

    • Parameters

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

      Returns Promise<number>

    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[]>

    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

    removeRepeatable

    reprocessJob

    moveToWaitingChildrenArgs

    obliterate

    paginate

    pause

    promote

    promoteJobs

    remove

    removeChildDependency

    removeRepeatable

    reprocessJob

    retryJobArgs

    retryJobs

    saveStacktraceArgs

    updateData

    updateProgress

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJobArgs

    retryJobs

    saveStacktraceArgs

    updateData

    updateProgress

    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 f9e79e7625..3946fb71ea 100644 --- a/classes/v5.UnrecoverableError.html +++ b/classes/v5.UnrecoverableError.html @@ -1,5 +1,5 @@ UnrecoverableError | bullmq - v5.12.12

    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 fc3ad37039..637a3a7738 100644 --- a/classes/v5.WaitingChildrenError.html +++ b/classes/v5.WaitingChildrenError.html @@ -1,5 +1,5 @@ WaitingChildrenError | bullmq - v5.12.12

    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 17f91d9729..5501df3f73 100644 --- a/classes/v5.Worker.html +++ b/classes/v5.Worker.html @@ -1,7 +1,7 @@ Worker | bullmq - v5.12.12

    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 @@ -32,31 +32,31 @@ startStalledCheckTimer 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

    • set concurrency(concurrency): void

    • Parameters

      • concurrency: number

      Returns void

    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

    • set concurrency(concurrency): void

    • Parameters

      • concurrency: number

      Returns void

    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.

      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

    Returns Promise<void>

    resume

    run

    startStalledCheckTimer

    waitUntilReady

    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 263569993c..37ee8ea68a 100644 --- a/enums/v5.ChildCommand.html +++ b/enums/v5.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.12

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.12

    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 0f9b598d4f..a4d083370f 100644 --- a/enums/v5.ClientType.html +++ b/enums/v5.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.12

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.12

    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 f60b2a9e88..bef8d006b8 100644 --- a/enums/v5.ErrorCode.html +++ b/enums/v5.ErrorCode.html @@ -1,8 +1,8 @@ -ErrorCode | bullmq - v5.12.12

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.12

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobCannotBeReplaced ParentJobNotExist -

    Enumeration Members

    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

    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 8fb36cd4e8..3d759feea2 100644 --- a/enums/v5.MetricsTime.html +++ b/enums/v5.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.12

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.12

    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 99f1938202..5133e32cf6 100644 --- a/enums/v5.ParentCommand.html +++ b/enums/v5.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.12

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.12

    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/functions/v5.array2obj.html b/functions/v5.array2obj.html index 7906aa09b1..5a42fbb9cd 100644 --- a/functions/v5.array2obj.html +++ b/functions/v5.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.12

    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.12.12

    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 6af2dd3a06..b3d4ee2527 100644 --- a/functions/v5.asyncSend.html +++ b/functions/v5.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.12

    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.12.12

    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 83970fe110..9d28a0781a 100644 --- a/functions/v5.childSend.html +++ b/functions/v5.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.12

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 85f30b61e6..8a7ad5f9ea 100644 --- a/functions/v5.decreaseMaxListeners.html +++ b/functions/v5.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.12.12

    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.12.12

    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.delay.html b/functions/v5.delay.html index 365ae6228f..6ff598b9ec 100644 --- a/functions/v5.delay.html +++ b/functions/v5.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.12

    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.12.12

    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 5de7903345..02f0316306 100644 --- a/functions/v5.errorToJSON.html +++ b/functions/v5.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.12

    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.12.12

    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 4542d02b0f..bb5aebefa3 100644 --- a/functions/v5.getNextMillis.html +++ b/functions/v5.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.12

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 73c6d526d3..7f9a86c7ce 100644 --- a/functions/v5.getParentKey.html +++ b/functions/v5.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.12

    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.12.12

    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 1b9ce787ba..0155ea7dde 100644 --- a/functions/v5.increaseMaxListeners.html +++ b/functions/v5.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.12.12

    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.12.12

    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 e7b13cdd08..d5f39adff7 100644 --- a/functions/v5.invertObject.html +++ b/functions/v5.invertObject.html @@ -1 +1 @@ -invertObject | bullmq - v5.12.12

    Function invertObject

    • invertObject(obj): Record<string, string>

    • Parameters

      • obj: Record<string, string>

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invertObject

    • invertObject(obj): Record<string, string>

    • Parameters

      • obj: Record<string, string>

      Returns Record<string, string>

    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 509f98add6..6095221505 100644 --- a/functions/v5.isEmpty.html +++ b/functions/v5.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.12

    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.12.12

    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 385b72b424..33c4baaaf2 100644 --- a/functions/v5.isNotConnectionError.html +++ b/functions/v5.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.12

    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.12.12

    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 4467ca2d1e..d72d3e18d8 100644 --- a/functions/v5.isRedisCluster.html +++ b/functions/v5.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.12

    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.12.12

    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 769de4604c..247964851c 100644 --- a/functions/v5.isRedisInstance.html +++ b/functions/v5.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.12

    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.12.12

    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 54af72e659..cd69b51802 100644 --- a/functions/v5.isRedisVersionLowerThan.html +++ b/functions/v5.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.12

    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.12.12

    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 3a2f7a1d6f..8864e8fa39 100644 --- a/functions/v5.lengthInUtf8Bytes.html +++ b/functions/v5.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ lengthInUtf8Bytes | bullmq - v5.12.12

    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.parseObjectValues.html b/functions/v5.parseObjectValues.html index c92e30c4b0..3fef10c7b4 100644 --- a/functions/v5.parseObjectValues.html +++ b/functions/v5.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.12

    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.12.12

    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 d781e27d26..f9911d9b33 100644 --- a/functions/v5.raw2NextJobData.html +++ b/functions/v5.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.12

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 52d50efac6..af43842ba3 100644 --- a/functions/v5.removeAllQueueData.html +++ b/functions/v5.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.12

    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.12.12

    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.toString.html b/functions/v5.toString.html index 954f3b21b4..dd65fa0f0c 100644 --- a/functions/v5.toString.html +++ b/functions/v5.toString.html @@ -1 +1 @@ -toString | bullmq - v5.12.12

    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.12.12

    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.tryCatch.html b/functions/v5.tryCatch.html index 045c0ffe37..d5dfdc9eb3 100644 --- a/functions/v5.tryCatch.html +++ b/functions/v5.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.12

    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.12.12

    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 9f4d05d268..230fe37a61 100644 --- a/interfaces/v5.AddChildrenOpts.html +++ b/interfaces/v5.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.12

    Interface AddChildrenOpts

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

    Properties

    multi +AddChildrenOpts | bullmq - v5.12.12

    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 56e7689ed3..03263df5e0 100644 --- a/interfaces/v5.AddNodeOpts.html +++ b/interfaces/v5.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.12

    Interface AddNodeOpts

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

    Properties

    multi +AddNodeOpts | bullmq - v5.12.12

    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 bf87c2a701..3c992a4fda 100644 --- a/interfaces/v5.AdvancedOptions.html +++ b/interfaces/v5.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.12.12

    Interface AdvancedOptions

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

    Hierarchy (view full)

    Properties

    backoffStrategy? +AdvancedOptions | bullmq - v5.12.12

    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 f096b228aa..bf6c56424f 100644 --- a/interfaces/v5.AdvancedRepeatOptions.html +++ b/interfaces/v5.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.12.12

    Interface AdvancedRepeatOptions

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

    Hierarchy (view full)

    Properties

    repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.12.12

    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.BackoffOptions.html b/interfaces/v5.BackoffOptions.html index eccfbee4c0..6ca0bd6442 100644 --- a/interfaces/v5.BackoffOptions.html +++ b/interfaces/v5.BackoffOptions.html @@ -1,7 +1,7 @@ BackoffOptions | bullmq - v5.12.12

    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 956cacb4b0..b53a79014f 100644 --- a/interfaces/v5.BaseJobOptions.html +++ b/interfaces/v5.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.12

    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.12.12

    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,41 +17,41 @@

    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 1 (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 1 (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.

    -

    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 1d15134ca0..7e199b3751 100644 --- a/interfaces/v5.BaseOptions.html +++ b/interfaces/v5.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.12

    Interface BaseOptions

    interface BaseOptions {
        skipVersionCheck?: boolean;
    }

    Properties

    skipVersionCheck? -

    Properties

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +BaseOptions | bullmq - v5.12.12

    Interface BaseOptions

    interface BaseOptions {
        skipVersionCheck?: boolean;
    }

    Properties

    skipVersionCheck? +

    Properties

    Optional skipVersionCheck

    skipVersionCheck?: boolean

    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 49898e609a..07e21aa75f 100644 --- a/interfaces/v5.BuiltInStrategies.html +++ b/interfaces/v5.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.12

    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.12.12

    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 209f02cf62..aecc5b4a38 100644 --- a/interfaces/v5.ChildMessage.html +++ b/interfaces/v5.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.12

    Interface ChildMessage

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

    Properties

    cmd +ChildMessage | bullmq - v5.12.12

    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.DebounceOptions.html b/interfaces/v5.DebounceOptions.html index 54b0abf7f4..8755019f09 100644 --- a/interfaces/v5.DebounceOptions.html +++ b/interfaces/v5.DebounceOptions.html @@ -1,6 +1,6 @@ DebounceOptions | bullmq - v5.12.12

    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 1ffcc0c830..c597f8c661 100644 --- a/interfaces/v5.DefaultJobOptions.html +++ b/interfaces/v5.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.12

    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.12.12

    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,31 +12,31 @@

    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 1 (highest priority) to 2 097 152 (lowest priority). Note that +

    Optional priority

    priority?: number

    Ranges from 1 (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.

    -

    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 c733d877d9..f2f55d62ff 100644 --- a/interfaces/v5.DependenciesOpts.html +++ b/interfaces/v5.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.12

    Interface DependenciesOpts

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

    Properties

    processed? +DependenciesOpts | bullmq - v5.12.12

    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 97e17e5300..30a0dee124 100644 --- a/interfaces/v5.FlowJobBase.html +++ b/interfaces/v5.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.12

    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.12.12

    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 8446c482ee..e40ee39a1b 100644 --- a/interfaces/v5.FlowOpts.html +++ b/interfaces/v5.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.12

    Interface FlowOpts

    interface FlowOpts {
        queuesOptions: FlowQueuesOpts;
    }

    Properties

    queuesOptions +FlowOpts | bullmq - v5.12.12

    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 f252bb169f..6d467469b8 100644 --- a/interfaces/v5.FlowProducerListener.html +++ b/interfaces/v5.FlowProducerListener.html @@ -1,11 +1,11 @@ -FlowProducerListener | bullmq - v5.12.12

    Interface FlowProducerListener

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

    Hierarchy (view full)

    Properties

    error +FlowProducerListener | bullmq - v5.12.12

    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 9d59baed57..92cdac6025 100644 --- a/interfaces/v5.GetNextJobOptions.html +++ b/interfaces/v5.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.12

    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.12.12

    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 93be4a5377..c834a53123 100644 --- a/interfaces/v5.IConnection.html +++ b/interfaces/v5.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.12

    Interface IConnection

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

    Hierarchy

    • EventEmitter
      • IConnection

    Properties

    client +IConnection | bullmq - v5.12.12

    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 e36fa24170..027469f9a3 100644 --- a/interfaces/v5.IoredisListener.html +++ b/interfaces/v5.IoredisListener.html @@ -1,6 +1,6 @@ -IoredisListener | bullmq - v5.12.12

    Interface IoredisListener

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

    Hierarchy (view full)

    Properties

    ioredis:close +IoredisListener | bullmq - v5.12.12

    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 59f82d74fa..ce7e057fbe 100644 --- a/interfaces/v5.JobJson.html +++ b/interfaces/v5.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.12

    Interface JobJson

    interface JobJson {
        attemptsMade: number;
        attemptsStarted: number;
        data: string;
        debounceId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        name: 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.12.12

    Interface JobJson

    interface JobJson {
        attemptsMade: number;
        attemptsStarted: number;
        data: string;
        debounceId?: string;
        failedReason: string;
        finishedOn?: number;
        id: string;
        name: 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? @@ -16,4 +16,4 @@ returnvalue stacktrace timestamp -

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: string

    Optional debounceId

    debounceId?: string

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    name

    name: 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

    failedReason

    failedReason: string

    Optional finishedOn

    finishedOn?: number

    id

    id: string

    name

    name: 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 b652f32077..43c33e7d23 100644 --- a/interfaces/v5.JobJsonRaw.html +++ b/interfaces/v5.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.12

    Interface JobJsonRaw

    interface JobJsonRaw {
        atm?: string;
        ats?: string;
        attemptsMade?: string;
        data: string;
        deid?: string;
        delay: string;
        failedReason: string;
        finishedOn?: string;
        id: string;
        name: 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.12.12

    Interface JobJsonRaw

    interface JobJsonRaw {
        atm?: string;
        ats?: string;
        attemptsMade?: string;
        data: string;
        deid?: string;
        delay: string;
        failedReason: string;
        finishedOn?: string;
        id: string;
        name: 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 @@ -18,4 +18,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

    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

    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 eaab4d4366..c134307313 100644 --- a/interfaces/v5.JobNode.html +++ b/interfaces/v5.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.12

    Interface JobNode

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

    Properties

    children? +JobNode | bullmq - v5.12.12

    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.KeepJobs.html b/interfaces/v5.KeepJobs.html index 5699211c08..20aa998d48 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 13472d0b72..77fca9c5d6 100644 --- a/interfaces/v5.Metrics.html +++ b/interfaces/v5.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.12

    Interface Metrics

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

    Properties

    count +Metrics | bullmq - v5.12.12

    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 c3bfeb595c..0570291948 100644 --- a/interfaces/v5.MetricsOptions.html +++ b/interfaces/v5.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.12

    Interface MetricsOptions

    interface MetricsOptions {
        maxDataPoints?: number;
    }

    Properties

    maxDataPoints? +MetricsOptions | bullmq - v5.12.12

    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 50c9a87bb4..2719c02e1d 100644 --- a/interfaces/v5.MinimalJob.html +++ b/interfaces/v5.MinimalJob.html @@ -1,5 +1,5 @@ MinimalJob | bullmq - v5.12.12

    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 745ab23c5c..c5d20a5311 100644 --- a/interfaces/v5.MoveToDelayedOpts.html +++ b/interfaces/v5.MoveToDelayedOpts.html @@ -1,2 +1,2 @@ -MoveToDelayedOpts | bullmq - v5.12.12

    Interface MoveToDelayedOpts

    interface MoveToDelayedOpts {
        skipAttempt?: boolean;
    }

    Properties

    skipAttempt? -

    Properties

    Optional skipAttempt

    skipAttempt?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +MoveToDelayedOpts | bullmq - v5.12.12

    Interface MoveToDelayedOpts

    interface MoveToDelayedOpts {
        skipAttempt?: boolean;
    }

    Properties

    skipAttempt? +

    Properties

    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 2c181c3bd8..483aee255b 100644 --- a/interfaces/v5.MoveToWaitingChildrenOpts.html +++ b/interfaces/v5.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.12

    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.12.12

    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 3c97a068af..cc61ae647c 100644 --- a/interfaces/v5.NodeOpts.html +++ b/interfaces/v5.NodeOpts.html @@ -1,11 +1,11 @@ -NodeOpts | bullmq - v5.12.12

    Interface NodeOpts

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

    Properties

    depth? +NodeOpts | bullmq - v5.12.12

    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 86545fb1db..9620a3a855 100644 --- a/interfaces/v5.ObliterateOpts.html +++ b/interfaces/v5.ObliterateOpts.html @@ -1,9 +1,9 @@ -ObliterateOpts | bullmq - v5.12.12

    Interface ObliterateOpts

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

    Properties

    count? +ObliterateOpts | bullmq - v5.12.12

    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 4bfb435b54..ac45bc8991 100644 --- a/interfaces/v5.Parent.html +++ b/interfaces/v5.Parent.html @@ -1,7 +1,7 @@ Parent | bullmq - v5.12.12

    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 5c932031e7..82bb7a53d2 100644 --- a/interfaces/v5.ParentKeys.html +++ b/interfaces/v5.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.12

    Interface ParentKeys

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

    Properties

    id +ParentKeys | bullmq - v5.12.12

    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 b144baa4cf..828efdf40a 100644 --- a/interfaces/v5.ParentMessage.html +++ b/interfaces/v5.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.12

    Interface ParentMessage

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

    Properties

    cmd +ParentMessage | bullmq - v5.12.12

    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 d85b4621d5..508f73f5ad 100644 --- a/interfaces/v5.QueueBaseOptions.html +++ b/interfaces/v5.QueueBaseOptions.html @@ -1,12 +1,12 @@ QueueBaseOptions | bullmq - v5.12.12

    Interface QueueBaseOptions

    Base Queue options

    -
    interface QueueBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface QueueBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection prefix? skipVersionCheck?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    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.

    +

    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
    -

    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.QueueEventsListener.html b/interfaces/v5.QueueEventsListener.html index 42d6bae74b..36d8e8f389 100644 --- a/interfaces/v5.QueueEventsListener.html +++ b/interfaces/v5.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.12

    Interface QueueEventsListener

    interface QueueEventsListener {
        active: ((args, id) => void);
        added: ((args, id) => void);
        cleaned: ((args, id) => void);
        completed: ((args, id) => void);
        debounced: ((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.12.12

    Interface QueueEventsListener

    interface QueueEventsListener {
        active: ((args, id) => void);
        added: ((args, id) => void);
        cleaned: ((args, id) => void);
        completed: ((args, id) => void);
        debounced: ((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 @@ -21,27 +21,27 @@

    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.

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

    Type declaration

      • (args, id): void

      • Listen to 'debounced' event.

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

        -

        Parameters

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

        Returns void

    delayed

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

    Listen to 'delayed' event.

    +

    Parameters

    • args: {
          debounceId: string;
          jobId: string;
      }
      • debounceId: 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.

    @@ -49,27 +49,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 @@ -79,21 +79,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.

    @@ -101,12 +101,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 7b075a377d..06db3dab69 100644 --- a/interfaces/v5.QueueEventsOptions.html +++ b/interfaces/v5.QueueEventsOptions.html @@ -1,5 +1,5 @@ QueueEventsOptions | bullmq - v5.12.12

    Interface QueueEventsOptions

    Options for QueueEvents

    -
    interface QueueEventsOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        blockingTimeout?: number;
        connection: ConnectionOptions;
        lastEventId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    autorun? +
    interface QueueEventsOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        blockingTimeout?: number;
        connection: ConnectionOptions;
        lastEventId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    autorun? blockingConnection? blockingTimeout? connection @@ -7,14 +7,14 @@ prefix? skipVersionCheck?

    Properties

    Optional autorun

    autorun?: boolean

    Condition to start listening to events at instance creation.

    -

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    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.

    +

    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
    -

    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.QueueListener.html b/interfaces/v5.QueueListener.html index c21c08092c..21bb8e107c 100644 --- a/interfaces/v5.QueueListener.html +++ b/interfaces/v5.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.12

    Interface QueueListener<DataType, ResultType, NameType>

    interface QueueListener<DataType, ResultType, NameType> {
        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

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Properties

    cleaned +QueueListener | bullmq - v5.12.12

    Interface QueueListener<DataType, ResultType, NameType>

    interface QueueListener<DataType, ResultType, NameType> {
        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

    • DataType
    • ResultType
    • NameType extends string

    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

        Returns void

    removed

    removed: ((job) => void)

    Listen to 'removed' event.

    +

    Parameters

    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 e567695bb3..5028b0efd3 100644 --- a/interfaces/v5.QueueOptions.html +++ b/interfaces/v5.QueueOptions.html @@ -1,5 +1,5 @@ QueueOptions | bullmq - v5.12.12

    Interface QueueOptions

    Options for the Queue class.

    -
    interface QueueOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        defaultJobOptions?: DefaultJobOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
        streams?: {
            events: {
                maxLen: number;
            };
        };
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface QueueOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        defaultJobOptions?: DefaultJobOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
        streams?: {
            events: {
                maxLen: number;
            };
        };
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection defaultJobOptions? prefix? @@ -7,12 +7,12 @@ skipVersionCheck? streams?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    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

    Optional skipVersionCheck

    skipVersionCheck?: boolean

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

    +

    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

    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.

        -

    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.RateLimiterOptions.html b/interfaces/v5.RateLimiterOptions.html index 3d19b6294c..530149c45e 100644 --- a/interfaces/v5.RateLimiterOptions.html +++ b/interfaces/v5.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.12

    Interface RateLimiterOptions

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

    Properties

    duration +RateLimiterOptions | bullmq - v5.12.12

    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 62ba434635..682b8fc2aa 100644 --- a/interfaces/v5.RawCommand.html +++ b/interfaces/v5.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.12

    Interface RawCommand

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

    Properties

    content +RawCommand | bullmq - v5.12.12

    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 41f224f67f..a4c154e56a 100644 --- a/interfaces/v5.RepeatBaseOptions.html +++ b/interfaces/v5.RepeatBaseOptions.html @@ -1,13 +1,13 @@ RepeatBaseOptions | bullmq - v5.12.12

    Interface RepeatBaseOptions

    Options for the Repeat class.

    -
    interface RepeatBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? +
    interface RepeatBaseOptions {
        blockingConnection?: boolean;
        connection: ConnectionOptions;
        prefix?: string;
        settings?: AdvancedRepeatOptions;
        skipVersionCheck?: boolean;
    }

    Hierarchy (view full)

    Properties

    blockingConnection? connection prefix? settings? skipVersionCheck?

    Properties

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    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.

    +

    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
    -

    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.RepeatOptions.html b/interfaces/v5.RepeatOptions.html index cdcaabe8b9..a3dcedf960 100644 --- a/interfaces/v5.RepeatOptions.html +++ b/interfaces/v5.RepeatOptions.html @@ -1,6 +1,6 @@ RepeatOptions | bullmq - v5.12.12

    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,14 +10,14 @@ 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 every settings)

    -

    Optional jobId

    jobId?: string

    Optional key

    key?: string

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

    Optional jobId

    jobId?: string

    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

    Optional pattern

    pattern?: string

    A repeat pattern

    -

    Optional prevMillis

    prevMillis?: number

    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

    Optional pattern

    pattern?: string

    A repeat pattern

    +

    Optional prevMillis

    prevMillis?: number

    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 59d793ad7b..98f6ab4594 100644 --- a/interfaces/v5.SandboxedJob.html +++ b/interfaces/v5.SandboxedJob.html @@ -1,5 +1,5 @@ SandboxedJob | bullmq - v5.12.12

    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;
        failedReason: string;
        finishedOn?: number;
        id: string;
        log: ((row) => void);
        moveToDelayed: ((timestamp, token?) => Promise<void>);
        name: 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;
        failedReason: string;
        finishedOn?: number;
        id: string;
        log: ((row) => void);
        moveToDelayed: ((timestamp, token?) => Promise<void>);
        name: 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? @@ -24,4 +24,4 @@ timestamp updateData updateProgress -

    Properties

    attemptsMade

    attemptsMade: number

    attemptsStarted

    attemptsStarted: number

    data

    data: T

    Optional debounceId

    debounceId?: 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

    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

    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

    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.WorkerListener.html b/interfaces/v5.WorkerListener.html index 74821f1336..b4884fc868 100644 --- a/interfaces/v5.WorkerListener.html +++ b/interfaces/v5.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.12

    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.12.12

    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 b6da62c869..d282a383a6 100644 --- a/interfaces/v5.WorkerOptions.html +++ b/interfaces/v5.WorkerOptions.html @@ -1,5 +1,5 @@ WorkerOptions | bullmq - v5.12.12

    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;
        useWorkerThreads?: boolean;
    }

    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;
        useWorkerThreads?: boolean;
    }

    Hierarchy (view full)

    Properties

    autorun? blockingConnection? concurrency? connection @@ -23,67 +23,67 @@

    Properties

    Optional autorun

    autorun?: boolean

    Condition to start processor at instance creation.

    Default

    true
    -

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    -

    Optional concurrency

    concurrency?: number

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

    Optional blockingConnection

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    +

    Optional concurrency

    concurrency?: number

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

    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 useWorkerThreads

    useWorkerThreads?: boolean

    Use Worker Threads instead of Child Processes. +

    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
    -

    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.BackoffStrategy.html b/types/v5.BackoffStrategy.html index b20dbefee6..2897920643 100644 --- a/types/v5.BackoffStrategy.html +++ b/types/v5.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.12.12

    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.12.12

    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 bba27a7a5f..03bea395c2 100644 --- a/types/v5.BulkJobOptions.html +++ b/types/v5.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.12.12

    Type alias BulkJobOptions

    BulkJobOptions: Omit<JobsOptions, "repeat">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 d27b41bc6c..8f88d8a8c5 100644 --- a/types/v5.ClusterOptions.html +++ b/types/v5.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.12.12

    Type alias ClusterOptions

    ClusterOptions: IORedis.ClusterOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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.ConnectionOptions.html b/types/v5.ConnectionOptions.html index f73135a82d..da4baec7b1 100644 --- a/types/v5.ConnectionOptions.html +++ b/types/v5.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.12.12

    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.12.12

    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 c00e5b70aa..8624797b6f 100644 --- a/types/v5.EntryId.html +++ b/types/v5.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.12.12

    Type alias EntryId

    EntryId: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 e3ff2fd7c7..0ac6ad1c0c 100644 --- a/types/v5.EntryRaw.html +++ b/types/v5.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.12.12

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]

    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 de2395347c..21af6f928c 100644 --- a/types/v5.FinishedPropValAttribute.html +++ b/types/v5.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.12.12

    Type alias FinishedPropValAttribute

    FinishedPropValAttribute: "returnvalue" | "failedReason"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 322aaa807b..29a2ebccac 100644 --- a/types/v5.FinishedStatus.html +++ b/types/v5.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.12.12

    Type alias FinishedStatus

    FinishedStatus: "completed" | "failed"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 93c0b3c2a7..3d3cc32bb2 100644 --- a/types/v5.FlowChildJob.html +++ b/types/v5.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.12.12

    Type alias FlowChildJob

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 4582fccc5d..32b08dcaea 100644 --- a/types/v5.FlowJob.html +++ b/types/v5.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.12.12

    Type alias FlowJob

    FlowJob: FlowJobBase<JobsOptions>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 dab1b53180..35e6f29315 100644 --- a/types/v5.FlowQueuesOpts.html +++ b/types/v5.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.12.12

    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.12.12

    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 103afb5738..b2553a18d4 100644 --- a/types/v5.JobData.html +++ b/types/v5.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.12.12

    Type alias JobData

    JobData: [JobJsonRaw | number, string?]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 4d5245e8db..bc0a293870 100644 --- a/types/v5.JobJsonSandbox.html +++ b/types/v5.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.12.12

    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.12.12

    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.JobState.html b/types/v5.JobState.html index 90e3395b53..19dd983206 100644 --- a/types/v5.JobState.html +++ b/types/v5.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.12.12

    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.12.12

    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 4fb6980003..a45dd6ef32 100644 --- a/types/v5.JobType.html +++ b/types/v5.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.12.12

    Type alias JobType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 2c6631890a..ae2331a835 100644 --- a/types/v5.JobsOptions.html +++ b/types/v5.JobsOptions.html @@ -2,4 +2,4 @@
  • Optional failParentOnFailure?: boolean

    If true, moves parent to failed.

  • Optional ignoreDependencyOnFailure?: boolean

    If true, moves the jobId from its parent dependencies to failed dependencies when it fails after all attempts.

  • Optional removeDependencyOnFailure?: boolean

    If true, removes the job from its parent dependencies when it fails after all attempts.

    -

    • 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.KeysMap.html b/types/v5.KeysMap.html index b6514c7b5f..5218da831e 100644 --- a/types/v5.KeysMap.html +++ b/types/v5.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.12.12

    Type alias KeysMap

    KeysMap: {
        [index in string]: string
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 6125b12eb3..d470b36147 100644 --- a/types/v5.MinimalQueue.html +++ b/types/v5.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.12.12

    Type alias MinimalQueue

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias MinimalQueue

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

    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 f453cc91f7..cf6f94fd3b 100644 --- a/types/v5.ParentOpts.html +++ b/types/v5.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.12.12

    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.12.12

    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 0c5846fcf1..16e74a4c85 100644 --- a/types/v5.Processor.html +++ b/types/v5.Processor.html @@ -1,2 +1,2 @@ Processor | bullmq - v5.12.12

    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 5e8b75fdc8..07cf1af3c7 100644 --- a/types/v5.RedisClient.html +++ b/types/v5.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.12.12

    Type alias RedisClient

    RedisClient: Redis | Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RedisClient | bullmq - v5.12.12

    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 703de05582..8d4c95f9d9 100644 --- a/types/v5.RedisJobOptions.html +++ b/types/v5.RedisJobOptions.html @@ -4,4 +4,4 @@
  • Optional idof?: boolean

    If true, moves the jobId from its parent dependencies to failed dependencies when it fails after all attempts.

  • Optional kl?: number

    Maximum amount of log entries that will be preserved

  • Optional rdof?: boolean

    If true, removes the job from its parent dependencies when it fails after all attempts.

    -

    • 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 06027f37ce..5a4320c4a6 100644 --- a/types/v5.RedisOptions.html +++ b/types/v5.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.12.12

    Type alias RedisOptions

    RedisOptions: IORedis.RedisOptions & BaseOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RedisOptions | bullmq - v5.12.12

    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 d1faa450c3..eaf393a2c3 100644 --- a/types/v5.RepeatStrategy.html +++ b/types/v5.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.12.12

    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.12.12

    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 ccf39d6640..b42aa8cb14 100644 --- a/types/v5.RepeatableJob.html +++ b/types/v5.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.12.12

    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
    • next: number
    • pattern: string | null
    • tz: string | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RepeatableJob | bullmq - v5.12.12

    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
    • 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 a3c0263b8f..4cbd98c429 100644 --- a/types/v5.RepeatableOptions.html +++ b/types/v5.RepeatableOptions.html @@ -1 +1 @@ -RepeatableOptions | bullmq - v5.12.12

    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.12.12

    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 46c6af01eb..2e26591a91 100644 --- a/types/v5.SandboxedJobProcessor.html +++ b/types/v5.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ SandboxedJobProcessor | bullmq - v5.12.12

    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 12878fee6e..c86e47544b 100644 --- a/types/v5.StreamName.html +++ b/types/v5.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.12.12

    Type alias StreamName

    StreamName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StreamName | bullmq - v5.12.12

    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 5706f1fd2d..cc213b084e 100644 --- a/types/v5.StreamReadRaw.html +++ b/types/v5.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.12.12

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StreamReadRaw | bullmq - v5.12.12

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

    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 dc5edd462d..3e4b568c2a 100644 --- a/variables/v5.DELAY_TIME_1.html +++ b/variables/v5.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.12

    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.12.12

    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 9613df5cb7..6ee8123f98 100644 --- a/variables/v5.DELAY_TIME_5.html +++ b/variables/v5.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.12

    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.12.12

    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 a4363e15e9..c648c42a65 100644 --- a/variables/v5.PRIORITY_LIMIT.html +++ b/variables/v5.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.12.12

    Variable PRIORITY_LIMITConst

    PRIORITY_LIMIT: number = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PRIORITY_LIMIT | bullmq - v5.12.12

    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 ff0f1b130d..185e6adfb3 100644 --- a/variables/v5.QUEUE_EVENT_SUFFIX.html +++ b/variables/v5.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.12

    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.12.12

    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 3ca63af2b8..78c73a075c 100644 --- a/variables/v5.RATE_LIMIT_ERROR.html +++ b/variables/v5.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.12.12

    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.12.12

    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.clientCommandMessageReg.html b/variables/v5.clientCommandMessageReg.html index 8dc5219ec7..06e98644b2 100644 --- a/variables/v5.clientCommandMessageReg.html +++ b/variables/v5.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.12

    Variable clientCommandMessageRegConst

    clientCommandMessageReg: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.12

    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 de4abef493..faeafc177c 100644 --- a/variables/v5.errorObject.html +++ b/variables/v5.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.12

    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.12.12

    Variable errorObjectConst

    errorObject: {
        [index: string]: any;
    } = ...

    Type declaration

    • [index: string]: any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file