diff --git a/classes/v4.AsyncFifoQueue.html b/classes/v4.AsyncFifoQueue.html index d26a9de521..5503ffc92e 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
  • +
  • Defined in classes/async-fifo-queue.ts:84
  • +
  • Defined in classes/async-fifo-queue.ts:55
  • +
  • Defined in classes/async-fifo-queue.ts:59
  • +
  • Defined in classes/async-fifo-queue.ts:51
  • +
  • Defined in classes/async-fifo-queue.ts:47
  • Returns BackoffOptions

    +
  • Defined in classes/backoffs.ts:23
  • +
  • Defined in classes/child-pool.ts:13
  • 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 @@
    +
  • Defined in classes/child-pool.ts:72
  • +
  • Defined in classes/child-pool.ts:84
  • Returns Child[]

    +
  • Defined in classes/child-pool.ts:80
  • Returns Promise<void>

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

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

    +
  • Defined in classes/child-pool.ts:53
  • Returns Promise<Child>

    +
  • Defined in classes/child-pool.ts:23
  • Returns Promise<void>

    +
  • Defined in classes/child-processor.ts:26
  • Returns Promise<void>

    +
  • Defined in classes/child-processor.ts:63
  • +
  • Defined in classes/child-processor.ts:91
  • +
  • Defined in classes/child-processor.ts:93
  • +
  • Defined in classes/flow-producer.ts:93
  • Accessors

    @@ -135,7 +135,7 @@
    +
  • Defined in classes/flow-producer.ts:220
  • Methods

    @@ -164,7 +164,7 @@
    Optional Returns Promise<JobNode>
    +
  • Defined in classes/flow-producer.ts:169
  • +
  • Defined in classes/flow-producer.ts:245
  • +
  • Defined in classes/flow-producer.ts:456
  • +
  • Defined in classes/flow-producer.ts:463
  • +
  • Defined in classes/flow-producer.ts:128
  • +
  • Defined in classes/flow-producer.ts:202
  • +
  • Defined in classes/flow-producer.ts:135
  • +
  • Defined in classes/flow-producer.ts:143
  • +
  • Defined in classes/flow-producer.ts:151
  • +
  • Defined in classes/job.ts:105
  • data: DataType
    @@ -178,7 +178,7 @@
    +
  • Defined in classes/job.ts:158
  • delay: number
    @@ -190,7 +190,7 @@

    Default Value

    0
     
    +
  • Defined in classes/job.ts:94
  • failedReason: string
    @@ -199,7 +199,7 @@
    +
  • Defined in classes/job.ts:110
  • finishedOn?: number
    @@ -208,13 +208,13 @@
    +
  • Defined in classes/job.ts:115
  • id?: string
    +
  • Defined in classes/job.ts:164
  • name: NameType
    @@ -223,7 +223,7 @@
    +
  • Defined in classes/job.ts:153
  • opts: JobsOptions = {}
    @@ -232,7 +232,7 @@
    +
  • Defined in classes/job.ts:163
  • parent?: ParentKeys
    @@ -241,7 +241,7 @@
    +
  • Defined in classes/job.ts:130
  • parentKey?: string
    @@ -250,7 +250,7 @@
    +
  • Defined in classes/job.ts:125
  • processedOn?: number
    @@ -259,7 +259,7 @@
    +
  • Defined in classes/job.ts:120
  • progress: number | object = 0
    @@ -271,7 +271,7 @@

    Default Value

    0
     
    +
  • Defined in classes/job.ts:76
  • queueQualifiedName: string
    @@ -282,7 +282,7 @@

    See

    Implementation of MinimalJob.queueQualifiedName

    +
  • Defined in classes/job.ts:70
  • repeatJobKey?: string
    @@ -291,7 +291,7 @@
    +
  • Defined in classes/job.ts:135
  • returnvalue: ReturnType = null
    @@ -303,7 +303,7 @@

    Default Value

    null
    +
  • Defined in classes/job.ts:82
  • stacktrace: string[] = null
    @@ -315,7 +315,7 @@

    Default Value

    null
    +
  • Defined in classes/job.ts:88
  • timestamp: number
    @@ -324,7 +324,7 @@
    +
  • Defined in classes/job.ts:99
  • token?: string
    @@ -332,7 +332,7 @@
    +
  • Defined in classes/job.ts:140
  • Accessors

    @@ -345,7 +345,7 @@

    Returns string

    +
  • Defined in classes/job.ts:748
    • @@ -356,7 +356,7 @@

      Returns string

    +
  • Defined in classes/job.ts:741
  • Methods

    @@ -376,7 +376,7 @@
    Optional Returns Promise<string>
    +
  • Defined in classes/job.ts:1106
  • +
  • Defined in classes/job.ts:423
  • +
  • Defined in classes/job.ts:465
  • +
  • Defined in classes/job.ts:768
  • +
  • Defined in classes/job.ts:778
  • +
  • Defined in classes/job.ts:510
  • +
  • Defined in classes/job.ts:1084
  • +
  • Defined in classes/job.ts:550
  • +
  • Defined in classes/job.ts:790
  • +
  • Defined in classes/job.ts:812
  • +
  • Defined in classes/job.ts:904
  • +
  • Defined in classes/job.ts:758
  • +
  • Defined in classes/job.ts:727
  • +
  • Defined in classes/job.ts:699
  • +
  • Defined in classes/job.ts:713
  • +
  • Defined in classes/job.ts:706
  • +
  • Defined in classes/job.ts:734
  • +
  • Defined in classes/job.ts:720
  • +
  • Defined in classes/job.ts:501
  • +
  • Defined in classes/job.ts:563
  • +
  • Defined in classes/job.ts:1028
  • +
  • Defined in classes/job.ts:601
  • +
  • Defined in classes/job.ts:1045
  • +
  • Defined in classes/job.ts:1055
  • +
  • Defined in classes/job.ts:528
  • +
  • Defined in classes/job.ts:1072
    • @@ -833,7 +833,7 @@
    +
  • Defined in classes/job.ts:414
  • +
  • Defined in classes/job.ts:478
  • +
  • Defined in classes/job.ts:489
  • +
  • Defined in classes/job.ts:956
  • +
  • Defined in classes/job.ts:389
  • +
  • Defined in classes/job.ts:205
  • +
  • Defined in classes/job.ts:232
  • +
  • Defined in classes/job.ts:361
  • +
  • Defined in classes/job.ts:279
  • +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -185,13 +185,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -210,12 +210,12 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • token: string = ...
    +
  • Defined in classes/queue.ts:97
  • Accessors

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue.ts:167
  • +
  • Defined in classes/queue-base.ts:97
  • +
  • Defined in classes/queue.ts:171
  • Methods

    @@ -291,7 +291,7 @@
    Optional Returns Promise<Job<DataType, ResultType, NameType>>
    +
  • Defined in classes/queue.ts:191
  • +
  • Defined in classes/queue.ts:231
  • +
  • Defined in classes/queue.ts:384
  • +
  • Defined in classes/queue.ts:413
  • +
  • Defined in classes/queue.ts:268
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue.ts:399
  • +
  • Defined in classes/queue.ts:133
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:186
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:165
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:179
  • +
  • Defined in classes/queue-getters.ts:289
  • +
  • Defined in classes/queue-getters.ts:172
  • +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:127
  • +
  • Defined in classes/queue-getters.ts:137
  • +
  • Defined in classes/queue-getters.ts:366
  • +
  • Defined in classes/queue-getters.ts:158
  • +
  • Defined in classes/queue-getters.ts:339
  • +
  • Defined in classes/queue-getters.ts:454
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:193
  • +
  • Defined in classes/queue-getters.ts:432
  • +
  • Defined in classes/queue-getters.ts:296
  • +
  • Defined in classes/queue-getters.ts:114
    • @@ -903,7 +903,7 @@
      Optional Returns Promise<{
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>
    +
  • Defined in classes/queue.ts:304
  • +
  • Defined in classes/queue-getters.ts:216
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:207
  • +
  • Defined in classes/queue-getters.ts:200
  • +
  • Defined in classes/queue-getters.ts:418
  • +
  • Defined in classes/queue.ts:290
  • +
  • Defined in classes/queue.ts:460
  • +
  • Defined in classes/queue.ts:140
  • +
  • Defined in classes/queue.ts:148
  • +
  • Defined in classes/queue.ts:156
  • +
  • Defined in classes/queue.ts:259
  • +
  • Defined in classes/queue.ts:504
  • +
  • Defined in classes/queue.ts:358
    • @@ -1170,7 +1170,7 @@
    +
  • Defined in classes/queue.ts:524
  • +
  • Defined in classes/queue.ts:321
  • +
  • Defined in classes/queue.ts:342
  • +
  • Defined in classes/queue.ts:282
  • +
  • Defined in classes/queue.ts:483
  • +
  • Defined in classes/queue.ts:516
  • +
  • Defined in classes/queue.ts:368
  • +
  • Defined in classes/queue-base.ts:129
  • +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -129,13 +129,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -154,7 +154,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -168,7 +168,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-base.ts:158
    • @@ -226,7 +226,7 @@

      Returns booleanImplementation of MinimalQueue.emit

      Overrides EventEmitter.emit

    +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/queue-base.ts:129
  • +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

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

    Returns Promise<

    +
  • Defined in classes/queue-events.ts:304
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue-events.ts:196
  • +
  • Defined in classes/queue-events.ts:203
  • +
  • Defined in classes/queue-events.ts:211
  • +
  • Defined in classes/queue-events.ts:219
  • +
  • Defined in classes/queue-events.ts:231
  • +
  • Defined in classes/queue-base.ts:129
  • +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -165,13 +165,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -190,7 +190,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -204,7 +204,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:186
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:165
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:179
  • +
  • Defined in classes/queue-getters.ts:289
  • +
  • Defined in classes/queue-getters.ts:172
    • @@ -428,7 +428,7 @@

      Parameters

      jobId: string

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

    +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:127
  • +
  • Defined in classes/queue-getters.ts:137
  • +
  • Defined in classes/queue-getters.ts:366
  • +
  • Defined in classes/queue-getters.ts:158
  • +
  • Defined in classes/queue-getters.ts:339
  • +
  • Defined in classes/queue-getters.ts:454
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:193
  • +
  • Defined in classes/queue-getters.ts:432
    • @@ -654,7 +654,7 @@
      end: asc: boolean = false

    Returns Promise<string[]>

    +
  • Defined in classes/queue-getters.ts:296
  • +
  • Defined in classes/queue-getters.ts:114
  • +
  • Defined in classes/queue-getters.ts:216
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:207
  • +
  • Defined in classes/queue-getters.ts:200
  • +
  • Defined in classes/queue-getters.ts:418
  • +
  • Defined in classes/queue-base.ts:129
  • Returns KeysMap

    +
  • Defined in classes/queue-keys.ts:6
    • @@ -90,7 +90,7 @@

      Parameters

      name: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:37
    • @@ -105,7 +105,7 @@
      name: type: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:33
  • +
  • Defined in classes/redis-connection.ts:128
  • +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

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

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

    +
  • Defined in classes/repeat.ts:27
  • +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/repeat.ts:202
    • @@ -266,7 +266,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
  • Returns Promise<number>

    +
  • Defined in classes/repeat.ts:143
    • @@ -296,7 +296,7 @@

      Parameters

      repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/repeat.ts:159
  • +
  • Defined in classes/queue-base.ts:129
  • +
  • Defined in commands/script-loader.ts:134
  • Returns Promise<string>

    +
  • Defined in classes/scripts.ts:74
    • @@ -131,7 +131,7 @@
      jobId: delay: number

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:503
    • @@ -148,7 +148,7 @@
      priority: lifo: boolean = false

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:535
  • +
  • Defined in classes/scripts.ts:704
    • @@ -182,7 +182,7 @@

      Parameters

      delayed: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:369
    • @@ -201,7 +201,7 @@
      duration: Optional client: ChainableCommander | RedisClient

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:193
    • @@ -220,7 +220,7 @@
      command: Optional state: string

    Returns Error

    +
  • Defined in classes/scripts.ts:326
    • @@ -233,7 +233,7 @@

      Parameters

      types: JobType[]

    Returns Promise<number[]>

    +
  • Defined in classes/scripts.ts:419
    • @@ -252,7 +252,7 @@
      end: asc: boolean = false

    Returns Promise<[string][]>

    +
  • Defined in classes/scripts.ts:394
    • @@ -265,7 +265,7 @@

      Parameters

      jobId: string

    Returns Promise<"unknown" | JobState>

    +
  • Defined in classes/scripts.ts:481
    • @@ -280,7 +280,7 @@
      jobId: returnValue: boolean = false

    Returns Promise<number | [number, string]>

    +
  • Defined in classes/scripts.ts:466
    • @@ -295,7 +295,7 @@
      listKey: jobId: string

    Returns Promise<boolean>

    +
  • Defined in classes/scripts.ts:63
  • +
  • Defined in classes/scripts.ts:933
    • @@ -334,7 +334,7 @@
    +
  • Defined in classes/scripts.ts:901
    • @@ -349,7 +349,7 @@
      token: Optional jobId: string

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:838
    • @@ -379,7 +379,7 @@
      token: fetchNext: boolean = false

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

    +
  • Defined in classes/scripts.ts:426
    • @@ -398,7 +398,7 @@
      delay: token: string = '0'

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:648
    • @@ -417,7 +417,7 @@
      token: delay: number

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:571
    • @@ -447,7 +447,7 @@
      token: fetchNext: boolean = false

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

    +
  • Defined in classes/scripts.ts:446
    • @@ -462,7 +462,7 @@
      jobId: args: (string | number | boolean | Buffer)[]

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:310
    • @@ -492,7 +492,7 @@

      Throws

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

    +
  • Defined in classes/scripts.ts:674
  • Returns string[]

    +
  • Defined in classes/scripts.ts:625
    • @@ -527,7 +527,7 @@
      countforce: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:956
    • @@ -540,7 +540,7 @@

      Parameters

      pause: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:142
    • @@ -553,7 +553,7 @@

      Parameters

      jobId: string

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:874
    • @@ -566,7 +566,7 @@

      Parameters

      count: number = 1000

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:785
    • @@ -581,7 +581,7 @@
      jobId: removeChildren: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:184
    • @@ -596,7 +596,7 @@
      repeatJobId: repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:174
  • +
  • Defined in classes/scripts.ts:806
    • @@ -649,7 +649,7 @@
      lifo: token: string

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:721
    • @@ -666,7 +666,7 @@
      count: timestamp: number = ...

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:773
    • @@ -683,7 +683,7 @@
      stacktrace: failedReason: string

    Returns string[]

    +
  • Defined in classes/scripts.ts:615
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:210
    • @@ -731,7 +731,7 @@
      jobId: progress: number | object

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:226
  • +
  • Defined in classes/queue-base.ts:41
  • @@ -153,13 +153,13 @@
    +
  • Defined in classes/worker.ts:165
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -178,7 +178,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

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

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
    • @@ -205,7 +205,7 @@

      Parameters

      concurrency: number

    Returns void

    +
  • Defined in classes/worker.ts:349
  • +
  • Defined in classes/queue-base.ts:97
  • +
  • Defined in classes/worker.ts:360
  • Methods

    @@ -250,7 +250,7 @@

    Returns Promise<

    +
  • Defined in classes/worker.ts:747
  • +
  • Defined in classes/worker.ts:574
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/worker.ts:289
  • +
  • Defined in classes/worker.ts:447
  • +
  • Defined in classes/worker.ts:722
  • +
  • Defined in classes/worker.ts:732
  • +
  • Defined in classes/worker.ts:296
  • +
  • Defined in classes/worker.ts:304
  • +
  • Defined in classes/worker.ts:312
  • +
  • Defined in classes/worker.ts:691
    • @@ -457,7 +457,7 @@

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

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

    +
  • Defined in classes/worker.ts:615
  • +
  • Defined in classes/worker.ts:496
  • +
  • Defined in classes/worker.ts:709
  • +
  • Defined in classes/worker.ts:374
  • +
  • Defined in classes/worker.ts:798
  • +
  • Defined in classes/worker.ts:344
  • +
  • Defined in classes/worker.ts:189
  • +
  • Defined in enums/child-command.ts:4
  • +
  • Defined in interfaces/queue-options.ts:7
  • +
  • Defined in enums/error-code.ts:6
  • +
  • Defined in enums/metrics-time.ts:8
  • +
  • Defined in enums/parent-command.ts:10
  • +
  • Defined in utils.ts:46
  • +
  • Defined in utils.ts:159
  • +
  • Defined in utils.ts:180
  • +
  • Defined in utils.ts:90
  • +
  • Defined in utils.ts:54
  • +
  • Defined in utils.ts:205
  • +
  • Defined in classes/repeat.ts:234
  • +
  • Defined in utils.ts:130
  • +
  • Defined in utils.ts:82
  • +
  • Defined in utils.ts:37
  • +
  • Defined in utils.ts:146
  • +
  • Defined in utils.ts:78
  • +
  • Defined in utils.ts:70
  • +
  • Defined in utils.ts:185
  • +
  • Defined in utils.ts:33
  • +
  • Defined in utils.ts:194
  • +
  • Defined in classes/scripts.ts:978
  • +
  • Defined in utils.ts:97
  • +
  • Defined in utils.ts:15
  • 🛠 Tutorials

    You can find tutorials and news in this blog: https://blog.taskforce.sh/

    -

    Official FrontEnd

    Taskforce.sh, Inc

    +

    Official FrontEnd

    Taskforce.sh, Inc

    Supercharge your queues with a professional front end:

    • Get a complete overview of all your queues.
    • @@ -56,6 +56,30 @@

      bullmq - v4.13.2

  • and many more features.
  • Sign up at Taskforce.sh

    +

    🚀 Sponsors 🚀

    + + + + + + + + +
    + + Dragonfly + + + Dragonfly is a new Redis™ drop-in replacement that is fully compatible with BullMQ and brings some important advantages over Redis™ such as massive + better performance by utilizing all CPU cores available and faster and more memory efficient data structures. Read more here on how to use it with BullMQ. +
    + + Memetria for Redis + + + If you need high quality production Redis instances for your BullMQ project, please consider subscribing to Memetria for Redis, leaders in Redis hosting that works perfectly with BullMQ. Use the promo code "BULLMQ" when signing up to help us sponsor the development of BullMQ! +
    +

    Used by

    Some notable organizations using BullMQ:

    @@ -347,6 +371,7 @@

    🛠 Tutorials
  • Official FrontEnd
  • +
  • 🚀 Sponsors 🚀
  • Used by
  • The gist
  • Feature Comparison
  • diff --git a/interfaces/v4.AddChildrenOpts.html b/interfaces/v4.AddChildrenOpts.html index 02088aeb12..287bab1605 100644 --- a/interfaces/v4.AddChildrenOpts.html +++ b/interfaces/v4.AddChildrenOpts.html @@ -21,7 +21,7 @@

    Hierarchy

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

    Properties

    multi: ChainableCommander
    +
  • Defined in classes/flow-producer.ts:35
  • nodes: FlowJob[]
    +
  • Defined in classes/flow-producer.ts:36
  • parent: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }
    @@ -62,12 +62,12 @@
    id
  • queue: string
  • +
  • Defined in classes/flow-producer.ts:37
  • queuesOpts?: FlowQueuesOpts
    +
  • Defined in classes/flow-producer.ts:44
  • +
  • Defined in classes/flow-producer.ts:31
  • +
  • Defined in interfaces/advanced-options.ts:7
  • +
  • Defined in interfaces/backoff-options.ts:10
  • +
  • Defined in interfaces/base-job-options.ts:34
  • delay?: number
    @@ -84,7 +84,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/base-job-options.ts:23
  • jobId?: string
    @@ -96,7 +96,7 @@
    +
  • Defined in interfaces/base-job-options.ts:95
  • keepLogs?: number
    @@ -105,7 +105,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -116,7 +116,7 @@

    See

    https://docs.bul

    +
  • Defined in interfaces/base-job-options.ts:41
  • 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
  • prevMillis?: number
    @@ -141,7 +141,7 @@
    +
  • Defined in interfaces/base-job-options.ts:113
  • priority?: number
    @@ -152,7 +152,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -165,7 +165,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -178,7 +178,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • repeat?: RepeatOptions
    @@ -186,7 +186,7 @@
    +
  • Defined in interfaces/base-job-options.ts:81
  • repeatJobKey?: string
    @@ -194,7 +194,7 @@
    +
  • Defined in interfaces/base-job-options.ts:86
  • sizeLimit?: number
    @@ -203,7 +203,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -212,7 +212,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -224,7 +224,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
  • +
  • Defined in classes/backoffs.ts:4
  • +
  • Defined in commands/script-loader.ts:17
  • +
  • Defined in interfaces/base-job-options.ts:23
  • keepLogs?: number
    @@ -84,7 +84,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -94,7 +94,7 @@

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

    +
  • Defined in interfaces/base-job-options.ts:41
  • priority?: number
    @@ -104,7 +104,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -116,7 +116,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -128,7 +128,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • sizeLimit?: number
    @@ -136,7 +136,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -144,7 +144,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -155,7 +155,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
  • +
  • Defined in interfaces/minimal-job.ts:19
  • +
  • Defined in interfaces/flow-job.ts:26
  • +
  • Defined in interfaces/ioredis-events.ts:7
  • +
  • Defined in interfaces/ioredis-events.ts:7
  • +
  • Defined in interfaces/metrics.ts:2
  • +
  • Defined in interfaces/minimal-job.ts:40
  • delay: number
    @@ -108,7 +108,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/minimal-job.ts:65
  • failedReason: string
    @@ -116,7 +116,7 @@
    +
  • Defined in interfaces/minimal-job.ts:78
  • finishedOn?: number
    @@ -124,12 +124,12 @@
    +
  • Defined in interfaces/minimal-job.ts:82
  • id?: string
    +
  • Defined in interfaces/minimal-job.ts:45
  • name: NameType
    @@ -137,7 +137,7 @@
    +
  • Defined in interfaces/minimal-job.ts:36
  • @@ -145,7 +145,7 @@
    +
  • Defined in interfaces/minimal-job.ts:44
  • parent?: ParentKeys
    @@ -153,7 +153,7 @@
    +
  • Defined in interfaces/minimal-job.ts:94
  • parentKey?: string
    @@ -161,7 +161,7 @@
    +
  • Defined in interfaces/minimal-job.ts:90
  • processedOn?: number
    @@ -169,7 +169,7 @@
    +
  • Defined in interfaces/minimal-job.ts:86
  • progress: number | object
    @@ -180,7 +180,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/minimal-job.ts:50
  • repeatJobKey?: string
    @@ -188,7 +188,7 @@
    +
  • Defined in interfaces/minimal-job.ts:98
  • returnvalue: ReturnType
    @@ -199,7 +199,7 @@

    Default Value

    null
    +
  • Defined in interfaces/minimal-job.ts:55
  • stacktrace: string[]
    @@ -210,7 +210,7 @@

    Default Value

    null
    +
  • Defined in interfaces/minimal-job.ts:60
  • timestamp: number
    @@ -218,7 +218,7 @@
    +
  • Defined in interfaces/minimal-job.ts:69
  • Accessors

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

    Returns string

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

    @@ -263,7 +263,7 @@
    +
  • Defined in interfaces/minimal-job.ts:103
  • +
  • Defined in interfaces/minimal-job.ts:108
  • +
  • Defined in interfaces/minimal-job.ts:126
  • +
  • Defined in interfaces/minimal-job.ts:114
  • +
  • Defined in interfaces/minimal-job.ts:120
  • +
  • Defined in interfaces/minimal-job.ts:8
  • +
  • Defined in classes/queue.ts:22
  • +
  • Defined in interfaces/queue-options.ts:33
  • +
  • Defined in classes/queue-events.ts:29
  • cleaned: ((args, id) => void)
    @@ -136,7 +136,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:36
  • completed: ((args, id) => void)
    @@ -167,7 +167,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:43
  • delayed: ((args, id) => void)
    @@ -196,7 +196,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:53
  • drained: ((id) => void)
    @@ -220,7 +220,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:62
  • duplicated: ((args, id) => void)
    @@ -247,7 +247,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:69
  • error: ((args) => void)
    @@ -269,7 +269,7 @@
    args: Returns void
    +
  • Defined in classes/queue-events.ts:76
  • failed: ((args, id) => void)
    @@ -300,7 +300,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:83
  • ioredis:close: (() => void)
    @@ -318,7 +318,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: ((args, id) => void)
    @@ -343,7 +343,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:93
  • progress: ((args, id) => void)
    @@ -375,7 +375,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:103
  • removed: ((args, id) => void)
    @@ -405,7 +405,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:114
  • resumed: ((args, id) => void)
    @@ -430,7 +430,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:121
  • retries-exhausted: ((args, id) => void)
    @@ -459,7 +459,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:128
  • stalled: ((args, id) => void)
    @@ -488,7 +488,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:140
  • waiting: ((args, id) => void)
    @@ -517,7 +517,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:147
  • waiting-children: ((args, id) => void)
    @@ -544,7 +544,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:154
  • +
  • Defined in interfaces/queue-options.ts:17
  • lastEventId?: string
    @@ -88,7 +88,7 @@
    +
  • Defined in interfaces/queue-options.ts:80
  • prefix?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • skipVersionCheck?: boolean
    @@ -109,7 +109,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • +
  • Defined in classes/queue.ts:44
  • ioredis:close: (() => void)
    @@ -114,7 +114,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: (() => void)
    @@ -131,7 +131,7 @@

    Type declaration

    Returns void

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

    Type declaration

    Returns void

    +
  • Defined in classes/queue.ts:75
  • waiting: ((job) => void)
    @@ -216,7 +216,7 @@
    job: Returns void
    +
  • Defined in classes/queue.ts:82
  • +
  • Defined in interfaces/queue-options.ts:17
  • defaultJobOptions?: DefaultJobOptions
    +
  • Defined in interfaces/queue-options.ts:40
  • prefix?: string
    @@ -76,12 +76,12 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • +
  • Defined in interfaces/queue-options.ts:57
  • skipVersionCheck?: boolean
    @@ -93,7 +93,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • streams?: {
        events: {
            maxLen: number;
        };
    }
    @@ -115,7 +115,7 @@
    maxLen
    +
  • Defined in interfaces/queue-options.ts:45
  • +
  • Defined in interfaces/rate-limiter-options.ts:6
  • +
  • Defined in interfaces/queue-options.ts:17
  • prefix?: string
    @@ -69,12 +69,12 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • +
  • Defined in interfaces/queue-options.ts:64
  • skipVersionCheck?: boolean
    @@ -86,7 +86,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • Returns void

    +
  • Defined in interfaces/sandboxed-job.ts:12
  • moveToDelayed: ((timestamp, token?) => Promise<void>)
    @@ -131,71 +131,71 @@
    timestamp: Optional token: string

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:11
  • name: string
    +
  • Defined in interfaces/job-json.ts:6
  • +
  • Defined in interfaces/sandboxed-job.ts:10
  • parent?: ParentKeys
    +
  • Defined in interfaces/job-json.ts:17
  • parentKey?: string
    +
  • Defined in interfaces/job-json.ts:18
  • processedOn?: number
    +
  • Defined in interfaces/job-json.ts:12
  • progress: number | object
    +
  • Defined in interfaces/job-json.ts:9
  • repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19
  • returnValue: R
    +
  • Defined in interfaces/sandboxed-job.ts:15
  • returnvalue: string
    +
  • Defined in interfaces/job-json.ts:16
  • stacktrace: string
    +
  • Defined in interfaces/job-json.ts:15
  • timestamp: number
    +
  • Defined in interfaces/job-json.ts:13
  • updateData: ((data) => Promise<void>)
    @@ -213,7 +213,7 @@

    Parameters

    data: any

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:13
  • updateProgress: ((value) => Promise<void>)
    @@ -231,7 +231,7 @@

    Parameters

    value: number | object

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:14
  • +
  • Defined in commands/script-loader.ts:30
  • numberOfKeys?: number
    +
  • Defined in commands/script-loader.ts:32
  • path: string
    @@ -79,7 +79,7 @@
    +
  • Defined in commands/script-loader.ts:37
  • token: string
    @@ -87,7 +87,7 @@
    +
  • Defined in commands/script-loader.ts:45
  • +
  • Defined in classes/worker.ts:59
  • closing: ((msg) => void)
    @@ -118,7 +118,7 @@
    msg: Returns void
    +
  • Defined in classes/worker.ts:66
  • completed: ((job, result, prev) => void)
    @@ -144,7 +144,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:73
  • drained: (() => void)
    @@ -163,7 +163,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:86
  • error: ((failedReason) => void)
    @@ -185,7 +185,7 @@
    failedReason: Returns void
    +
  • Defined in classes/worker.ts:93
  • failed: ((job, error, prev) => void)
    @@ -213,7 +213,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:102
  • ioredis:close: (() => void)
    @@ -231,7 +231,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: (() => void)
    @@ -248,7 +248,7 @@

    Type declaration

    Returns void

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

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:133
  • resumed: (() => void)
    @@ -309,7 +309,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:140
  • stalled: ((jobId, prev) => void)
    @@ -334,7 +334,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:148
  • +
  • Defined in interfaces/queue-options.ts:22
  • concurrency?: number
    @@ -91,7 +91,7 @@

    Default

    1
     

    See

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

    +
  • Defined in interfaces/worker-options.ts:31
  • connection?: ConnectionOptions
    @@ -100,7 +100,7 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • drainDelay?: number
    @@ -111,7 +111,7 @@

    Default

    5
     
    +
  • Defined in interfaces/worker-options.ts:99
  • @@ -121,7 +121,7 @@

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

    +
  • Defined in interfaces/worker-options.ts:37
  • lockDuration?: number
    @@ -135,7 +135,7 @@

    Default

    30000
     
    +
  • Defined in interfaces/worker-options.ts:110
  • lockRenewTime?: number
    @@ -145,7 +145,7 @@
    +
  • Defined in interfaces/worker-options.ts:118
  • maxStalledCount?: number
    @@ -158,7 +158,7 @@

    Default

    1
     
    +
  • Defined in interfaces/worker-options.ts:52
  • metrics?: MetricsOptions
    @@ -168,7 +168,7 @@

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

    +
  • Defined in interfaces/worker-options.ts:43
  • prefix?: string
    @@ -177,7 +177,7 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • removeOnComplete?: KeepJobs
    @@ -187,7 +187,7 @@
    +
  • Defined in interfaces/worker-options.ts:66
  • removeOnFail?: KeepJobs
    @@ -197,7 +197,7 @@
    +
  • Defined in interfaces/worker-options.ts:73
  • runRetryDelay?: number
    @@ -208,7 +208,7 @@

    Default

    15000
     
    +
  • Defined in interfaces/worker-options.ts:125
  • settings?: AdvancedOptions
    @@ -216,7 +216,7 @@
    +
  • Defined in interfaces/worker-options.ts:130
  • skipLockRenewal?: boolean
    @@ -229,7 +229,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:91
  • skipStalledCheck?: boolean
    @@ -242,7 +242,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:82
  • skipVersionCheck?: boolean
    @@ -254,7 +254,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • stalledInterval?: number
    @@ -265,7 +265,7 @@

    Default

    30000
     
    +
  • Defined in interfaces/worker-options.ts:59
  • useWorkerThreads?: boolean
    @@ -278,7 +278,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:139
  • +
  • Defined in types/backoff-strategy.ts:3
  • +
  • Defined in interfaces/minimal-job.ts:5
  • +
  • Defined in interfaces/redis-options.ts:9
  • +
  • Defined in interfaces/redis-options.ts:11
  • +
  • Defined in interfaces/redis-streams.ts:6
  • +
  • Defined in interfaces/redis-streams.ts:7
  • +
  • Defined in types/finished-status.ts:3
  • +
  • Defined in types/finished-status.ts:1
  • +
  • Defined in interfaces/flow-job.ts:13
  • +
  • Defined in interfaces/flow-job.ts:15
  • +
  • Defined in interfaces/flow-job.ts:17
  • +
  • Defined in classes/scripts.ts:38
  • +
  • Defined in types/job-json-sandbox.ts:3
  • +
  • Defined in types/job-type.ts:3
  • +
  • Defined in types/job-type.ts:11
  • +
  • Defined in types/job-options.ts:3
  • +
  • Defined in classes/queue-keys.ts:1
  • +
  • Defined in types/minimal-queue.ts:3
  • +
  • Defined in interfaces/parent.ts:18
  • +
  • Defined in interfaces/worker-options.ts:11
  • +
  • Defined in interfaces/connection.ts:4
  • +
  • Defined in types/job-options.ts:18
  • +
  • Defined in interfaces/redis-options.ts:7
  • +
  • Defined in types/repeat-strategy.ts:3
  • +
  • Defined in interfaces/sandboxed-job-processor.ts:6
  • +
  • Defined in interfaces/redis-streams.ts:5
  • +
  • Defined in interfaces/redis-streams.ts:8
  • +
  • Defined in utils.ts:144
  • +
  • Defined in utils.ts:142
  • +
  • Defined in classes/job.ts:48
  • +
  • Defined in utils.ts:217
  • +
  • Defined in utils.ts:215
  • +
  • Defined in utils.ts:139
  • +
  • Defined in utils.ts:13
  • +
  • Defined in commands/index.ts:4