From 3d63631de441cf82e269363c9c6a726cfa215c8b Mon Sep 17 00:00:00 2001 From: roggervalf Date: Thu, 26 Oct 2023 02:25:47 +0000 Subject: [PATCH] deploy: 308db7f58758a72b8abb272da8e92509813a2178 --- classes/v4.AsyncFifoQueue.html | 16 +-- classes/v4.Backoffs.html | 8 +- classes/v4.ChildPool.html | 22 ++-- classes/v4.ChildProcessor.html | 18 +-- classes/v4.DelayedError.html | 4 +- classes/v4.FlowProducer.html | 34 ++--- classes/v4.Job.html | 114 ++++++++-------- classes/v4.Queue.html | 130 +++++++++---------- classes/v4.QueueBase.html | 28 ++-- classes/v4.QueueEvents.html | 36 ++--- classes/v4.QueueGetters.html | 80 ++++++------ classes/v4.QueueKeys.html | 12 +- classes/v4.RedisConnection.html | 22 ++-- classes/v4.Repeat.html | 38 +++--- classes/v4.ScriptLoader.html | 20 +-- classes/v4.ScriptLoaderError.html | 10 +- classes/v4.Scripts.html | 74 +++++------ classes/v4.UnrecoverableError.html | 4 +- classes/v4.WaitingChildrenError.html | 4 +- classes/v4.Worker.html | 62 ++++----- enums/v4.ChildCommand.html | 8 +- enums/v4.ClientType.html | 6 +- enums/v4.ErrorCode.html | 14 +- enums/v4.MetricsTime.html | 18 +-- enums/v4.ParentCommand.html | 20 +-- functions/v4.array2obj.html | 2 +- functions/v4.asyncSend.html | 2 +- functions/v4.childSend.html | 2 +- functions/v4.delay.html | 2 +- functions/v4.errorToJSON.html | 2 +- functions/v4.getNextMillis.html | 2 +- functions/v4.getParentKey.html | 2 +- functions/v4.isEmpty.html | 2 +- functions/v4.isNotConnectionError.html | 2 +- functions/v4.isRedisCluster.html | 2 +- functions/v4.isRedisInstance.html | 2 +- functions/v4.isRedisVersionLowerThan.html | 2 +- functions/v4.lengthInUtf8Bytes.html | 2 +- functions/v4.parseObjectValues.html | 2 +- functions/v4.raw2NextJobData.html | 2 +- functions/v4.removeAllQueueData.html | 2 +- functions/v4.tryCatch.html | 2 +- interfaces/v4.AddChildrenOpts.html | 10 +- interfaces/v4.AddNodeOpts.html | 10 +- interfaces/v4.AdvancedOptions.html | 8 +- interfaces/v4.AdvancedRepeatOptions.html | 6 +- interfaces/v4.BackoffOptions.html | 6 +- interfaces/v4.BaseJobOptions.html | 34 ++--- interfaces/v4.BaseOptions.html | 4 +- interfaces/v4.BuiltInStrategies.html | 2 +- interfaces/v4.ChildMessage.html | 8 +- interfaces/v4.Command.html | 6 +- interfaces/v4.DefaultJobOptions.html | 24 ++-- interfaces/v4.DependenciesOpts.html | 6 +- interfaces/v4.FlowJobBase.html | 14 +- interfaces/v4.FlowOpts.html | 4 +- interfaces/v4.FlowProducerListener.html | 6 +- interfaces/v4.GetNextJobOptions.html | 4 +- interfaces/v4.IConnection.html | 6 +- interfaces/v4.IoredisListener.html | 4 +- interfaces/v4.JobJson.html | 32 ++--- interfaces/v4.JobJsonRaw.html | 34 ++--- interfaces/v4.JobNode.html | 6 +- interfaces/v4.KeepJobs.html | 6 +- interfaces/v4.Metrics.html | 8 +- interfaces/v4.MetricsOptions.html | 4 +- interfaces/v4.MinimalJob.html | 50 +++---- interfaces/v4.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v4.NodeOpts.html | 12 +- interfaces/v4.ObliterateOpts.html | 6 +- interfaces/v4.Parent.html | 12 +- interfaces/v4.ParentKeys.html | 6 +- interfaces/v4.ParentMessage.html | 10 +- interfaces/v4.QueueBaseOptions.html | 12 +- interfaces/v4.QueueEventsListener.html | 38 +++--- interfaces/v4.QueueEventsOptions.html | 18 +-- interfaces/v4.QueueListener.html | 18 +-- interfaces/v4.QueueOptions.html | 18 +-- interfaces/v4.RateLimiterOptions.html | 6 +- interfaces/v4.RawCommand.html | 8 +- interfaces/v4.RepeatBaseOptions.html | 14 +- interfaces/v4.RepeatOptions.html | 18 +-- interfaces/v4.SandboxedJob.html | 42 +++--- interfaces/v4.ScriptMetadata.html | 14 +- interfaces/v4.WorkerListener.html | 28 ++-- interfaces/v4.WorkerOptions.html | 44 +++---- types/v4.BackoffStrategy.html | 2 +- types/v4.BulkJobOptions.html | 2 +- types/v4.ClusterOptions.html | 2 +- types/v4.ConnectionOptions.html | 2 +- types/v4.EntryId.html | 2 +- types/v4.EntryRaw.html | 2 +- types/v4.FinishedPropValAttribute.html | 2 +- types/v4.FinishedStatus.html | 2 +- types/v4.FlowChildJob.html | 2 +- types/v4.FlowJob.html | 2 +- types/v4.FlowQueuesOpts.html | 2 +- types/v4.JobData.html | 2 +- types/v4.JobJsonSandbox.html | 2 +- types/v4.JobState.html | 2 +- types/v4.JobType.html | 2 +- types/v4.JobsOptions.html | 2 +- types/v4.KeysMap.html | 2 +- types/v4.MinimalQueue.html | 2 +- types/v4.ParentOpts.html | 2 +- types/v4.Processor.html | 2 +- types/v4.RedisClient.html | 2 +- types/v4.RedisJobOptions.html | 2 +- types/v4.RedisOptions.html | 2 +- types/v4.RepeatStrategy.html | 2 +- types/v4.SandboxedJobProcessor.html | 2 +- types/v4.StreamName.html | 2 +- types/v4.StreamReadRaw.html | 2 +- variables/v4.DELAY_TIME_1.html | 2 +- variables/v4.DELAY_TIME_5.html | 2 +- variables/v4.PRIORITY_LIMIT.html | 2 +- variables/v4.QUEUE_EVENT_SUFFIX.html | 2 +- variables/v4.WORKER_SUFFIX.html | 2 +- variables/v4.clientCommandMessageReg.html | 2 +- variables/v4.errorObject.html | 2 +- variables/v4.scriptLoader-1.html | 2 +- 121 files changed, 768 insertions(+), 768 deletions(-) diff --git a/classes/v4.AsyncFifoQueue.html b/classes/v4.AsyncFifoQueue.html index 2bec3a916a..9b83a8fb8c 100644 --- a/classes/v4.AsyncFifoQueue.html +++ b/classes/v4.AsyncFifoQueue.html @@ -37,7 +37,7 @@

Hierarchy

+
  • Defined in classes/async-fifo-queue.ts:13
    • @@ -75,7 +75,7 @@

    Parameters

    ignoreErrors: boolean = false

    Returns AsyncFifoQueue<T>

    +
  • Defined in classes/async-fifo-queue.ts:21

    • Methods

    @@ -90,7 +90,7 @@

    Parameters

    promise: Promise<T>

    Returns void

    +
  • Defined in classes/async-fifo-queue.ts:25

    • fetch

    +
  • Defined in classes/async-fifo-queue.ts:84

    • numPending

    +
  • Defined in classes/async-fifo-queue.ts:55

    • numQueued

    +
  • Defined in classes/async-fifo-queue.ts:59

    • numTotal

    +
  • Defined in classes/async-fifo-queue.ts:51

    • waitAll

    +
  • Defined in classes/async-fifo-queue.ts:47
    • diff --git a/classes/v4.Backoffs.html b/classes/v4.Backoffs.html index a2ee177673..da49f58c41 100644 --- a/classes/v4.Backoffs.html +++ b/classes/v4.Backoffs.html @@ -21,7 +21,7 @@

    Hierarchy

    • Backoffs
    +
  • Defined in classes/backoffs.ts:8
    • @@ -54,7 +54,7 @@

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...
    +
  • Defined in classes/backoffs.ts:9

    • Methods

    @@ -77,7 +77,7 @@
    job: Optional customStrategy: BackoffStrategy
    Optional

    Returns number | Promise<number>

    +
  • Defined in classes/backoffs.ts:36

    • Static normalize

    Returns BackoffOptions

    +
  • Defined in classes/backoffs.ts:23
    • diff --git a/classes/v4.ChildPool.html b/classes/v4.ChildPool.html index b74c1e83c8..fff38ec573 100644 --- a/classes/v4.ChildPool.html +++ b/classes/v4.ChildPool.html @@ -21,7 +21,7 @@

    Hierarchy

    • ChildPool
    +
  • Defined in classes/child-pool.ts:11
    • @@ -60,7 +60,7 @@

    Parameters

    __namedParameters: ChildPoolOpts

    Returns ChildPool

    +
  • Defined in classes/child-pool.ts:16

    • Properties

    @@ -72,7 +72,7 @@

    Type declaration

  • [key: string]: Child[]
    • +
  • Defined in classes/child-pool.ts:13

    • retained

    retained: {
        [key: number]: Child;
    } = {}
    @@ -82,7 +82,7 @@

    Type declaration

  • [key: number]: Child
    • +
  • Defined in classes/child-pool.ts:12

    • Methods

    @@ -92,7 +92,7 @@

    clean

    Returns Promise<void>

    +
  • Defined in classes/child-pool.ts:72

    • getAllFree

    +
  • Defined in classes/child-pool.ts:84

    • getFree

    Returns Child[]

    +
  • Defined in classes/child-pool.ts:80

    • kill

    Returns Promise<void>

    +
  • Defined in classes/child-pool.ts:64

    • release

    Returns void

    +
  • Defined in classes/child-pool.ts:48

    • remove

    Returns void

    +
  • Defined in classes/child-pool.ts:53

    • retain

    Returns Promise<Child>

    +
  • Defined in classes/child-pool.ts:23
    • diff --git a/classes/v4.ChildProcessor.html b/classes/v4.ChildProcessor.html index de4740cded..833a1b5c6f 100644 --- a/classes/v4.ChildProcessor.html +++ b/classes/v4.ChildProcessor.html @@ -27,7 +27,7 @@

    Hierarchy

    • ChildProcessor
    +
  • Defined in classes/child-processor.ts:19
    • @@ -75,24 +75,24 @@
    msg: Returns Promise<void>

    Returns ChildProcessor

    +
  • Defined in classes/child-processor.ts:24

    • Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>
    +
  • Defined in classes/child-processor.ts:22

    • processor

    processor: any
    +
  • Defined in classes/child-processor.ts:21

    • Optional status

    status?: ChildStatus
    +
  • Defined in classes/child-processor.ts:20

    • Methods

    @@ -107,7 +107,7 @@

    Parameters

    processorFile: string

    Returns Promise<void>

    +
  • Defined in classes/child-processor.ts:26

    • start

    Returns Promise<void>

     +
  • Defined in classes/child-processor.ts:63

    • stop

    +
  • Defined in classes/child-processor.ts:91

    • waitForCurrentJobAndExit

    +
  • Defined in classes/child-processor.ts:93
    • diff --git a/classes/v4.DelayedError.html b/classes/v4.DelayedError.html index 1cd867933c..495e5619aa 100644 --- a/classes/v4.DelayedError.html +++ b/classes/v4.DelayedError.html @@ -29,7 +29,7 @@

    Hierarchy

    • DelayedError
    +
  • Defined in classes/delayed-error.ts:8
    • @@ -54,7 +54,7 @@
    Optional Returns DelayedError
    +
  • Defined in classes/delayed-error.ts:9
    • diff --git a/classes/v4.FlowProducer.html b/classes/v4.FlowProducer.html index cdcec357d2..2273012acf 100644 --- a/classes/v4.FlowProducer.html +++ b/classes/v4.FlowProducer.html @@ -32,7 +32,7 @@

    Hierarchy

    • FlowProducer
    +
  • Defined in classes/flow-producer.ts:92
    • @@ -83,29 +83,29 @@
    Connection: Returns FlowProducer
    +
  • Defined in classes/flow-producer.ts:100

    • Properties

    closing

    closing: Promise<void>
    +
  • Defined in classes/flow-producer.ts:95

    • keys

    keys: KeysMap
    +
  • Defined in classes/flow-producer.ts:94

    • opts

    opts: QueueBaseOptions = {}
    +
  • Defined in classes/flow-producer.ts:101

    • queueKeys

    queueKeys: QueueKeys
    +
  • Defined in classes/flow-producer.ts:96

    • toKey

    toKey: ((name, type) => string)
    @@ -125,7 +125,7 @@
    name: type: string

    Returns string

    +
  • Defined in classes/flow-producer.ts:93

    • Accessors

    @@ -135,7 +135,7 @@

    client

    Returns Promise<RedisClient>

    +
  • Defined in classes/flow-producer.ts:210

    • Methods

    @@ -162,7 +162,7 @@
    Optional Returns Promise<JobNode>
    +
  • Defined in classes/flow-producer.ts:159

    • addBulk

    +
  • Defined in classes/flow-producer.ts:235

    • close

    +
  • Defined in classes/flow-producer.ts:446

    • disconnect

    +
  • Defined in classes/flow-producer.ts:453

    • emit

    +
  • Defined in classes/flow-producer.ts:118

    • getFlow

    +
  • Defined in classes/flow-producer.ts:192

    • off

    +
  • Defined in classes/flow-producer.ts:125

    • on

    +
  • Defined in classes/flow-producer.ts:133

    • once

    +
  • Defined in classes/flow-producer.ts:141
    • diff --git a/classes/v4.Job.html b/classes/v4.Job.html index 855c12f43e..7f92b9fdbe 100644 --- a/classes/v4.Job.html +++ b/classes/v4.Job.html @@ -41,7 +41,7 @@

    Implements

    +
  • Defined in classes/job.ts:60
    • @@ -152,7 +152,7 @@
    opts: Optional id: string
    Optional

    Returns Job<DataType, ReturnType, NameType>

    +
  • Defined in classes/job.ts:148

    • Properties

    @@ -166,7 +166,7 @@

    Default Value

    0
    +
  • Defined in classes/job.ts:105

    • data

    data: DataType
    @@ -175,7 +175,7 @@

    data

    +
  • Defined in classes/job.ts:158

    • delay

    delay: number
    @@ -187,7 +187,7 @@

    Default Value

    0
    +
  • Defined in classes/job.ts:94

    • failedReason

    failedReason: string
    @@ -196,7 +196,7 @@

    failedReason

    +
  • Defined in classes/job.ts:110

    • Optional finishedOn

    finishedOn?: number
    @@ -205,13 +205,13 @@

    Optional

    +
  • Defined in classes/job.ts:115

    • Optional id

    id?: string
    +
  • Defined in classes/job.ts:164

    • name

    name: NameType
    @@ -220,7 +220,7 @@

    name

    +
  • Defined in classes/job.ts:153

    • opts

    opts: JobsOptions = {}
    @@ -229,7 +229,7 @@

    opts

    +
  • Defined in classes/job.ts:163

    • Optional parent

    parent?: ParentKeys
    @@ -238,7 +238,7 @@

    Optional

    +
  • Defined in classes/job.ts:130

    • Optional parentKey

    parentKey?: string
    @@ -247,7 +247,7 @@

    Optional

    +
  • Defined in classes/job.ts:125

    • Optional processedOn

    processedOn?: number
    @@ -256,7 +256,7 @@

    Optional

    +
  • Defined in classes/job.ts:120

    • progress

    progress: number | object = 0
    @@ -268,7 +268,7 @@

    Default Value

    0
    +
  • Defined in classes/job.ts:76

    • Readonly queueQualifiedName

    queueQualifiedName: string
    @@ -279,7 +279,7 @@

    See

    Implementation of MinimalJob.queueQualifiedName

    +
  • Defined in classes/job.ts:70

    • Optional repeatJobKey

    repeatJobKey?: string
    @@ -288,7 +288,7 @@

    Optional

    +
  • Defined in classes/job.ts:135

    • returnvalue

    returnvalue: ReturnType = null
    @@ -300,7 +300,7 @@

    Default Value

    null
    +
  • Defined in classes/job.ts:82

    • stacktrace

    stacktrace: string[] = null
    @@ -312,7 +312,7 @@

    Default Value

    null
    +
  • Defined in classes/job.ts:88

    • timestamp

    timestamp: number
    @@ -321,7 +321,7 @@

    timestamp

    +
  • Defined in classes/job.ts:99

    • Optional token

    token?: string
    @@ -329,7 +329,7 @@

    Optional

    +
  • Defined in classes/job.ts:140

    • Accessors

    @@ -342,7 +342,7 @@

    Returns string

    +
  • Defined in classes/job.ts:743

    • queueName

      @@ -353,7 +353,7 @@

      Returns string

    +
  • Defined in classes/job.ts:736

    • Methods

    @@ -373,7 +373,7 @@
    Optional Returns Promise<string>
    +
  • Defined in classes/job.ts:1095

    • asJSON

    +
  • Defined in classes/job.ts:423

    • asJSONSandbox

    +
  • Defined in classes/job.ts:465

    • changeDelay

    +
  • Defined in classes/job.ts:763

    • changePriority

    +
  • Defined in classes/job.ts:773

    • clearLogs

    +
  • Defined in classes/job.ts:510

    • discard

    +
  • Defined in classes/job.ts:1073

    • extendLock

    +
  • Defined in classes/job.ts:550

    • getChildrenValues

    +
  • Defined in classes/job.ts:785

    • getDependencies

    +
  • Defined in classes/job.ts:807

    • getDependenciesCount

    +
  • Defined in classes/job.ts:899

    • getState

    +
  • Defined in classes/job.ts:753

    • isActive

    +
  • Defined in classes/job.ts:722

    • isCompleted

    +
  • Defined in classes/job.ts:694

    • isDelayed

    +
  • Defined in classes/job.ts:708

    • isFailed

    +
  • Defined in classes/job.ts:701

    • isWaiting

    +
  • Defined in classes/job.ts:729

    • isWaitingChildren

    +
  • Defined in classes/job.ts:715

    • log

    +
  • Defined in classes/job.ts:501

    • moveToCompleted

    +
  • Defined in classes/job.ts:563

    • moveToDelayed

    +
  • Defined in classes/job.ts:1023

    • moveToFailed

    +
  • Defined in classes/job.ts:601

    • moveToWaitingChildren

    +
  • Defined in classes/job.ts:1034

    • promote

    +
  • Defined in classes/job.ts:1044

    • remove

    +
  • Defined in classes/job.ts:528

    • retry

    +
  • Defined in classes/job.ts:1061

    • toJSON

      @@ -813,7 +813,7 @@

      toJSON

      Returns Omit<Job<DataType, ReturnType, NameType>, "remove" | "prefix" | "toJSON" | "scripts" | "addJob" | "changeDelay" | "changePriority" | "extendLock" | "getState" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "updateData" | "updateProgress" | "discard" | "queue" | "asJSON" | "asJSONSandbox" | "log" | "clearLogs" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "getChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "retry">

    +
  • Defined in classes/job.ts:414

    • updateData

    +
  • Defined in classes/job.ts:478

    • updateProgress

    +
  • Defined in classes/job.ts:489

    • waitUntilFinished

    +
  • Defined in classes/job.ts:951

    • Static addJobLog

    +
  • Defined in classes/job.ts:389

    • Static create

    +
  • Defined in classes/job.ts:205

    • Static createBulk

    +
  • Defined in classes/job.ts:232

    • Static fromId

    +
  • Defined in classes/job.ts:361

    • Static fromJSON

    +
  • Defined in classes/job.ts:279
    • diff --git a/classes/v4.Queue.html b/classes/v4.Queue.html index 1067cd630b..91a5dfcac2 100644 --- a/classes/v4.Queue.html +++ b/classes/v4.Queue.html @@ -38,7 +38,7 @@

    Hierarchy

    • Queue
    +
  • Defined in classes/queue.ts:92
    • @@ -148,7 +148,7 @@
    Optional Returns Queue<DataType, ResultType, NameType>
    +
  • Defined in classes/queue.ts:101

    • Properties

    @@ -156,18 +156,18 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • jobsOpts

    jobsOpts: BaseJobOptions
    +
  • Defined in classes/queue.ts:98

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -176,7 +176,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • opts

    opts: QueueBaseOptions = {}
    @@ -185,13 +185,13 @@

    opts

    +
  • Defined in classes/queue-base.ts:36

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -210,12 +210,12 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • token

    token: string = ...
    +
  • Defined in classes/queue.ts:97

    • Accessors

    @@ -229,7 +229,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • defaultJobOptions

    +
  • Defined in classes/queue.ts:168

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • repeat

    +
  • Defined in classes/queue.ts:172

    • Methods

    @@ -288,7 +288,7 @@
    Optional Returns Promise<Job<DataType, ResultType, NameType>>
    +
  • Defined in classes/queue.ts:192

    • addBulk

    +
  • Defined in classes/queue.ts:232

    • addJobLog

    +
  • Defined in classes/queue.ts:385

    • clean

    +
  • Defined in classes/queue.ts:414

    • close

    +
  • Defined in classes/queue.ts:269

    • count

    +
  • Defined in classes/queue-getters.ts:96

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • drain

    +
  • Defined in classes/queue.ts:400

    • emit

    +
  • Defined in classes/queue.ts:134

    • getActive

    +
  • Defined in classes/queue-getters.ts:240

    • getActiveCount

    +
  • Defined in classes/queue-getters.ts:186

    • getCompleted

    +
  • Defined in classes/queue-getters.ts:276

    • getCompletedCount

    +
  • Defined in classes/queue-getters.ts:165

    • getDelayed

    +
  • Defined in classes/queue-getters.ts:252

    • getDelayedCount

    +
  • Defined in classes/queue-getters.ts:179

    • getFailed

    +
  • Defined in classes/queue-getters.ts:288

    • getFailedCount

    +
  • Defined in classes/queue-getters.ts:172

    • getJob

    +
  • Defined in classes/queue-getters.ts:26

    • getJobCountByTypes

    +
  • Defined in classes/queue-getters.ts:127

    • getJobCounts

    +
  • Defined in classes/queue-getters.ts:137

    • getJobLogs

    +
  • Defined in classes/queue-getters.ts:365

    • getJobState

    +
  • Defined in classes/queue-getters.ts:158

    • getJobs

    +
  • Defined in classes/queue-getters.ts:338

    • getMetrics

    +
  • Defined in classes/queue-getters.ts:453

    • getPrioritized

    +
  • Defined in classes/queue-getters.ts:264

    • getPrioritizedCount

    +
  • Defined in classes/queue-getters.ts:193

    • getQueueEvents

    +
  • Defined in classes/queue-getters.ts:431

    • getRanges

    +
  • Defined in classes/queue-getters.ts:295

    • getRateLimitTtl

    +
  • Defined in classes/queue-getters.ts:114

    • getRepeatableJobs

      @@ -868,7 +868,7 @@
      Optional Returns Promise<{
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>
    +
  • Defined in classes/queue.ts:305

    • getWaiting

    +
  • Defined in classes/queue-getters.ts:216

    • getWaitingChildren

    +
  • Defined in classes/queue-getters.ts:228

    • getWaitingChildrenCount

    +
  • Defined in classes/queue-getters.ts:207

    • getWaitingCount

    +
  • Defined in classes/queue-getters.ts:200

    • getWorkers

    +
  • Defined in classes/queue-getters.ts:417

    • isPaused

    +
  • Defined in classes/queue.ts:291

    • obliterate

    +
  • Defined in classes/queue.ts:447

    • off

    +
  • Defined in classes/queue.ts:141

    • on

    +
  • Defined in classes/queue.ts:149

    • once

    +
  • Defined in classes/queue.ts:157

    • pause

    +
  • Defined in classes/queue.ts:260

    • promoteJobs

    +
  • Defined in classes/queue.ts:491

    • remove

    +
  • Defined in classes/queue.ts:359

    • removeDeprecatedPriorityKey

      @@ -1127,7 +1127,7 @@

      removeDeprecatedPriorityKey<

      Returns Promise<number>

    +
  • Defined in classes/queue.ts:511

    • removeRepeatable

    +
  • Defined in classes/queue.ts:322

    • removeRepeatableByKey

    +
  • Defined in classes/queue.ts:343

    • resume

    +
  • Defined in classes/queue.ts:283

    • retryJobs

    +
  • Defined in classes/queue.ts:470

    • trimEvents

    +
  • Defined in classes/queue.ts:503

    • updateJobProgress

    +
  • Defined in classes/queue.ts:369

    • waitUntilReady

    +
  • Defined in classes/queue-base.ts:123
    • diff --git a/classes/v4.QueueBase.html b/classes/v4.QueueBase.html index 14be97addb..b487f6f808 100644 --- a/classes/v4.QueueBase.html +++ b/classes/v4.QueueBase.html @@ -37,7 +37,7 @@

    Implements

    +
  • Defined in classes/queue-base.ts:18
    • @@ -94,7 +94,7 @@
    Connection: Returns QueueBase
    +
  • Defined in classes/queue-base.ts:34

    • Properties

    @@ -102,13 +102,13 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -117,7 +117,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • opts

    opts: QueueBaseOptions = {}
    @@ -126,13 +126,13 @@

    opts

    +
  • Defined in classes/queue-base.ts:36

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -151,7 +151,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • Accessors

    @@ -165,7 +165,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • Methods

    @@ -189,7 +189,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:140

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • emit

      @@ -222,7 +222,7 @@

      Returns booleanImplementation of MinimalQueue.emit

      Overrides EventEmitter.emit

    +
  • Defined in classes/queue-base.ts:109

    • waitUntilReady

    +
  • Defined in classes/queue-base.ts:123
    • diff --git a/classes/v4.QueueEvents.html b/classes/v4.QueueEvents.html index abe5400f80..a7f6b766e5 100644 --- a/classes/v4.QueueEvents.html +++ b/classes/v4.QueueEvents.html @@ -29,7 +29,7 @@

    Hierarchy

    • QueueEvents
    +
  • Defined in classes/queue-events.ts:164
    • @@ -83,7 +83,7 @@
    Optional Returns QueueEvents
    +
  • Defined in classes/queue-events.ts:167

    • Properties

    @@ -91,13 +91,13 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -106,7 +106,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • opts

    opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@

    opts

    +
  • Defined in classes/queue-base.ts:36

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • Accessors

    @@ -154,7 +154,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • Methods

    @@ -180,7 +180,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-events.ts:304

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • emit

    +
  • Defined in classes/queue-events.ts:196

    • off

    +
  • Defined in classes/queue-events.ts:203

    • on

    +
  • Defined in classes/queue-events.ts:211

    • once

    +
  • Defined in classes/queue-events.ts:219

    • run

    +
  • Defined in classes/queue-events.ts:231

    • waitUntilReady

    +
  • Defined in classes/queue-base.ts:123
    • diff --git a/classes/v4.QueueGetters.html b/classes/v4.QueueGetters.html index ef54dfbeac..0687c7d5cc 100644 --- a/classes/v4.QueueGetters.html +++ b/classes/v4.QueueGetters.html @@ -38,7 +38,7 @@

    Hierarchy

    +
  • Defined in classes/queue-getters.ts:21
    • @@ -130,7 +130,7 @@
    Connection: Returns QueueGetters<DataType, ResultType, NameType>
    +
  • Defined in classes/queue-base.ts:34

    • Properties

    @@ -138,13 +138,13 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -153,7 +153,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • opts

    opts: QueueBaseOptions = {}
    @@ -162,13 +162,13 @@

    opts

    +
  • Defined in classes/queue-base.ts:36

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -187,7 +187,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • Accessors

    @@ -201,7 +201,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • Methods

    @@ -226,7 +226,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:140

    • count

    +
  • Defined in classes/queue-getters.ts:96

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • emit

    +
  • Defined in classes/queue-base.ts:109

    • getActive

    +
  • Defined in classes/queue-getters.ts:240

    • getActiveCount

    +
  • Defined in classes/queue-getters.ts:186

    • getCompleted

    +
  • Defined in classes/queue-getters.ts:276

    • getCompletedCount

    +
  • Defined in classes/queue-getters.ts:165

    • getDelayed

    +
  • Defined in classes/queue-getters.ts:252

    • getDelayedCount

    +
  • Defined in classes/queue-getters.ts:179

    • getFailed

    +
  • Defined in classes/queue-getters.ts:288

    • getFailedCount

    +
  • Defined in classes/queue-getters.ts:172

    • getJob

      @@ -416,7 +416,7 @@

      Parameters

      jobId: string

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

    +
  • Defined in classes/queue-getters.ts:26

    • getJobCountByTypes

    +
  • Defined in classes/queue-getters.ts:127

    • getJobCounts

    +
  • Defined in classes/queue-getters.ts:137

    • getJobLogs

    +
  • Defined in classes/queue-getters.ts:365

    • getJobState

    +
  • Defined in classes/queue-getters.ts:158

    • getJobs

    +
  • Defined in classes/queue-getters.ts:338

    • getMetrics

    +
  • Defined in classes/queue-getters.ts:453

    • getPrioritized

    +
  • Defined in classes/queue-getters.ts:264

    • getPrioritizedCount

    +
  • Defined in classes/queue-getters.ts:193

    • getQueueEvents

    +
  • Defined in classes/queue-getters.ts:431

    • getRanges

      @@ -630,7 +630,7 @@
      end: asc: boolean = false

    Returns Promise<string[]>

    +
  • Defined in classes/queue-getters.ts:295

    • getRateLimitTtl

    +
  • Defined in classes/queue-getters.ts:114

    • getWaiting

    +
  • Defined in classes/queue-getters.ts:216

    • getWaitingChildren

    +
  • Defined in classes/queue-getters.ts:228

    • getWaitingChildrenCount

    +
  • Defined in classes/queue-getters.ts:207

    • getWaitingCount

    +
  • Defined in classes/queue-getters.ts:200

    • getWorkers

    +
  • Defined in classes/queue-getters.ts:417

    • waitUntilReady

    +
  • Defined in classes/queue-base.ts:123
    • diff --git a/classes/v4.QueueKeys.html b/classes/v4.QueueKeys.html index d9131d2515..deb1c367d6 100644 --- a/classes/v4.QueueKeys.html +++ b/classes/v4.QueueKeys.html @@ -21,7 +21,7 @@

    Hierarchy

    • QueueKeys
    +
  • Defined in classes/queue-keys.ts:3
    • @@ -55,14 +55,14 @@

    Parameters

    prefix: string = 'bull'

    Returns QueueKeys

    +
  • Defined in classes/queue-keys.ts:4

    • Properties

    Readonly prefix

    prefix: string = 'bull'
    +
  • Defined in classes/queue-keys.ts:4

    • Methods

    @@ -77,7 +77,7 @@

    Parameters

    name: string

    Returns KeysMap

    +
  • Defined in classes/queue-keys.ts:6

    • getQueueQualifiedName

      @@ -90,7 +90,7 @@

      Parameters

      name: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:37

    • toKey

      @@ -105,7 +105,7 @@
      name: type: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:33
    • diff --git a/classes/v4.RedisConnection.html b/classes/v4.RedisConnection.html index 54704775b9..7bcf3cb9c3 100644 --- a/classes/v4.RedisConnection.html +++ b/classes/v4.RedisConnection.html @@ -23,7 +23,7 @@

    Hierarchy

    • RedisConnection
    +
  • Defined in classes/redis-connection.ts:31
    • @@ -72,24 +72,24 @@
    skipVersionCheck: Returns RedisConnection
    +
  • Defined in classes/redis-connection.ts:48

    • Properties

    closing

    closing: boolean
    +
  • Defined in classes/redis-connection.ts:35

    • Static minimumVersion

    minimumVersion: string = '5.0.0'
    +
  • Defined in classes/redis-connection.ts:32

    • Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'
    +
  • Defined in classes/redis-connection.ts:33

    • Accessors

    @@ -99,7 +99,7 @@

    client

    Returns Promise<RedisClient>

    +
  • Defined in classes/redis-connection.ts:156

    • redisVersion

    +
  • Defined in classes/redis-connection.ts:286

    • Methods

    @@ -117,7 +117,7 @@

    close

    Returns Promise<void>

    +
  • Defined in classes/redis-connection.ts:241

    • disconnect

    +
  • Defined in classes/redis-connection.ts:213

    • reconnect

    +
  • Defined in classes/redis-connection.ts:236

    • Static waitUntilReady

    +
  • Defined in classes/redis-connection.ts:119
    • diff --git a/classes/v4.Repeat.html b/classes/v4.Repeat.html index 963583ac59..6f88c0154e 100644 --- a/classes/v4.Repeat.html +++ b/classes/v4.Repeat.html @@ -28,7 +28,7 @@

    Hierarchy

    • Repeat
    +
  • Defined in classes/repeat.ts:9
    • @@ -83,7 +83,7 @@
    Optional Returns Repeat
    +
  • Defined in classes/repeat.ts:13

    • Properties

    @@ -91,13 +91,13 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -106,7 +106,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • opts

    opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@

    opts

    +
  • Defined in classes/queue-base.ts:36

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • Accessors

    @@ -154,7 +154,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • Methods

    @@ -196,7 +196,7 @@
    opts: Optional skipCheckExists: boolean
    Optional

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

    +
  • Defined in classes/repeat.ts:27

    • close

    +
  • Defined in classes/queue-base.ts:140

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • emit

    +
  • Defined in classes/queue-base.ts:109

    • getRepeatableCount

    +
  • Defined in classes/repeat.ts:202

    • getRepeatableJobs

      @@ -265,7 +265,7 @@
      end: asc: boolean = false

    Returns Promise<{
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[]>

    +
  • Defined in classes/repeat.ts:187

    • removeRepeatable

    Returns Promise<number>

    +
  • Defined in classes/repeat.ts:143

    • removeRepeatableByKey

      @@ -295,7 +295,7 @@

      Parameters

      repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/repeat.ts:159

    • waitUntilReady

    +
  • Defined in classes/queue-base.ts:123
    • diff --git a/classes/v4.ScriptLoader.html b/classes/v4.ScriptLoader.html index 6a81fb0c31..ec7c312115 100644 --- a/classes/v4.ScriptLoader.html +++ b/classes/v4.ScriptLoader.html @@ -25,7 +25,7 @@

    Hierarchy

    • ScriptLoader
    +
  • Defined in commands/script-loader.ts:84
    • @@ -55,7 +55,7 @@

    constructor

    Returns ScriptLoader

    +
  • Defined in commands/script-loader.ts:96

    • Methods

    @@ -81,7 +81,7 @@
    mappedPath: Returns void
    +
  • Defined in commands/script-loader.ts:110

    • clearCache

    +
  • Defined in commands/script-loader.ts:463

    • interpolate

    +
  • Defined in commands/script-loader.ts:333

    • load

    +
  • Defined in commands/script-loader.ts:435

    • loadCommand

      @@ -153,7 +153,7 @@
      filename: Optional cache: Map<string, ScriptMetadata>
      Optional

    Returns Promise<Command>

    +
  • Defined in commands/script-loader.ts:356

    • loadScripts

    +
  • Defined in commands/script-loader.ts:390

    • parseScript

    +
  • Defined in commands/script-loader.ts:305

    • resolvePath

    +
  • Defined in commands/script-loader.ts:134
    • diff --git a/classes/v4.ScriptLoaderError.html b/classes/v4.ScriptLoaderError.html index 287cc117e6..768675fd96 100644 --- a/classes/v4.ScriptLoaderError.html +++ b/classes/v4.ScriptLoaderError.html @@ -23,7 +23,7 @@

    Hierarchy

    • ScriptLoaderError
    +
  • Defined in commands/script-loader.ts:52
    • @@ -62,7 +62,7 @@
    position: Returns ScriptLoaderError
    +
  • Defined in commands/script-loader.ts:60

    • Properties

    @@ -72,17 +72,17 @@

    Readonly

    +
  • Defined in commands/script-loader.ts:56

    • Readonly line

    line: number
    +
  • Defined in commands/script-loader.ts:57

    • Readonly position

    position: number
    +
  • Defined in commands/script-loader.ts:58
    • diff --git a/classes/v4.Scripts.html b/classes/v4.Scripts.html index 4d9876ef2f..2c68365725 100644 --- a/classes/v4.Scripts.html +++ b/classes/v4.Scripts.html @@ -21,7 +21,7 @@

    Hierarchy

    • Scripts
    +
  • Defined in classes/scripts.ts:40
    • @@ -86,14 +86,14 @@

    Parameters

    queue: MinimalQueue

    Returns Scripts

    +
  • Defined in classes/scripts.ts:43

    • Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]
    +
  • Defined in classes/scripts.ts:41

    • Methods

    @@ -116,7 +116,7 @@
    jobId: parentOpts: ParentOpts = {}

    Returns Promise<string>

    +
  • Defined in classes/scripts.ts:74

    • changeDelay

      @@ -131,7 +131,7 @@
      jobId: delay: number

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:503

    • changePriority

      @@ -148,7 +148,7 @@
      priority: lifo: boolean = false

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:535

    • cleanJobsInSet

    +
  • Defined in classes/scripts.ts:701

    • drain

      @@ -182,7 +182,7 @@

      Parameters

      delayed: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:369

    • extendLock

      @@ -201,7 +201,7 @@
      duration: Optional client: ChainableCommander | RedisClient
      Optional

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:193

    • finishedErrors

      @@ -220,7 +220,7 @@
      command: Optional state: string
      Optional

    Returns Error

    +
  • Defined in classes/scripts.ts:326

    • getCounts

      @@ -233,7 +233,7 @@

      Parameters

      types: JobType[]

    Returns Promise<number[]>

    +
  • Defined in classes/scripts.ts:419

    • getRanges

      @@ -252,7 +252,7 @@
      end: asc: boolean = false

    Returns Promise<[string][]>

    +
  • Defined in classes/scripts.ts:394

    • getState

      @@ -265,7 +265,7 @@

      Parameters

      jobId: string

    Returns Promise<"unknown" | JobState>

    +
  • Defined in classes/scripts.ts:481

    • isFinished

      @@ -280,7 +280,7 @@
      jobId: returnValue: boolean = false

    Returns Promise<number | [number, string]>

    +
  • Defined in classes/scripts.ts:466

    • isJobInList

      @@ -295,7 +295,7 @@
      listKey: jobId: string

    Returns Promise<boolean>

    +
  • Defined in classes/scripts.ts:63

    • moveJobFromActiveToWait

    +
  • Defined in classes/scripts.ts:930

    • moveStalledJobsToWait

      @@ -333,7 +333,7 @@

      moveStalledJobsToWait<

      Returns Promise<[string[], string[]]>

    +
  • Defined in classes/scripts.ts:898

    • moveToActive

      @@ -348,7 +348,7 @@
      token: Optional jobId: string
      Optional

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:835

    • moveToCompletedArgs

      @@ -378,7 +378,7 @@
      token: fetchNext: boolean = false

    Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:426

    • moveToDelayed

      @@ -395,7 +395,7 @@
      timestamp: token: string = '0'

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:646

    • moveToDelayedArgs

      @@ -412,7 +412,7 @@
      timestamp: token: string

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:571

    • moveToFailedArgs

      @@ -442,7 +442,7 @@
      token: fetchNext: boolean = false

    Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:446

    • moveToFinished

      @@ -457,7 +457,7 @@
      jobId: args: (string | number | boolean | Buffer)[]

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:310

    • moveToWaitingChildren

      @@ -487,7 +487,7 @@

      Throws

      JobNotInState This exception is thrown if job is not in active state.

    +
  • Defined in classes/scripts.ts:671

    • moveToWaitingChildrenArgs

    Returns string[]

    +
  • Defined in classes/scripts.ts:623

    • obliterate

      @@ -522,7 +522,7 @@
      countforce: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:953

    • pause

      @@ -535,7 +535,7 @@

      Parameters

      pause: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:142

    • promote

      @@ -548,7 +548,7 @@

      Parameters

      jobId: string

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:871

    • promoteJobs

      @@ -561,7 +561,7 @@

      Parameters

      count: number = 1000

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:782

    • remove

      @@ -576,7 +576,7 @@
      jobId: removeChildren: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:184

    • removeRepeatable

      @@ -591,7 +591,7 @@
      repeatJobId: repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:174

    • reprocessJob

    +
  • Defined in classes/scripts.ts:803

    • retryJobArgs

      @@ -643,7 +643,7 @@
      lifo: token: string

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:718

    • retryJobs

      @@ -660,7 +660,7 @@
      count: timestamp: number = ...

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:770

    • saveStacktraceArgs

      @@ -677,7 +677,7 @@
      stacktrace: failedReason: string

    Returns string[]

    +
  • Defined in classes/scripts.ts:613

    • updateData

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:210

    • updateProgress

      @@ -725,7 +725,7 @@
      jobId: progress: number | object

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:226
    • diff --git a/classes/v4.UnrecoverableError.html b/classes/v4.UnrecoverableError.html index f605ed73c2..37f93b6620 100644 --- a/classes/v4.UnrecoverableError.html +++ b/classes/v4.UnrecoverableError.html @@ -29,7 +29,7 @@

    Hierarchy

    • UnrecoverableError
    +
  • Defined in classes/unrecoverable-error.ts:8
    • @@ -54,7 +54,7 @@
    Optional Returns UnrecoverableError
    +
  • Defined in classes/unrecoverable-error.ts:9
    • diff --git a/classes/v4.WaitingChildrenError.html b/classes/v4.WaitingChildrenError.html index 6ab263d4ec..0e378086ff 100644 --- a/classes/v4.WaitingChildrenError.html +++ b/classes/v4.WaitingChildrenError.html @@ -29,7 +29,7 @@

    Hierarchy

    • WaitingChildrenError
    +
  • Defined in classes/waiting-children-error.ts:8
    • @@ -54,7 +54,7 @@
    Optional Returns WaitingChildrenError
    +
  • Defined in classes/waiting-children-error.ts:9
    • diff --git a/classes/v4.Worker.html b/classes/v4.Worker.html index d7b23d4eb7..d3424c0c2f 100644 --- a/classes/v4.Worker.html +++ b/classes/v4.Worker.html @@ -38,7 +38,7 @@

    Hierarchy

    • Worker
    +
  • Defined in classes/worker.ts:160
    • @@ -116,7 +116,7 @@
    Optional Returns Worker<DataType, ResultType, NameType>
    +
  • Defined in classes/worker.ts:193

    • Properties

    @@ -124,18 +124,18 @@

    closingclosing: Promise<void>

    +
  • Defined in classes/queue-base.ts:21

    • Readonly id

    id: string
    +
  • Defined in classes/worker.ts:166

    • keys

    keys: KeysMap
    +
  • Defined in classes/queue-base.ts:20

    • Readonly name

    name: string
    @@ -144,7 +144,7 @@

    Readonly

    +
  • Defined in classes/queue-base.ts:35

    • Readonly opts

    opts: WorkerOptions
    @@ -153,13 +153,13 @@

    Readonly

    +
  • Defined in classes/worker.ts:165

    • Readonly qualifiedName

    qualifiedName: string
    +
  • Defined in classes/queue-base.ts:25

    • toKey

    toKey: ((type) => string)
    @@ -178,7 +178,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19

    • Accessors

    @@ -192,7 +192,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:84

    • concurrency

      @@ -205,7 +205,7 @@

      Parameters

      concurrency: number

    Returns void

    +
  • Defined in classes/worker.ts:350

    • redisVersion

    +
  • Defined in classes/queue-base.ts:91

    • repeat

    +
  • Defined in classes/worker.ts:361

    • Methods

    @@ -249,7 +249,7 @@

    Returns Promise<

    +
  • Defined in classes/worker.ts:751

    • delay

    +
  • Defined in classes/worker.ts:578

    • disconnect

    +
  • Defined in classes/queue-base.ts:151

    • emit

    +
  • Defined in classes/worker.ts:290

    • getNextJob

    +
  • Defined in classes/worker.ts:448

    • isPaused

    +
  • Defined in classes/worker.ts:726

    • isRunning

    +
  • Defined in classes/worker.ts:736

    • off

    +
  • Defined in classes/worker.ts:297

    • on

    +
  • Defined in classes/worker.ts:305

    • once

    +
  • Defined in classes/worker.ts:313

    • pause

    +
  • Defined in classes/worker.ts:695

    • processJob

      @@ -454,7 +454,7 @@

      Returns booleanjobsInProgress: Set<{
          job: Job<any, any, string>;
          ts: number;
      }>

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

    +
  • Defined in classes/worker.ts:619

    • rateLimit

    +
  • Defined in classes/worker.ts:497

    • resume

    +
  • Defined in classes/worker.ts:713

    • run

    +
  • Defined in classes/worker.ts:375

    • startStalledCheckTimer

    +
  • Defined in classes/worker.ts:801

    • waitUntilReady

    +
  • Defined in classes/worker.ts:345

    • Static RateLimitError

    +
  • Defined in classes/worker.ts:189
    • diff --git a/enums/v4.ChildCommand.html b/enums/v4.ChildCommand.html index 70ef3985f7..b96086e7bf 100644 --- a/enums/v4.ChildCommand.html +++ b/enums/v4.ChildCommand.html @@ -17,7 +17,7 @@
  • ChildCommand

    • Enumeration ChildCommand

    +
  • Defined in enums/child-command.ts:1
    • @@ -35,17 +35,17 @@

    Enumeration Members

    Init

    Init: 0
    +
  • Defined in enums/child-command.ts:2

    • Start

    Start: 1
    +
  • Defined in enums/child-command.ts:3

    • Stop

    Stop: 2
    +
  • Defined in enums/child-command.ts:4
    • diff --git a/enums/v4.ClientType.html b/enums/v4.ClientType.html index 7ac7094cae..5bdfdd5649 100644 --- a/enums/v4.ClientType.html +++ b/enums/v4.ClientType.html @@ -17,7 +17,7 @@
  • ClientType

    • Enumeration ClientType

    +
  • Defined in interfaces/queue-options.ts:5
    • @@ -34,12 +34,12 @@

    Enumeration Members

    blocking

    blocking: "blocking"
    +
  • Defined in interfaces/queue-options.ts:6

    • normal

    normal: "normal"
    +
  • Defined in interfaces/queue-options.ts:7
    • diff --git a/enums/v4.ErrorCode.html b/enums/v4.ErrorCode.html index 0f67e4c457..55b6e42a67 100644 --- a/enums/v4.ErrorCode.html +++ b/enums/v4.ErrorCode.html @@ -17,7 +17,7 @@
  • ErrorCode

    • Enumeration ErrorCode

    +
  • Defined in enums/error-code.ts:1
    • @@ -38,32 +38,32 @@

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6
    +
  • Defined in enums/error-code.ts:7

    • JobLockNotExist

    JobLockNotExist: -2
    +
  • Defined in enums/error-code.ts:3

    • JobNotExist

    JobNotExist: -1
    +
  • Defined in enums/error-code.ts:2

    • JobNotInState

    JobNotInState: -3
    +
  • Defined in enums/error-code.ts:4

    • JobPendingDependencies

    JobPendingDependencies: -4
    +
  • Defined in enums/error-code.ts:5

    • ParentJobNotExist

    ParentJobNotExist: -5
    +
  • Defined in enums/error-code.ts:6
    • diff --git a/enums/v4.MetricsTime.html b/enums/v4.MetricsTime.html index a97afc640d..e342ebee0b 100644 --- a/enums/v4.MetricsTime.html +++ b/enums/v4.MetricsTime.html @@ -17,7 +17,7 @@
  • MetricsTime

    • Enumeration MetricsTime

    +
  • Defined in enums/metrics-time.ts:1
    • @@ -40,42 +40,42 @@

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15
    +
  • Defined in enums/metrics-time.ts:4

    • FIVE_MINUTES

    FIVE_MINUTES: 5
    +
  • Defined in enums/metrics-time.ts:3

    • ONE_HOUR

    ONE_HOUR: 60
    +
  • Defined in enums/metrics-time.ts:6

    • ONE_MINUTE

    ONE_MINUTE: 1
    +
  • Defined in enums/metrics-time.ts:2

    • ONE_MONTH

    ONE_MONTH: 80640
    +
  • Defined in enums/metrics-time.ts:9

    • ONE_WEEK

    ONE_WEEK: 10080
    +
  • Defined in enums/metrics-time.ts:7

    • THIRTY_MINUTES

    THIRTY_MINUTES: 30
    +
  • Defined in enums/metrics-time.ts:5

    • TWO_WEEKS

    TWO_WEEKS: 20160
    +
  • Defined in enums/metrics-time.ts:8
    • diff --git a/enums/v4.ParentCommand.html b/enums/v4.ParentCommand.html index 4eafff60d2..7077feb918 100644 --- a/enums/v4.ParentCommand.html +++ b/enums/v4.ParentCommand.html @@ -17,7 +17,7 @@
  • ParentCommand

    • Enumeration ParentCommand

    +
  • Defined in enums/parent-command.ts:1
    • @@ -41,47 +41,47 @@

    Enumeration Members

    Completed

    Completed: 0
    +
  • Defined in enums/parent-command.ts:2

    • Error

    Error: 1
    +
  • Defined in enums/parent-command.ts:3

    • Failed

    Failed: 2
    +
  • Defined in enums/parent-command.ts:4

    • InitCompleted

    InitCompleted: 4
    +
  • Defined in enums/parent-command.ts:6

    • InitFailed

    InitFailed: 3
    +
  • Defined in enums/parent-command.ts:5

    • Log

    Log: 5
    +
  • Defined in enums/parent-command.ts:7

    • MoveToDelayed

    MoveToDelayed: 6
    +
  • Defined in enums/parent-command.ts:8

    • Progress

    Progress: 7
    +
  • Defined in enums/parent-command.ts:9

    • Update

    Update: 8
    +
  • Defined in enums/parent-command.ts:10
    • diff --git a/functions/v4.array2obj.html b/functions/v4.array2obj.html index 311e234147..e484d281c7 100644 --- a/functions/v4.array2obj.html +++ b/functions/v4.array2obj.html @@ -27,7 +27,7 @@

    Parameters

    arr: string[]

    Returns Record<string, string>

    +
  • Defined in utils.ts:45
    • diff --git a/functions/v4.asyncSend.html b/functions/v4.asyncSend.html index d0819438bd..81975c4455 100644 --- a/functions/v4.asyncSend.html +++ b/functions/v4.asyncSend.html @@ -34,7 +34,7 @@
    proc: msg: any

    Returns Promise<void>

    +
  • Defined in utils.ts:141
    • diff --git a/functions/v4.childSend.html b/functions/v4.childSend.html index e7d496e55a..f4ef1edff7 100644 --- a/functions/v4.childSend.html +++ b/functions/v4.childSend.html @@ -29,7 +29,7 @@
    proc: msg: ChildMessage

    Returns Promise<void>

    +
  • Defined in utils.ts:162
    • diff --git a/functions/v4.delay.html b/functions/v4.delay.html index 8e5b0ee1cd..872a3c09fa 100644 --- a/functions/v4.delay.html +++ b/functions/v4.delay.html @@ -29,7 +29,7 @@
    ms: Optional abortController: AbortController
    Optional

    Returns Promise<void>

    +
  • Defined in utils.ts:53
    • diff --git a/functions/v4.errorToJSON.html b/functions/v4.errorToJSON.html index 024648dd15..8a6de8564d 100644 --- a/functions/v4.errorToJSON.html +++ b/functions/v4.errorToJSON.html @@ -27,7 +27,7 @@

    Parameters

    value: any

    Returns Record<string, any>

    +
  • Defined in utils.ts:187
    • diff --git a/functions/v4.getNextMillis.html b/functions/v4.getNextMillis.html index c1d730b54f..7c48b4e2f5 100644 --- a/functions/v4.getNextMillis.html +++ b/functions/v4.getNextMillis.html @@ -29,7 +29,7 @@
    millis: opts: RepeatOptions

    Returns number

    +
  • Defined in classes/repeat.ts:234
    • diff --git a/functions/v4.getParentKey.html b/functions/v4.getParentKey.html index 956cb12cdc..36c1034fbf 100644 --- a/functions/v4.getParentKey.html +++ b/functions/v4.getParentKey.html @@ -32,7 +32,7 @@
    id
    queue: string

    Returns string | undefined

    +
  • Defined in utils.ts:112
    • diff --git a/functions/v4.isEmpty.html b/functions/v4.isEmpty.html index 0526bc2209..40f5359ae8 100644 --- a/functions/v4.isEmpty.html +++ b/functions/v4.isEmpty.html @@ -27,7 +27,7 @@

    Parameters

    obj: object

    Returns boolean

    +
  • Defined in utils.ts:36
    • diff --git a/functions/v4.isNotConnectionError.html b/functions/v4.isNotConnectionError.html index a395e325f4..f6ca4b2b34 100644 --- a/functions/v4.isNotConnectionError.html +++ b/functions/v4.isNotConnectionError.html @@ -27,7 +27,7 @@

    Parameters

    error: Error

    Returns boolean

    +
  • Defined in utils.ts:128
    • diff --git a/functions/v4.isRedisCluster.html b/functions/v4.isRedisCluster.html index df40a51b47..4db55ee02f 100644 --- a/functions/v4.isRedisCluster.html +++ b/functions/v4.isRedisCluster.html @@ -27,7 +27,7 @@

    Parameters

    obj: unknown

    Returns obj is Cluster

    +
  • Defined in utils.ts:77
    • diff --git a/functions/v4.isRedisInstance.html b/functions/v4.isRedisInstance.html index 62c123696b..a97807f062 100644 --- a/functions/v4.isRedisInstance.html +++ b/functions/v4.isRedisInstance.html @@ -27,7 +27,7 @@

    Parameters

    obj: any

    Returns obj is Cluster | Redis

    +
  • Defined in utils.ts:69
    • diff --git a/functions/v4.isRedisVersionLowerThan.html b/functions/v4.isRedisVersionLowerThan.html index 56eec5a8a3..0897f196d4 100644 --- a/functions/v4.isRedisVersionLowerThan.html +++ b/functions/v4.isRedisVersionLowerThan.html @@ -29,7 +29,7 @@
    currentVersion: minimumVersion: string

    Returns boolean

    +
  • Defined in utils.ts:167
    • diff --git a/functions/v4.lengthInUtf8Bytes.html b/functions/v4.lengthInUtf8Bytes.html index 074eb76e0c..cf261139c9 100644 --- a/functions/v4.lengthInUtf8Bytes.html +++ b/functions/v4.lengthInUtf8Bytes.html @@ -32,7 +32,7 @@

    Returns numberSee

    https://stackoverflow.com/a/23318053/1347170

    +
  • Defined in utils.ts:32
    • diff --git a/functions/v4.parseObjectValues.html b/functions/v4.parseObjectValues.html index af915f8f0a..ae54fbc7bf 100644 --- a/functions/v4.parseObjectValues.html +++ b/functions/v4.parseObjectValues.html @@ -30,7 +30,7 @@
    obj: [key: string]: string

    Returns Record<string, any>

    +
  • Defined in utils.ts:176
    • diff --git a/functions/v4.raw2NextJobData.html b/functions/v4.raw2NextJobData.html index ee9b615604..41b4ecf613 100644 --- a/functions/v4.raw2NextJobData.html +++ b/functions/v4.raw2NextJobData.html @@ -27,7 +27,7 @@

    Parameters

    raw: any[]

    Returns any[]

    +
  • Defined in classes/scripts.ts:975
    • diff --git a/functions/v4.removeAllQueueData.html b/functions/v4.removeAllQueueData.html index e235ac297a..9391b0fd17 100644 --- a/functions/v4.removeAllQueueData.html +++ b/functions/v4.removeAllQueueData.html @@ -31,7 +31,7 @@
    queueName: prefix: string = 'bull'

    Returns Promise<void | boolean>

    +
  • Defined in utils.ts:81
    • diff --git a/functions/v4.tryCatch.html b/functions/v4.tryCatch.html index 811be2b388..6aaa4534c7 100644 --- a/functions/v4.tryCatch.html +++ b/functions/v4.tryCatch.html @@ -42,7 +42,7 @@
    ctx: args: any[]

    Returns any

    +
  • Defined in utils.ts:14
    • diff --git a/interfaces/v4.AddChildrenOpts.html b/interfaces/v4.AddChildrenOpts.html index df36689913..9835a400d2 100644 --- a/interfaces/v4.AddChildrenOpts.html +++ b/interfaces/v4.AddChildrenOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • AddChildrenOpts
    +
  • Defined in classes/flow-producer.ts:34
    • @@ -40,12 +40,12 @@

    Properties

    multi

    multi: ChainableCommander
    +
  • Defined in classes/flow-producer.ts:35

    • nodes

    nodes: FlowJob[]
    +
  • Defined in classes/flow-producer.ts:36

    • parent

    parent: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }
    @@ -62,12 +62,12 @@
    id
  • queue: string
    • +
  • Defined in classes/flow-producer.ts:37

    • Optional queuesOpts

    queuesOpts?: FlowQueuesOpts
    +
  • Defined in classes/flow-producer.ts:44
    • diff --git a/interfaces/v4.AddNodeOpts.html b/interfaces/v4.AddNodeOpts.html index a61d99f8f6..2583548689 100644 --- a/interfaces/v4.AddNodeOpts.html +++ b/interfaces/v4.AddNodeOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • AddNodeOpts
    +
  • Defined in classes/flow-producer.ts:18
    • @@ -40,12 +40,12 @@

    Properties

    multi

    multi: ChainableCommander
    +
  • Defined in classes/flow-producer.ts:19

    • node

    node: FlowJob
    +
  • Defined in classes/flow-producer.ts:20

    • Optional parent

    parent?: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }
    @@ -62,7 +62,7 @@
    id
  • queue: string
    • +
  • Defined in classes/flow-producer.ts:21

    • Optional queuesOpts

    queuesOpts?: FlowQueuesOpts
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in classes/flow-producer.ts:31
    • diff --git a/interfaces/v4.AdvancedOptions.html b/interfaces/v4.AdvancedOptions.html index f9f6d32396..fb56be55fe 100644 --- a/interfaces/v4.AdvancedOptions.html +++ b/interfaces/v4.AdvancedOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • AdvancedOptions
    +
  • Defined in interfaces/advanced-options.ts:16
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in interfaces/advanced-options.ts:20

    • Optional repeatKeyHashAlgorithm

    repeatKeyHashAlgorithm?: string
    @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in interfaces/advanced-options.ts:13

    • Optional repeatStrategy

    repeatStrategy?: RepeatStrategy
    @@ -63,7 +63,7 @@

    Optional

    +
  • Defined in interfaces/advanced-options.ts:7
    • diff --git a/interfaces/v4.AdvancedRepeatOptions.html b/interfaces/v4.AdvancedRepeatOptions.html index 2cf2edbccd..1aee2cd285 100644 --- a/interfaces/v4.AdvancedRepeatOptions.html +++ b/interfaces/v4.AdvancedRepeatOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in interfaces/advanced-options.ts:3
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in interfaces/advanced-options.ts:13

    • Optional repeatStrategy

    repeatStrategy?: RepeatStrategy
    @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in interfaces/advanced-options.ts:7
    • diff --git a/interfaces/v4.BackoffOptions.html b/interfaces/v4.BackoffOptions.html index 75851264ac..314648f27b 100644 --- a/interfaces/v4.BackoffOptions.html +++ b/interfaces/v4.BackoffOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • BackoffOptions
    +
  • Defined in interfaces/backoff-options.ts:6
    • @@ -47,7 +47,7 @@

    Optional

    +
  • Defined in interfaces/backoff-options.ts:14

    • type

    type: "fixed" | "exponential" | string & {}
    @@ -55,7 +55,7 @@

    type

    +
  • Defined in interfaces/backoff-options.ts:10
    • diff --git a/interfaces/v4.BaseJobOptions.html b/interfaces/v4.BaseJobOptions.html index 273d86328d..27c9de802b 100644 --- a/interfaces/v4.BaseJobOptions.html +++ b/interfaces/v4.BaseJobOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • BaseJobOptions
    +
  • Defined in interfaces/base-job-options.ts:77
    • @@ -61,7 +61,7 @@

    Default Value

    0
    +
  • Defined in interfaces/base-job-options.ts:29

    • Optional backoff

    backoff?: number | BackoffOptions
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:34

    • Optional delay

    delay?: number
    @@ -84,7 +84,7 @@

    Default Value

    0
    +
  • Defined in interfaces/base-job-options.ts:23

    • Optional jobId

    jobId?: string
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:95

    • Optional keepLogs

    keepLogs?: number
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:64

    • Optional lifo

    lifo?: boolean
    @@ -116,7 +116,7 @@

    See

    https://docs.bul

    +
  • Defined in interfaces/base-job-options.ts:41

    • Optional parent

    parent?: {
        id: string;
        queue: string;
    }
    @@ -133,7 +133,7 @@
    queuehttps://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html

    +
  • Defined in interfaces/base-job-options.ts:100

    • Optional prevMillis

    prevMillis?: number
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:113

    • Optional priority

    priority?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:15

    • Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs
    @@ -165,7 +165,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:50

    • Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:59

    • Optional repeat

    repeat?: RepeatOptions
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:81

    • Optional repeatJobKey

    repeatJobKey?: string
    @@ -194,7 +194,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:86

    • Optional sizeLimit

    sizeLimit?: number
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:74

    • Optional stackTraceLimit

    stackTraceLimit?: number
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:69

    • Optional timestamp

    timestamp?: number
    @@ -224,7 +224,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
    • diff --git a/interfaces/v4.BaseOptions.html b/interfaces/v4.BaseOptions.html index f5bacce4d2..42e3a1b5a7 100644 --- a/interfaces/v4.BaseOptions.html +++ b/interfaces/v4.BaseOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • BaseOptions
    +
  • Defined in interfaces/redis-options.ts:3
    • @@ -37,7 +37,7 @@

    Properties

    Optional skipVersionCheck

    skipVersionCheck?: boolean
    +
  • Defined in interfaces/redis-options.ts:4
    • diff --git a/interfaces/v4.BuiltInStrategies.html b/interfaces/v4.BuiltInStrategies.html index d2fb35e788..83db03e28d 100644 --- a/interfaces/v4.BuiltInStrategies.html +++ b/interfaces/v4.BuiltInStrategies.html @@ -35,7 +35,7 @@

    Parameters

    delay: number

    Returns BackoffStrategy

    +
  • Defined in classes/backoffs.ts:4
    • diff --git a/interfaces/v4.ChildMessage.html b/interfaces/v4.ChildMessage.html index 4682ba5ca0..e048b347df 100644 --- a/interfaces/v4.ChildMessage.html +++ b/interfaces/v4.ChildMessage.html @@ -21,7 +21,7 @@

    Hierarchy

    • ChildMessage
    +
  • Defined in interfaces/child-message.ts:3
    • @@ -39,17 +39,17 @@

    Properties

    cmd

    cmd: ParentCommand
    +
  • Defined in interfaces/child-message.ts:4

    • Optional err

    err?: Record<string, any>
    +
  • Defined in interfaces/child-message.ts:6

    • Optional value

    value?: any
    +
  • Defined in interfaces/child-message.ts:5
    • diff --git a/interfaces/v4.Command.html b/interfaces/v4.Command.html index a4e48bcd2d..a4ca8ac0b0 100644 --- a/interfaces/v4.Command.html +++ b/interfaces/v4.Command.html @@ -21,7 +21,7 @@

    Hierarchy

    • Command
    +
  • Defined in commands/script-loader.ts:15
    • @@ -38,7 +38,7 @@

    Properties

    name

    name: string
    +
  • Defined in commands/script-loader.ts:16

    • options

    options: {
        lua: string;
        numberOfKeys: number;
    }
    @@ -50,7 +50,7 @@
    lua
    numberOfKeys: number
    +
  • Defined in commands/script-loader.ts:17
    • diff --git a/interfaces/v4.DefaultJobOptions.html b/interfaces/v4.DefaultJobOptions.html index 4ebf238354..e3e3ec859b 100644 --- a/interfaces/v4.DefaultJobOptions.html +++ b/interfaces/v4.DefaultJobOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in interfaces/base-job-options.ts:3
    • @@ -55,7 +55,7 @@

    Default Value

    0
    +
  • Defined in interfaces/base-job-options.ts:29

    • Optional backoff

    backoff?: number | BackoffOptions
    @@ -63,7 +63,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:34

    • Optional delay

    delay?: number
    @@ -76,7 +76,7 @@

    Default Value

    0
    +
  • Defined in interfaces/base-job-options.ts:23

    • Optional keepLogs

    keepLogs?: number
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:64

    • Optional lifo

    lifo?: boolean
    @@ -94,7 +94,7 @@

    OptionalSee

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

    +
  • Defined in interfaces/base-job-options.ts:41

    • Optional priority

    priority?: number
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:15

    • Optional removeOnComplete

    removeOnComplete?: number | boolean | KeepJobs
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:50

    • Optional removeOnFail

    removeOnFail?: number | boolean | KeepJobs
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:59

    • Optional sizeLimit

    sizeLimit?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:74

    • Optional stackTraceLimit

    stackTraceLimit?: number
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in interfaces/base-job-options.ts:69

    • Optional timestamp

    timestamp?: number
    @@ -155,7 +155,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
    • diff --git a/interfaces/v4.DependenciesOpts.html b/interfaces/v4.DependenciesOpts.html index 5004cad75c..45a3cb6e36 100644 --- a/interfaces/v4.DependenciesOpts.html +++ b/interfaces/v4.DependenciesOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • DependenciesOpts
    +
  • Defined in interfaces/minimal-job.ts:14
    • @@ -45,7 +45,7 @@
    Optional
    Optional cursor?: number
    +
  • Defined in interfaces/minimal-job.ts:15

    • Optional unprocessed

    unprocessed?: {
        count?: number;
        cursor?: number;
    }
    @@ -57,7 +57,7 @@
    Optional
    Optional cursor?: number
    +
  • Defined in interfaces/minimal-job.ts:19
    • diff --git a/interfaces/v4.FlowJobBase.html b/interfaces/v4.FlowJobBase.html index 8c108d42de..ff68910d62 100644 --- a/interfaces/v4.FlowJobBase.html +++ b/interfaces/v4.FlowJobBase.html @@ -26,7 +26,7 @@

    Hierarchy

    • FlowJobBase
    +
  • Defined in interfaces/flow-job.ts:4
    • @@ -47,32 +47,32 @@

    Properties

    Optional children

    children?: FlowChildJob[]
    +
  • Defined in interfaces/flow-job.ts:10

    • Optional data

    data?: any
    +
  • Defined in interfaces/flow-job.ts:7

    • name

    name: string
    +
  • Defined in interfaces/flow-job.ts:5

    • Optional opts

    opts?: Omit<T, "repeat">
    +
  • Defined in interfaces/flow-job.ts:9

    • Optional prefix

    prefix?: string
    +
  • Defined in interfaces/flow-job.ts:8

    • queueName

    queueName: string
    +
  • Defined in interfaces/flow-job.ts:6
    • diff --git a/interfaces/v4.FlowOpts.html b/interfaces/v4.FlowOpts.html index 18291410f6..a84fd4c874 100644 --- a/interfaces/v4.FlowOpts.html +++ b/interfaces/v4.FlowOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • FlowOpts
    +
  • Defined in interfaces/flow-job.ts:22
    • @@ -40,7 +40,7 @@

    queuesOptions

    +
  • Defined in interfaces/flow-job.ts:26
    • diff --git a/interfaces/v4.FlowProducerListener.html b/interfaces/v4.FlowProducerListener.html index c287bb3d90..bea0fc247c 100644 --- a/interfaces/v4.FlowProducerListener.html +++ b/interfaces/v4.FlowProducerListener.html @@ -23,7 +23,7 @@

    Hierarchy

    • FlowProducerListener
    +
  • Defined in classes/flow-producer.ts:75
    • @@ -57,7 +57,7 @@
    failedReason: Returns void
    +
  • Defined in classes/flow-producer.ts:81

    • ioredis:close

    ioredis:close: (() => void)
    @@ -75,7 +75,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
    • diff --git a/interfaces/v4.GetNextJobOptions.html b/interfaces/v4.GetNextJobOptions.html index 571181aa14..9bb02d57e0 100644 --- a/interfaces/v4.GetNextJobOptions.html +++ b/interfaces/v4.GetNextJobOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • GetNextJobOptions
    +
  • Defined in interfaces/worker-options.ts:142
    • @@ -37,7 +37,7 @@

    Properties

    Optional block

    block?: boolean
    +
  • Defined in interfaces/worker-options.ts:143
    • diff --git a/interfaces/v4.IConnection.html b/interfaces/v4.IConnection.html index 07e8ea36b9..2c8603ef79 100644 --- a/interfaces/v4.IConnection.html +++ b/interfaces/v4.IConnection.html @@ -23,7 +23,7 @@

    Hierarchy

    • IConnection
    +
  • Defined in interfaces/connection.ts:6
    • @@ -43,7 +43,7 @@

    Properties

    client

    client: Promise<RedisClient>
    +
  • Defined in interfaces/connection.ts:8

    • Methods

    @@ -53,7 +53,7 @@

    waitUntilReady

    Returns Promise<boolean>

    +
  • Defined in interfaces/connection.ts:7
    • diff --git a/interfaces/v4.IoredisListener.html b/interfaces/v4.IoredisListener.html index 9682b775c2..a7ab451393 100644 --- a/interfaces/v4.IoredisListener.html +++ b/interfaces/v4.IoredisListener.html @@ -26,7 +26,7 @@

    Hierarchy

  • QueueListener
  • WorkerListener
    • +
  • Defined in interfaces/ioredis-events.ts:1
    • @@ -54,7 +54,7 @@

    Type declaration

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
    • diff --git a/interfaces/v4.JobJson.html b/interfaces/v4.JobJson.html index c720878229..d572bf8cc8 100644 --- a/interfaces/v4.JobJson.html +++ b/interfaces/v4.JobJson.html @@ -21,7 +21,7 @@

    Hierarchy

    • JobJson
    +
  • Defined in interfaces/job-json.ts:4
    • @@ -51,77 +51,77 @@

    Properties

    attemptsMade

    attemptsMade: number
    +
  • Defined in interfaces/job-json.ts:10

    • data

    data: string
    +
  • Defined in interfaces/job-json.ts:7

    • failedReason

    failedReason: string
    +
  • Defined in interfaces/job-json.ts:14

    • Optional finishedOn

    finishedOn?: number
    +
  • Defined in interfaces/job-json.ts:11

    • id

    id: string
    +
  • Defined in interfaces/job-json.ts:5

    • name

    name: string
    +
  • Defined in interfaces/job-json.ts:6

    • opts

    opts: RedisJobOptions
    +
  • Defined in interfaces/job-json.ts:8

    • Optional parent

    parent?: ParentKeys
    +
  • Defined in interfaces/job-json.ts:17

    • Optional parentKey

    parentKey?: string
    +
  • Defined in interfaces/job-json.ts:18

    • Optional processedOn

    processedOn?: number
    +
  • Defined in interfaces/job-json.ts:12

    • progress

    progress: number | object
    +
  • Defined in interfaces/job-json.ts:9

    • Optional repeatJobKey

    repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19

    • returnvalue

    returnvalue: string
    +
  • Defined in interfaces/job-json.ts:16

    • stacktrace

    stacktrace: string
    +
  • Defined in interfaces/job-json.ts:15

    • timestamp

    timestamp: number
    +
  • Defined in interfaces/job-json.ts:13
    • diff --git a/interfaces/v4.JobJsonRaw.html b/interfaces/v4.JobJsonRaw.html index 51880ffebf..c8ef41d66a 100644 --- a/interfaces/v4.JobJsonRaw.html +++ b/interfaces/v4.JobJsonRaw.html @@ -21,7 +21,7 @@

    Hierarchy

    • JobJsonRaw
    +
  • Defined in interfaces/job-json.ts:22
    • @@ -52,82 +52,82 @@

    Properties

    attemptsMade

    attemptsMade: string
    +
  • Defined in interfaces/job-json.ts:29

    • data

    data: string
    +
  • Defined in interfaces/job-json.ts:25

    • delay

    delay: string
    +
  • Defined in interfaces/job-json.ts:26

    • failedReason

    failedReason: string
    +
  • Defined in interfaces/job-json.ts:33

    • Optional finishedOn

    finishedOn?: string
    +
  • Defined in interfaces/job-json.ts:30

    • id

    id: string
    +
  • Defined in interfaces/job-json.ts:23

    • name

    name: string
    +
  • Defined in interfaces/job-json.ts:24

    • opts

    opts: string
    +
  • Defined in interfaces/job-json.ts:27

    • Optional parent

    parent?: string
    +
  • Defined in interfaces/job-json.ts:37

    • Optional parentKey

    parentKey?: string
    +
  • Defined in interfaces/job-json.ts:36

    • Optional processedOn

    processedOn?: string
    +
  • Defined in interfaces/job-json.ts:31

    • progress

    progress: string
    +
  • Defined in interfaces/job-json.ts:28

    • returnvalue

    returnvalue: string
    +
  • Defined in interfaces/job-json.ts:35

    • Optional rjk

    rjk?: string
    +
  • Defined in interfaces/job-json.ts:38

    • stacktrace

    stacktrace: string[]
    +
  • Defined in interfaces/job-json.ts:34

    • timestamp

    timestamp: string
    +
  • Defined in interfaces/job-json.ts:32
    • diff --git a/interfaces/v4.JobNode.html b/interfaces/v4.JobNode.html index 40e90f41cd..93747a89be 100644 --- a/interfaces/v4.JobNode.html +++ b/interfaces/v4.JobNode.html @@ -21,7 +21,7 @@

    Hierarchy

    • JobNode
    +
  • Defined in classes/flow-producer.ts:70
    • @@ -38,12 +38,12 @@

    Properties

    Optional children

    children?: JobNode[]
    +
  • Defined in classes/flow-producer.ts:72

    • job

    job: Job<any, any, string>
    +
  • Defined in classes/flow-producer.ts:71
    • diff --git a/interfaces/v4.KeepJobs.html b/interfaces/v4.KeepJobs.html index b387b4da0d..ae48865705 100644 --- a/interfaces/v4.KeepJobs.html +++ b/interfaces/v4.KeepJobs.html @@ -28,7 +28,7 @@

    Hierarchy

    • KeepJobs
    +
  • Defined in interfaces/keep-jobs.ts:8
    • @@ -48,7 +48,7 @@

    Optional

    +
  • Defined in interfaces/keep-jobs.ts:12

    • Optional count

    count?: number
    @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in interfaces/keep-jobs.ts:17
    • diff --git a/interfaces/v4.Metrics.html b/interfaces/v4.Metrics.html index 74695bd4fb..638959d6cd 100644 --- a/interfaces/v4.Metrics.html +++ b/interfaces/v4.Metrics.html @@ -21,7 +21,7 @@

    Hierarchy

    • Metrics
    +
  • Defined in interfaces/metrics.ts:1
    • @@ -39,12 +39,12 @@

    Properties

    count

    count: number
    +
  • Defined in interfaces/metrics.ts:8

    • data

    data: number[]
    +
  • Defined in interfaces/metrics.ts:7

    • meta

    meta: {
        count: number;
        prevCount: number;
        prevTS: number;
    }
    @@ -58,7 +58,7 @@
    prevCount
    prevTS: number
    +
  • Defined in interfaces/metrics.ts:2
    • diff --git a/interfaces/v4.MetricsOptions.html b/interfaces/v4.MetricsOptions.html index ba357ea262..dead2e821a 100644 --- a/interfaces/v4.MetricsOptions.html +++ b/interfaces/v4.MetricsOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • MetricsOptions
    +
  • Defined in interfaces/metrics-options.ts:5
    • @@ -42,7 +42,7 @@

    Optional

    +
  • Defined in interfaces/metrics-options.ts:11
    • diff --git a/interfaces/v4.MinimalJob.html b/interfaces/v4.MinimalJob.html index c1473814ee..5e1417a162 100644 --- a/interfaces/v4.MinimalJob.html +++ b/interfaces/v4.MinimalJob.html @@ -38,7 +38,7 @@

    Implemented by

    +
  • Defined in interfaces/minimal-job.ts:28
    • @@ -89,7 +89,7 @@

    Default Value

    0
    +
  • Defined in interfaces/minimal-job.ts:74

    • data

    data: DataType
    @@ -97,7 +97,7 @@

    data

    +
  • Defined in interfaces/minimal-job.ts:40

    • delay

    delay: number
    @@ -108,7 +108,7 @@

    Default Value

    0
    +
  • Defined in interfaces/minimal-job.ts:65

    • failedReason

    failedReason: string
    @@ -116,7 +116,7 @@

    failedReason

    +
  • Defined in interfaces/minimal-job.ts:78

    • Optional finishedOn

    finishedOn?: number
    @@ -124,12 +124,12 @@

    Optional

    +
  • Defined in interfaces/minimal-job.ts:82

    • Optional id

    id?: string
    +
  • Defined in interfaces/minimal-job.ts:45

    • name

    name: NameType
    @@ -137,7 +137,7 @@

    name

    +
  • Defined in interfaces/minimal-job.ts:36

    • opts

    opts: JobsOptions
    @@ -145,7 +145,7 @@

    opts

    +
  • Defined in interfaces/minimal-job.ts:44

    • Optional parent

    parent?: ParentKeys
    @@ -153,7 +153,7 @@

    Optional

    +
  • Defined in interfaces/minimal-job.ts:94

    • Optional parentKey

    parentKey?: string
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in interfaces/minimal-job.ts:90

    • Optional processedOn

    processedOn?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in interfaces/minimal-job.ts:86

    • progress

    progress: number | object
    @@ -180,7 +180,7 @@

    Default Value

    0
    +
  • Defined in interfaces/minimal-job.ts:50

    • Optional repeatJobKey

    repeatJobKey?: string
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in interfaces/minimal-job.ts:98

    • returnvalue

    returnvalue: ReturnType
    @@ -199,7 +199,7 @@

    Default Value

    null
    +
  • Defined in interfaces/minimal-job.ts:55

    • stacktrace

    stacktrace: string[]
    @@ -210,7 +210,7 @@

    Default Value

    null
    +
  • Defined in interfaces/minimal-job.ts:60

    • timestamp

    timestamp: number
    @@ -218,7 +218,7 @@

    timestamp

    +
  • Defined in interfaces/minimal-job.ts:69

    • Accessors

    @@ -230,7 +230,7 @@

    Returns string

    +
  • Defined in interfaces/minimal-job.ts:131

    • queueName

    +
  • Defined in interfaces/minimal-job.ts:127

    • queueQualifiedName

    +
  • Defined in interfaces/minimal-job.ts:136

    • Methods

    @@ -263,7 +263,7 @@

    asJSONReturns JobJson

    +
  • Defined in interfaces/minimal-job.ts:103

    • asJSONSandbox

    +
  • Defined in interfaces/minimal-job.ts:108

    • log

    +
  • Defined in interfaces/minimal-job.ts:126

    • updateData

    +
  • Defined in interfaces/minimal-job.ts:114

    • updateProgress

    +
  • Defined in interfaces/minimal-job.ts:120
    • diff --git a/interfaces/v4.MoveToWaitingChildrenOpts.html b/interfaces/v4.MoveToWaitingChildrenOpts.html index 58be133474..da437cc7d8 100644 --- a/interfaces/v4.MoveToWaitingChildrenOpts.html +++ b/interfaces/v4.MoveToWaitingChildrenOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • MoveToWaitingChildrenOpts
    +
  • Defined in interfaces/minimal-job.ts:7
    • @@ -44,7 +44,7 @@
    id
  • queue: string
    • +
  • Defined in interfaces/minimal-job.ts:8
    • diff --git a/interfaces/v4.NodeOpts.html b/interfaces/v4.NodeOpts.html index 60a173986e..0d44770828 100644 --- a/interfaces/v4.NodeOpts.html +++ b/interfaces/v4.NodeOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • NodeOpts
    +
  • Defined in classes/flow-producer.ts:47
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in classes/flow-producer.ts:63

    • id

    id: string
    @@ -52,7 +52,7 @@

    id

    +
  • Defined in classes/flow-producer.ts:59

    • Optional maxChildren

    maxChildren?: number
    @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in classes/flow-producer.ts:67

    • Optional prefix

    prefix?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in classes/flow-producer.ts:55

    • queueName

    queueName: string
    @@ -76,7 +76,7 @@

    queueName

    +
  • Defined in classes/flow-producer.ts:51
    • diff --git a/interfaces/v4.ObliterateOpts.html b/interfaces/v4.ObliterateOpts.html index 4e795ad6ec..93414ad5a7 100644 --- a/interfaces/v4.ObliterateOpts.html +++ b/interfaces/v4.ObliterateOpts.html @@ -21,7 +21,7 @@

    Hierarchy

    • ObliterateOpts
    +
  • Defined in classes/queue.ts:17
    • @@ -44,7 +44,7 @@

    Default Value

    1000
    +
  • Defined in classes/queue.ts:27

    • Optional force

    force?: boolean
    @@ -55,7 +55,7 @@

    Default Value

    false
    +
  • Defined in classes/queue.ts:22
    • diff --git a/interfaces/v4.Parent.html b/interfaces/v4.Parent.html index 30357bd780..692abe1996 100644 --- a/interfaces/v4.Parent.html +++ b/interfaces/v4.Parent.html @@ -30,7 +30,7 @@

    Hierarchy

    • Parent
    +
  • Defined in interfaces/parent.ts:5
    • @@ -50,27 +50,27 @@

    Properties

    Optional data

    data?: T
    +
  • Defined in interfaces/parent.ts:9

    • name

    name: string
    +
  • Defined in interfaces/parent.ts:6

    • Optional opts

    opts?: JobsOptions
    +
  • Defined in interfaces/parent.ts:10

    • Optional prefix

    prefix?: string
    +
  • Defined in interfaces/parent.ts:7

    • Optional queue

    queue?: string
    +
  • Defined in interfaces/parent.ts:8
    • diff --git a/interfaces/v4.ParentKeys.html b/interfaces/v4.ParentKeys.html index 0cc997c9b3..50124cac97 100644 --- a/interfaces/v4.ParentKeys.html +++ b/interfaces/v4.ParentKeys.html @@ -21,7 +21,7 @@

    Hierarchy

    • ParentKeys
    +
  • Defined in interfaces/parent.ts:13
    • @@ -38,12 +38,12 @@

    Properties

    id

    id: string
    +
  • Defined in interfaces/parent.ts:14

    • queueKey

    queueKey: string
    +
  • Defined in interfaces/parent.ts:15
    • diff --git a/interfaces/v4.ParentMessage.html b/interfaces/v4.ParentMessage.html index 472ff16b0f..412e387890 100644 --- a/interfaces/v4.ParentMessage.html +++ b/interfaces/v4.ParentMessage.html @@ -21,7 +21,7 @@

    Hierarchy

    • ParentMessage
    +
  • Defined in interfaces/parent-message.ts:4
    • @@ -40,22 +40,22 @@

    Properties

    cmd

    cmd: ChildCommand
    +
  • Defined in interfaces/parent-message.ts:5

    • Optional err

    err?: Error
    +
  • Defined in interfaces/parent-message.ts:7

    • Optional job

    job?: JobJson
    +
  • Defined in interfaces/parent-message.ts:8

    • Optional value

    value?: any
    +
  • Defined in interfaces/parent-message.ts:6
    • diff --git a/interfaces/v4.QueueBaseOptions.html b/interfaces/v4.QueueBaseOptions.html index a86e88c3fe..9f7006aa66 100644 --- a/interfaces/v4.QueueBaseOptions.html +++ b/interfaces/v4.QueueBaseOptions.html @@ -30,7 +30,7 @@

    Hierarchy

  • QueueEventsOptions
  • WorkerOptions
    • +
  • Defined in interfaces/queue-options.ts:13
    • @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:27

    • Optional connection

    connection?: ConnectionOptions
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:17

    • Optional prefix

    prefix?: string
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:32

    • Optional sharedConnection

    sharedConnection?: boolean
    @@ -77,7 +77,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:22

    • Optional skipVersionCheck

    skipVersionCheck?: boolean
    @@ -88,7 +88,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:38
    • diff --git a/interfaces/v4.QueueEventsListener.html b/interfaces/v4.QueueEventsListener.html index a0e76f3bd3..656a9ad75a 100644 --- a/interfaces/v4.QueueEventsListener.html +++ b/interfaces/v4.QueueEventsListener.html @@ -23,7 +23,7 @@

    Hierarchy

    • QueueEventsListener
    +
  • Defined in classes/queue-events.ts:16
    • @@ -80,7 +80,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:22

    • added

    added: ((args, id) => void)
    @@ -109,7 +109,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:29

    • cleaned

    cleaned: ((args, id) => void)
    @@ -136,7 +136,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:36

    • completed

    completed: ((args, id) => void)
    @@ -167,7 +167,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:43

    • delayed

    delayed: ((args, id) => void)
    @@ -196,7 +196,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:53

    • drained

    drained: ((id) => void)
    @@ -220,7 +220,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:62

    • duplicated

    duplicated: ((args, id) => void)
    @@ -247,7 +247,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:69

    • error

    error: ((args) => void)
    @@ -269,7 +269,7 @@
    args: Returns void
    +
  • Defined in classes/queue-events.ts:76

    • failed

    failed: ((args, id) => void)
    @@ -300,7 +300,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:83

    • ioredis:close

    ioredis:close: (() => void)
    @@ -318,7 +318,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7

    • paused

    paused: ((args, id) => void)
    @@ -343,7 +343,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:93

    • progress

    progress: ((args, id) => void)
    @@ -375,7 +375,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:103

    • removed

    removed: ((args, id) => void)
    @@ -405,7 +405,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:114

    • resumed

    resumed: ((args, id) => void)
    @@ -430,7 +430,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:121

    • retries-exhausted

    retries-exhausted: ((args, id) => void)
    @@ -459,7 +459,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:128

    • stalled

    stalled: ((args, id) => void)
    @@ -488,7 +488,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:140

    • waiting

    waiting: ((args, id) => void)
    @@ -517,7 +517,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:147

    • waiting-children

    waiting-children: ((args, id) => void)
    @@ -544,7 +544,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:154
    • diff --git a/interfaces/v4.QueueEventsOptions.html b/interfaces/v4.QueueEventsOptions.html index f48e0cb3e8..1e3c582979 100644 --- a/interfaces/v4.QueueEventsOptions.html +++ b/interfaces/v4.QueueEventsOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • QueueEventsOptions
    +
  • Defined in interfaces/queue-options.ts:75
    • @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:79

    • Optional blockingConnection

    blockingConnection?: boolean
    @@ -62,7 +62,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:27

    • Optional blockingTimeout

    blockingTimeout?: number
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:90

    • Optional connection

    connection?: ConnectionOptions
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:17

    • Optional lastEventId

    lastEventId?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:85

    • Optional prefix

    prefix?: string
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:32

    • Optional sharedConnection

    sharedConnection?: boolean
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:22

    • Optional skipVersionCheck

    skipVersionCheck?: boolean
    @@ -119,7 +119,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:38
    • diff --git a/interfaces/v4.QueueListener.html b/interfaces/v4.QueueListener.html index a504aec828..22309c48c0 100644 --- a/interfaces/v4.QueueListener.html +++ b/interfaces/v4.QueueListener.html @@ -32,7 +32,7 @@

    Hierarchy

    • QueueListener
    +
  • Defined in classes/queue.ts:30
    • @@ -74,7 +74,7 @@
    type: Returns void
    +
  • Defined in classes/queue.ts:37

    • error

    error: ((err) => void)
    @@ -96,7 +96,7 @@
    err: Returns void
    +
  • Defined in classes/queue.ts:44

    • ioredis:close

    ioredis:close: (() => void)
    @@ -114,7 +114,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7

    • paused

    paused: (() => void)
    @@ -131,7 +131,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/queue.ts:51

    • progress

    progress: ((job, progress) => void)
    @@ -155,7 +155,7 @@
    progress: Returns void
    +
  • Defined in classes/queue.ts:58

    • removed

    removed: ((job) => void)
    @@ -177,7 +177,7 @@
    job: Returns void
    +
  • Defined in classes/queue.ts:68

    • resumed

    resumed: (() => void)
    @@ -194,7 +194,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/queue.ts:75

    • waiting

    waiting: ((job) => void)
    @@ -216,7 +216,7 @@
    job: Returns void
    +
  • Defined in classes/queue.ts:82
    • diff --git a/interfaces/v4.QueueOptions.html b/interfaces/v4.QueueOptions.html index 11f1152a89..8ffb613e88 100644 --- a/interfaces/v4.QueueOptions.html +++ b/interfaces/v4.QueueOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • QueueOptions
    +
  • Defined in interfaces/queue-options.ts:44
    • @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:27

    • Optional connection

    connection?: ConnectionOptions
    @@ -63,12 +63,12 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:17

    • Optional defaultJobOptions

    defaultJobOptions?: DefaultJobOptions
    +
  • Defined in interfaces/queue-options.ts:45

    • Optional prefix

    prefix?: string
    @@ -77,12 +77,12 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:32

    • Optional settings

    settings?: AdvancedRepeatOptions
    +
  • Defined in interfaces/queue-options.ts:62

    • Optional sharedConnection

    sharedConnection?: boolean
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:22

    • Optional skipVersionCheck

    skipVersionCheck?: boolean
    @@ -103,7 +103,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:38

    • Optional streams

    streams?: {
        events: {
            maxLen: number;
        };
    }
    @@ -125,7 +125,7 @@
    maxLen
    +
  • Defined in interfaces/queue-options.ts:50
    • diff --git a/interfaces/v4.RateLimiterOptions.html b/interfaces/v4.RateLimiterOptions.html index 3d9843a426..f35156677f 100644 --- a/interfaces/v4.RateLimiterOptions.html +++ b/interfaces/v4.RateLimiterOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • RateLimiterOptions
    +
  • Defined in interfaces/rate-limiter-options.ts:1
    • @@ -42,7 +42,7 @@

    duration

    +
  • Defined in interfaces/rate-limiter-options.ts:12

    • max

    max: number
    @@ -51,7 +51,7 @@

    max

    +
  • Defined in interfaces/rate-limiter-options.ts:6
    • diff --git a/interfaces/v4.RawCommand.html b/interfaces/v4.RawCommand.html index 50a2b644ae..241715daab 100644 --- a/interfaces/v4.RawCommand.html +++ b/interfaces/v4.RawCommand.html @@ -21,7 +21,7 @@

    Hierarchy

    • RawCommand
    +
  • Defined in classes/redis-connection.ts:25
    • @@ -39,17 +39,17 @@

    Properties

    content

    content: string
    +
  • Defined in classes/redis-connection.ts:26

    • keys

    keys: number
    +
  • Defined in classes/redis-connection.ts:28

    • name

    name: string
    +
  • Defined in classes/redis-connection.ts:27
    • diff --git a/interfaces/v4.RepeatBaseOptions.html b/interfaces/v4.RepeatBaseOptions.html index 908fd82fc3..15e2c6f65a 100644 --- a/interfaces/v4.RepeatBaseOptions.html +++ b/interfaces/v4.RepeatBaseOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RepeatBaseOptions
    +
  • Defined in interfaces/queue-options.ts:68
    • @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:27

    • Optional connection

    connection?: ConnectionOptions
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:17

    • Optional prefix

    prefix?: string
    @@ -70,12 +70,12 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:32

    • Optional settings

    settings?: AdvancedRepeatOptions
    +
  • Defined in interfaces/queue-options.ts:69

    • Optional sharedConnection

    sharedConnection?: boolean
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:22

    • Optional skipVersionCheck

    skipVersionCheck?: boolean
    @@ -96,7 +96,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:38
    • diff --git a/interfaces/v4.RepeatOptions.html b/interfaces/v4.RepeatOptions.html index 396b9e86d8..01971c80c7 100644 --- a/interfaces/v4.RepeatOptions.html +++ b/interfaces/v4.RepeatOptions.html @@ -29,7 +29,7 @@

    Hierarchy

    • RepeatOptions
    +
  • Defined in interfaces/repeat-options.ts:8
    • @@ -55,7 +55,7 @@

    Optional

    +
  • Defined in interfaces/repeat-options.ts:30

    • Optional every

    every?: number
    @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in interfaces/repeat-options.ts:21

    • Optional immediately

    immediately?: boolean
    @@ -73,12 +73,12 @@

    Optional

    +
  • Defined in interfaces/repeat-options.ts:26

    • Optional jobId

    jobId?: string
    +
  • Defined in interfaces/repeat-options.ts:33

    • Optional limit

    limit?: number
    @@ -86,12 +86,12 @@

    Optional

    +
  • Defined in interfaces/repeat-options.ts:16

    • Optional offset

    offset?: number
    +
  • Defined in interfaces/repeat-options.ts:32

    • Optional pattern

    pattern?: string
    @@ -99,12 +99,12 @@

    Optional

    +
  • Defined in interfaces/repeat-options.ts:12

    • Optional prevMillis

    prevMillis?: number
    +
  • Defined in interfaces/repeat-options.ts:31
    • diff --git a/interfaces/v4.SandboxedJob.html b/interfaces/v4.SandboxedJob.html index 9bb36c7ab2..6f00e5a25d 100644 --- a/interfaces/v4.SandboxedJob.html +++ b/interfaces/v4.SandboxedJob.html @@ -34,7 +34,7 @@

    Hierarchy

    • SandboxedJob
    +
  • Defined in interfaces/sandboxed-job.ts:7
    • @@ -70,30 +70,30 @@

    attemptsMadeattemptsMade: number

    +
  • Defined in interfaces/job-json.ts:10

    • data

    data: T
    +
  • Defined in interfaces/sandboxed-job.ts:9

    • failedReason

    failedReason: string
    +
  • Defined in interfaces/job-json.ts:14

    • Optional finishedOn

    finishedOn?: number
    +
  • Defined in interfaces/job-json.ts:11

    • id

    id: string
    +
  • Defined in interfaces/job-json.ts:5

    • log

    log: ((row) => void)
    @@ -111,7 +111,7 @@

    Parameters

    row: any

    Returns void

    +
  • Defined in interfaces/sandboxed-job.ts:12

    • moveToDelayed

    moveToDelayed: ((timestamp, token?) => Promise<void>)
    @@ -131,71 +131,71 @@
    timestamp: Optional token: string
    Optional

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:11

    • name

    name: string
    +
  • Defined in interfaces/job-json.ts:6

    • opts

    opts: JobsOptions
    +
  • Defined in interfaces/sandboxed-job.ts:10

    • Optional parent

    parent?: ParentKeys
    +
  • Defined in interfaces/job-json.ts:17

    • Optional parentKey

    parentKey?: string
    +
  • Defined in interfaces/job-json.ts:18

    • Optional processedOn

    processedOn?: number
    +
  • Defined in interfaces/job-json.ts:12

    • progress

    progress: number | object
    +
  • Defined in interfaces/job-json.ts:9

    • Optional repeatJobKey

    repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19

    • returnValue

    returnValue: R
    +
  • Defined in interfaces/sandboxed-job.ts:15

    • returnvalue

    returnvalue: string
    +
  • Defined in interfaces/job-json.ts:16

    • stacktrace

    stacktrace: string
    +
  • Defined in interfaces/job-json.ts:15

    • timestamp

    timestamp: number
    +
  • Defined in interfaces/job-json.ts:13

    • updateData

    updateData: ((data) => Promise<void>)
    @@ -213,7 +213,7 @@

    Parameters

    data: any

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:13

    • updateProgress

    updateProgress: ((value) => Promise<void>)
    @@ -231,7 +231,7 @@

    Parameters

    value: number | object

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:14
    • diff --git a/interfaces/v4.ScriptMetadata.html b/interfaces/v4.ScriptMetadata.html index bebadfde43..ed3a638f16 100644 --- a/interfaces/v4.ScriptMetadata.html +++ b/interfaces/v4.ScriptMetadata.html @@ -25,7 +25,7 @@

    Hierarchy

    • ScriptMetadata
    +
  • Defined in commands/script-loader.ts:26
    • @@ -49,7 +49,7 @@

    content

    +
  • Defined in commands/script-loader.ts:41

    • includes

    includes: ScriptMetadata[]
    @@ -57,7 +57,7 @@

    includes

    +
  • Defined in commands/script-loader.ts:49

    • name

    name: string
    @@ -65,12 +65,12 @@

    name

    +
  • Defined in commands/script-loader.ts:30

    • Optional numberOfKeys

    numberOfKeys?: number
    +
  • Defined in commands/script-loader.ts:32

    • path

    path: string
    @@ -79,7 +79,7 @@

    path

    +
  • Defined in commands/script-loader.ts:37

    • token

    token: string
    @@ -87,7 +87,7 @@

    token

    +
  • Defined in commands/script-loader.ts:45
    • diff --git a/interfaces/v4.WorkerListener.html b/interfaces/v4.WorkerListener.html index 4d0ff4f3b7..bc59628c57 100644 --- a/interfaces/v4.WorkerListener.html +++ b/interfaces/v4.WorkerListener.html @@ -32,7 +32,7 @@

    Hierarchy

    • WorkerListener
    +
  • Defined in classes/worker.ts:42
    • @@ -79,7 +79,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:52

    • closed

    closed: (() => void)
    @@ -96,7 +96,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:59

    • closing

    closing: ((msg) => void)
    @@ -118,7 +118,7 @@
    msg: Returns void
    +
  • Defined in classes/worker.ts:66

    • completed

    completed: ((job, result, prev) => void)
    @@ -144,7 +144,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:73

    • drained

    drained: (() => void)
    @@ -163,7 +163,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:86

    • error

    error: ((failedReason) => void)
    @@ -185,7 +185,7 @@
    failedReason: Returns void
    +
  • Defined in classes/worker.ts:93

    • failed

    failed: ((job, error, prev) => void)
    @@ -213,7 +213,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:102

    • ioredis:close

    ioredis:close: (() => void)
    @@ -231,7 +231,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7

    • paused

    paused: (() => void)
    @@ -248,7 +248,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:113

    • progress

    progress: ((job, progress) => void)
    @@ -275,7 +275,7 @@
    progress: Returns void
    +
  • Defined in classes/worker.ts:123

    • ready

    ready: (() => void)
    @@ -292,7 +292,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:133

    • resumed

    resumed: (() => void)
    @@ -309,7 +309,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:140

    • stalled

    stalled: ((jobId, prev) => void)
    @@ -334,7 +334,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:148
    • diff --git a/interfaces/v4.WorkerOptions.html b/interfaces/v4.WorkerOptions.html index 5d88a13604..cad019a995 100644 --- a/interfaces/v4.WorkerOptions.html +++ b/interfaces/v4.WorkerOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • WorkerOptions
    +
  • Defined in interfaces/worker-options.ts:16
    • @@ -69,7 +69,7 @@

    Default

    true
    +
  • Defined in interfaces/worker-options.ts:22

    • Optional blockingConnection

    blockingConnection?: boolean
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:27

    • Optional concurrency

    concurrency?: number
    @@ -92,7 +92,7 @@

    Default

    1
 
    See
    https://docs.bullmq.io/guide/workers/concurrency
    +
  • Defined in interfaces/worker-options.ts:31

    • Optional connection

    connection?: ConnectionOptions
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:17

    • Optional drainDelay

    drainDelay?: number
    @@ -112,7 +112,7 @@

    Default

    5
    +
  • Defined in interfaces/worker-options.ts:99

    • Optional limiter

    limiter?: RateLimiterOptions
    @@ -122,7 +122,7 @@

    OptionalSee

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

    +
  • Defined in interfaces/worker-options.ts:37

    • Optional lockDuration

    lockDuration?: number
    @@ -136,7 +136,7 @@

    Default

    30000
    +
  • Defined in interfaces/worker-options.ts:110

    • Optional lockRenewTime

    lockRenewTime?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in interfaces/worker-options.ts:118

    • Optional maxStalledCount

    maxStalledCount?: number
    @@ -159,7 +159,7 @@

    Default

    1
    +
  • Defined in interfaces/worker-options.ts:52

    • Optional metrics

    metrics?: MetricsOptions
    @@ -169,7 +169,7 @@

    OptionalSee

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

    +
  • Defined in interfaces/worker-options.ts:43

    • Optional prefix

    prefix?: string
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:32

    • Optional removeOnComplete

    removeOnComplete?: KeepJobs
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in interfaces/worker-options.ts:66

    • Optional removeOnFail

    removeOnFail?: KeepJobs
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in interfaces/worker-options.ts:73

    • Optional runRetryDelay

    runRetryDelay?: number
    @@ -209,7 +209,7 @@

    Default

    15000
    +
  • Defined in interfaces/worker-options.ts:125

    • Optional settings

    settings?: AdvancedOptions
    @@ -217,7 +217,7 @@

    Optional

    +
  • Defined in interfaces/worker-options.ts:130

    • Optional sharedConnection

    sharedConnection?: boolean
    @@ -226,7 +226,7 @@

    Optional

    +
  • Defined in interfaces/queue-options.ts:22

    • Optional skipLockRenewal

    skipLockRenewal?: boolean
    @@ -239,7 +239,7 @@

    Default

    false
    +
  • Defined in interfaces/worker-options.ts:91

    • Optional skipStalledCheck

    skipStalledCheck?: boolean
    @@ -252,7 +252,7 @@

    Default

    false
    +
  • Defined in interfaces/worker-options.ts:82

    • Optional skipVersionCheck

    skipVersionCheck?: boolean
    @@ -264,7 +264,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:38

    • Optional stalledInterval

    stalledInterval?: number
    @@ -275,7 +275,7 @@

    Default

    30000
    +
  • Defined in interfaces/worker-options.ts:59

    • Optional useWorkerThreads

    useWorkerThreads?: boolean
    @@ -288,7 +288,7 @@

    Default

    false
    +
  • Defined in interfaces/worker-options.ts:139
    • diff --git a/types/v4.BackoffStrategy.html b/types/v4.BackoffStrategy.html index a2e707690a..8b16e859a7 100644 --- a/types/v4.BackoffStrategy.html +++ b/types/v4.BackoffStrategy.html @@ -37,7 +37,7 @@
    Optional Optional job: MinimalJob
    Optional

    Returns Promise<number> | number

    +
  • Defined in types/backoff-strategy.ts:3
    • diff --git a/types/v4.BulkJobOptions.html b/types/v4.BulkJobOptions.html index 91e3b6231f..34208cfb27 100644 --- a/types/v4.BulkJobOptions.html +++ b/types/v4.BulkJobOptions.html @@ -18,7 +18,7 @@

    Type alias BulkJobOptions

    BulkJobOptions: Omit<JobsOptions, "repeat">
    +
  • Defined in interfaces/minimal-job.ts:5
    • diff --git a/types/v4.ClusterOptions.html b/types/v4.ClusterOptions.html index bbbd4127aa..cef350e1e5 100644 --- a/types/v4.ClusterOptions.html +++ b/types/v4.ClusterOptions.html @@ -18,7 +18,7 @@

    Type alias ClusterOptions

    ClusterOptions: IORedis.ClusterOptions & BaseOptions
    +
  • Defined in interfaces/redis-options.ts:9
    • diff --git a/types/v4.ConnectionOptions.html b/types/v4.ConnectionOptions.html index f243718eb8..d0ed851376 100644 --- a/types/v4.ConnectionOptions.html +++ b/types/v4.ConnectionOptions.html @@ -18,7 +18,7 @@

    Type alias ConnectionOptions

    ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster
    +
  • Defined in interfaces/redis-options.ts:11
    • diff --git a/types/v4.EntryId.html b/types/v4.EntryId.html index 84d3ebc13f..40beb9a0b4 100644 --- a/types/v4.EntryId.html +++ b/types/v4.EntryId.html @@ -18,7 +18,7 @@

    Type alias EntryId

    EntryId: string
    +
  • Defined in interfaces/redis-streams.ts:6
    • diff --git a/types/v4.EntryRaw.html b/types/v4.EntryRaw.html index b2873ef1f6..52623269dd 100644 --- a/types/v4.EntryRaw.html +++ b/types/v4.EntryRaw.html @@ -18,7 +18,7 @@

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]
    +
  • Defined in interfaces/redis-streams.ts:7
    • diff --git a/types/v4.FinishedPropValAttribute.html b/types/v4.FinishedPropValAttribute.html index ec86e21437..1d7c0eb431 100644 --- a/types/v4.FinishedPropValAttribute.html +++ b/types/v4.FinishedPropValAttribute.html @@ -18,7 +18,7 @@

    Type alias FinishedPropValAttribute

    FinishedPropValAttribute: "returnvalue" | "failedReason"
    +
  • Defined in types/finished-status.ts:3
    • diff --git a/types/v4.FinishedStatus.html b/types/v4.FinishedStatus.html index aba6ea98a0..cb31120ff0 100644 --- a/types/v4.FinishedStatus.html +++ b/types/v4.FinishedStatus.html @@ -18,7 +18,7 @@

    Type alias FinishedStatus

    FinishedStatus: "completed" | "failed"
    +
  • Defined in types/finished-status.ts:1
    • diff --git a/types/v4.FlowChildJob.html b/types/v4.FlowChildJob.html index 39be4d67d9..173454b758 100644 --- a/types/v4.FlowChildJob.html +++ b/types/v4.FlowChildJob.html @@ -18,7 +18,7 @@

    Type alias FlowChildJob

    FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>
    +
  • Defined in interfaces/flow-job.ts:13
    • diff --git a/types/v4.FlowJob.html b/types/v4.FlowJob.html index 16840ec3fb..6d5a137b6a 100644 --- a/types/v4.FlowJob.html +++ b/types/v4.FlowJob.html @@ -18,7 +18,7 @@

    Type alias FlowJob

    FlowJob: FlowJobBase<JobsOptions>
    +
  • Defined in interfaces/flow-job.ts:15
    • diff --git a/types/v4.FlowQueuesOpts.html b/types/v4.FlowQueuesOpts.html index b957fc72d8..06c822c576 100644 --- a/types/v4.FlowQueuesOpts.html +++ b/types/v4.FlowQueuesOpts.html @@ -18,7 +18,7 @@

    Type alias FlowQueuesOpts

    FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>
    +
  • Defined in interfaces/flow-job.ts:17
    • diff --git a/types/v4.JobData.html b/types/v4.JobData.html index 8456b702d4..5c73cb95a3 100644 --- a/types/v4.JobData.html +++ b/types/v4.JobData.html @@ -18,7 +18,7 @@

    Type alias JobData

    JobData: [JobJsonRaw | number, string?]
    +
  • Defined in classes/scripts.ts:38
    • diff --git a/types/v4.JobJsonSandbox.html b/types/v4.JobJsonSandbox.html index 288d7ebb70..c7a58b9f6b 100644 --- a/types/v4.JobJsonSandbox.html +++ b/types/v4.JobJsonSandbox.html @@ -25,7 +25,7 @@
    prefix
    queueName: string
    +
  • Defined in types/job-json-sandbox.ts:3
    • diff --git a/types/v4.JobState.html b/types/v4.JobState.html index ac59a6d5e3..7cb994c11b 100644 --- a/types/v4.JobState.html +++ b/types/v4.JobState.html @@ -18,7 +18,7 @@

    Type alias JobState

    JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"
    +
  • Defined in types/job-type.ts:3
    • diff --git a/types/v4.JobType.html b/types/v4.JobType.html index 70b1d9a71d..94edee39c9 100644 --- a/types/v4.JobType.html +++ b/types/v4.JobType.html @@ -18,7 +18,7 @@

    Type alias JobType

    JobType: JobState | "paused" | "repeat" | "wait"
    +
  • Defined in types/job-type.ts:11
    • diff --git a/types/v4.JobsOptions.html b/types/v4.JobsOptions.html index aff7dc156d..3f59b7426b 100644 --- a/types/v4.JobsOptions.html +++ b/types/v4.JobsOptions.html @@ -31,7 +31,7 @@
    Optional
    +
  • Defined in types/job-options.ts:3
    • diff --git a/types/v4.KeysMap.html b/types/v4.KeysMap.html index 80879906b1..925c3ff982 100644 --- a/types/v4.KeysMap.html +++ b/types/v4.KeysMap.html @@ -18,7 +18,7 @@

    Type alias KeysMap

    KeysMap: {
        [index in string]: string
    }
    +
  • Defined in classes/queue-keys.ts:1
    • diff --git a/types/v4.MinimalQueue.html b/types/v4.MinimalQueue.html index 5fb1d49eb3..6c553a9834 100644 --- a/types/v4.MinimalQueue.html +++ b/types/v4.MinimalQueue.html @@ -18,7 +18,7 @@

    Type alias MinimalQueue

    MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">
    +
  • Defined in types/minimal-queue.ts:3
    • diff --git a/types/v4.ParentOpts.html b/types/v4.ParentOpts.html index 3bc63d63d0..db47821d86 100644 --- a/types/v4.ParentOpts.html +++ b/types/v4.ParentOpts.html @@ -27,7 +27,7 @@
    Optional
    Optional waitChildrenKey?: string
    +
  • Defined in interfaces/parent.ts:18
    • diff --git a/types/v4.Processor.html b/types/v4.Processor.html index 94211edc44..fad8931f72 100644 --- a/types/v4.Processor.html +++ b/types/v4.Processor.html @@ -45,7 +45,7 @@
    Optional Returns Promise<R>
    +
  • Defined in interfaces/worker-options.ts:11
    • diff --git a/types/v4.RedisClient.html b/types/v4.RedisClient.html index e52237f3d8..bf6072fb66 100644 --- a/types/v4.RedisClient.html +++ b/types/v4.RedisClient.html @@ -18,7 +18,7 @@

    Type alias RedisClient

    RedisClient: Redis | Cluster
    +
  • Defined in interfaces/connection.ts:4
    • diff --git a/types/v4.RedisJobOptions.html b/types/v4.RedisJobOptions.html index b56cd6dd46..375881354c 100644 --- a/types/v4.RedisJobOptions.html +++ b/types/v4.RedisJobOptions.html @@ -39,7 +39,7 @@
    Optional
    +
  • Defined in types/job-options.ts:18
    • diff --git a/types/v4.RedisOptions.html b/types/v4.RedisOptions.html index 3b502d9f4b..2e13cbd646 100644 --- a/types/v4.RedisOptions.html +++ b/types/v4.RedisOptions.html @@ -18,7 +18,7 @@

    Type alias RedisOptions

    RedisOptions: IORedis.RedisOptions & BaseOptions
    +
  • Defined in interfaces/redis-options.ts:7
    • diff --git a/types/v4.RepeatStrategy.html b/types/v4.RepeatStrategy.html index c29908bbf3..b17dda1b0c 100644 --- a/types/v4.RepeatStrategy.html +++ b/types/v4.RepeatStrategy.html @@ -35,7 +35,7 @@
    opts: Optional name: string
    Optional

    Returns number

    +
  • Defined in types/repeat-strategy.ts:3
    • diff --git a/types/v4.SandboxedJobProcessor.html b/types/v4.SandboxedJobProcessor.html index ae28972c1b..86c342a787 100644 --- a/types/v4.SandboxedJobProcessor.html +++ b/types/v4.SandboxedJobProcessor.html @@ -69,7 +69,7 @@

    Returns voidSee

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

    +
  • Defined in interfaces/sandboxed-job-processor.ts:6
    • diff --git a/types/v4.StreamName.html b/types/v4.StreamName.html index c6315feb1d..aed79375b0 100644 --- a/types/v4.StreamName.html +++ b/types/v4.StreamName.html @@ -18,7 +18,7 @@

    Type alias StreamName

    StreamName: string
    +
  • Defined in interfaces/redis-streams.ts:5
    • diff --git a/types/v4.StreamReadRaw.html b/types/v4.StreamReadRaw.html index 5c769ecebb..a077d5f29e 100644 --- a/types/v4.StreamReadRaw.html +++ b/types/v4.StreamReadRaw.html @@ -18,7 +18,7 @@

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined
    +
  • Defined in interfaces/redis-streams.ts:8
    • diff --git a/variables/v4.DELAY_TIME_1.html b/variables/v4.DELAY_TIME_1.html index c0cf20df51..57f36038f0 100644 --- a/variables/v4.DELAY_TIME_1.html +++ b/variables/v4.DELAY_TIME_1.html @@ -18,7 +18,7 @@

    Variable DELAY_TIME_1Const

    DELAY_TIME_1: 100 = 100
    +
  • Defined in utils.ts:126
    • diff --git a/variables/v4.DELAY_TIME_5.html b/variables/v4.DELAY_TIME_5.html index 4b3780f569..c1d7e6bcbc 100644 --- a/variables/v4.DELAY_TIME_5.html +++ b/variables/v4.DELAY_TIME_5.html @@ -18,7 +18,7 @@

    Variable DELAY_TIME_5Const

    DELAY_TIME_5: 5000 = 5000
    +
  • Defined in utils.ts:124
    • diff --git a/variables/v4.PRIORITY_LIMIT.html b/variables/v4.PRIORITY_LIMIT.html index e211ccbe56..8d4dfddb51 100644 --- a/variables/v4.PRIORITY_LIMIT.html +++ b/variables/v4.PRIORITY_LIMIT.html @@ -18,7 +18,7 @@

    Variable PRIORITY_LIMITConst

    PRIORITY_LIMIT: number = ...
    +
  • Defined in classes/job.ts:48
    • diff --git a/variables/v4.QUEUE_EVENT_SUFFIX.html b/variables/v4.QUEUE_EVENT_SUFFIX.html index 81ea7471f7..9953fd7d66 100644 --- a/variables/v4.QUEUE_EVENT_SUFFIX.html +++ b/variables/v4.QUEUE_EVENT_SUFFIX.html @@ -18,7 +18,7 @@

    Variable QUEUE_EVENT_SUFFIXConst

    QUEUE_EVENT_SUFFIX: ":qe" = ':qe'
    +
  • Defined in utils.ts:199
    • diff --git a/variables/v4.WORKER_SUFFIX.html b/variables/v4.WORKER_SUFFIX.html index 04d9ed7b4f..c228af35e0 100644 --- a/variables/v4.WORKER_SUFFIX.html +++ b/variables/v4.WORKER_SUFFIX.html @@ -18,7 +18,7 @@

    Variable WORKER_SUFFIXConst

    WORKER_SUFFIX: "" = ''
    +
  • Defined in utils.ts:197
    • diff --git a/variables/v4.clientCommandMessageReg.html b/variables/v4.clientCommandMessageReg.html index d62c3d938a..5001e3ef0a 100644 --- a/variables/v4.clientCommandMessageReg.html +++ b/variables/v4.clientCommandMessageReg.html @@ -18,7 +18,7 @@

    Variable clientCommandMessageRegConst

    clientCommandMessageReg: RegExp = ...
    +
  • Defined in utils.ts:121
    • diff --git a/variables/v4.errorObject.html b/variables/v4.errorObject.html index d5c028aca3..ff6fee3b27 100644 --- a/variables/v4.errorObject.html +++ b/variables/v4.errorObject.html @@ -23,7 +23,7 @@

    Type declaration

  • [index: string]: any
    • +
  • Defined in utils.ts:12
    • diff --git a/variables/v4.scriptLoader-1.html b/variables/v4.scriptLoader-1.html index 3319ba39f5..0068b26b9a 100644 --- a/variables/v4.scriptLoader-1.html +++ b/variables/v4.scriptLoader-1.html @@ -18,7 +18,7 @@

    Variable scriptLoaderConst

    scriptLoader: ScriptLoader = ...
    +
  • Defined in commands/index.ts:4