From d2a5d9f0f8843eac0818662783a576f618160f39 Mon Sep 17 00:00:00 2001 From: manast Date: Fri, 16 Aug 2024 08:03:27 +0000 Subject: [PATCH] deploy: 0e3436cedb26f92fd8339e6a3bead82f0c4a7a23 --- classes/v1.Backoffs.html | 4 +- classes/v1.ChildPool.html | 4 +- classes/v1.ChildProcessor.html | 4 +- classes/v1.FlowProducer.html | 4 +- classes/v1.Job.html | 4 +- classes/v1.Queue.html | 4 +- classes/v1.Queue3.html | 4 +- classes/v1.QueueBase.html | 4 +- classes/v1.QueueEvents.html | 4 +- classes/v1.QueueGetters.html | 4 +- classes/v1.QueueKeys.html | 4 +- classes/v1.QueueScheduler.html | 4 +- classes/v1.RedisConnection.html | 4 +- classes/v1.Repeat.html | 4 +- classes/v1.ScriptLoader.html | 4 +- classes/v1.ScriptLoaderError.html | 4 +- classes/v1.Scripts.html | 4 +- classes/v1.TimerManager.html | 4 +- classes/v1.UnrecoverableError.html | 4 +- classes/v1.Worker.html | 4 +- classes/v2.Backoffs.html | 4 +- classes/v2.ChildPool.html | 4 +- classes/v2.ChildProcessor.html | 4 +- classes/v2.FlowProducer.html | 4 +- classes/v2.Job.html | 4 +- classes/v2.Queue.html | 4 +- classes/v2.QueueBase.html | 4 +- classes/v2.QueueEvents.html | 4 +- classes/v2.QueueGetters.html | 4 +- classes/v2.QueueKeys.html | 4 +- classes/v2.RedisConnection.html | 4 +- classes/v2.Repeat.html | 4 +- classes/v2.ScriptLoader.html | 4 +- classes/v2.ScriptLoaderError.html | 4 +- classes/v2.Scripts.html | 4 +- classes/v2.TimerManager.html | 4 +- classes/v2.UnrecoverableError.html | 4 +- classes/v2.Worker.html | 4 +- classes/v3.AsyncFifoQueue.html | 4 +- classes/v3.Backoffs.html | 4 +- classes/v3.ChildPool.html | 4 +- classes/v3.ChildProcessor.html | 4 +- classes/v3.DelayedError.html | 4 +- classes/v3.FlowProducer.html | 4 +- classes/v3.Job.html | 4 +- classes/v3.Queue.html | 4 +- classes/v3.QueueBase.html | 4 +- classes/v3.QueueEvents.html | 4 +- classes/v3.QueueGetters.html | 4 +- classes/v3.QueueKeys.html | 4 +- classes/v3.RedisConnection.html | 4 +- classes/v3.Repeat.html | 4 +- classes/v3.ScriptLoader.html | 4 +- classes/v3.ScriptLoaderError.html | 4 +- classes/v3.Scripts.html | 4 +- classes/v3.UnrecoverableError.html | 4 +- classes/v3.WaitingChildrenError.html | 4 +- classes/v3.Worker.html | 4 +- classes/v4.AsyncFifoQueue.html | 4 +- classes/v4.Backoffs.html | 4 +- classes/v4.ChildPool.html | 4 +- classes/v4.ChildProcessor.html | 4 +- classes/v4.DelayedError.html | 4 +- classes/v4.FlowProducer.html | 4 +- classes/v4.Job.html | 4 +- classes/v4.Queue.html | 4 +- classes/v4.QueueBase.html | 4 +- classes/v4.QueueEvents.html | 4 +- classes/v4.QueueGetters.html | 4 +- classes/v4.QueueKeys.html | 4 +- classes/v4.RateLimitError.html | 4 +- classes/v4.RedisConnection.html | 4 +- classes/v4.Repeat.html | 4 +- classes/v4.ScriptLoader.html | 4 +- classes/v4.ScriptLoaderError.html | 4 +- classes/v4.Scripts.html | 4 +- classes/v4.UnrecoverableError.html | 4 +- classes/v4.WaitingChildrenError.html | 4 +- classes/v4.Worker.html | 4 +- classes/v5.AsyncFifoQueue.html | 6 +- classes/v5.Backoffs.html | 4 +- classes/v5.ChildPool.html | 4 +- classes/v5.ChildProcessor.html | 6 +- classes/v5.DelayedError.html | 6 +- classes/v5.FlowProducer.html | 18 +-- classes/v5.Job.html | 122 +++++++++---------- classes/v5.Queue.html | 120 +++++++++--------- classes/v5.QueueBase.html | 20 +-- classes/v5.QueueEvents.html | 22 ++-- classes/v5.QueueGetters.html | 74 +++++------ classes/v5.QueueKeys.html | 4 +- classes/v5.RateLimitError.html | 6 +- classes/v5.RedisConnection.html | 6 +- classes/v5.Repeat.html | 20 +-- classes/v5.Scripts.html | 16 +-- classes/v5.UnrecoverableError.html | 6 +- classes/v5.WaitingChildrenError.html | 6 +- classes/v5.Worker.html | 38 +++--- enums/v1.ChildCommand.html | 4 +- enums/v1.ClientType.html | 4 +- enums/v1.ErrorCode.html | 4 +- enums/v1.MetricsTime.html | 4 +- enums/v1.ParentCommand.html | 4 +- enums/v2.ChildCommand.html | 4 +- enums/v2.ClientType.html | 4 +- enums/v2.ErrorCode.html | 4 +- enums/v2.MetricsTime.html | 4 +- enums/v2.ParentCommand.html | 4 +- enums/v3.ChildCommand.html | 4 +- enums/v3.ClientType.html | 4 +- enums/v3.ErrorCode.html | 4 +- enums/v3.MetricsTime.html | 4 +- enums/v3.ParentCommand.html | 4 +- enums/v4.ChildCommand.html | 4 +- enums/v4.ClientType.html | 4 +- enums/v4.ErrorCode.html | 4 +- enums/v4.MetricsTime.html | 4 +- enums/v4.ParentCommand.html | 4 +- enums/v5.ChildCommand.html | 4 +- enums/v5.ClientType.html | 4 +- enums/v5.ErrorCode.html | 4 +- enums/v5.MetricsTime.html | 4 +- enums/v5.ParentCommand.html | 4 +- functions/v1.array2obj.html | 2 +- functions/v1.asyncSend.html | 2 +- functions/v1.childSend.html | 2 +- functions/v1.delay.html | 2 +- functions/v1.getNextMillis.html | 2 +- functions/v1.getParentKey.html | 2 +- functions/v1.isEmpty.html | 2 +- functions/v1.isNotConnectionError.html | 2 +- functions/v1.isRedisCluster.html | 2 +- functions/v1.isRedisInstance.html | 2 +- functions/v1.isRedisVersionLowerThan.html | 2 +- functions/v1.jobIdForGroup.html | 2 +- functions/v1.killAsync.html | 4 +- functions/v1.lengthInUtf8Bytes.html | 4 +- functions/v1.parentSend.html | 2 +- functions/v1.raw2jobData.html | 2 +- functions/v1.removeAllQueueData.html | 2 +- functions/v1.tryCatch.html | 2 +- functions/v2.array2obj.html | 2 +- functions/v2.asyncSend.html | 2 +- functions/v2.childSend.html | 2 +- functions/v2.delay.html | 2 +- functions/v2.getNextMillis.html | 2 +- functions/v2.getParentKey.html | 2 +- functions/v2.isEmpty.html | 2 +- functions/v2.isNotConnectionError.html | 2 +- functions/v2.isRedisCluster.html | 2 +- functions/v2.isRedisInstance.html | 2 +- functions/v2.isRedisVersionLowerThan.html | 2 +- functions/v2.jobIdForGroup.html | 2 +- functions/v2.killAsync.html | 4 +- functions/v2.lengthInUtf8Bytes.html | 4 +- functions/v2.parentSend.html | 2 +- functions/v2.raw2jobData.html | 2 +- functions/v2.removeAllQueueData.html | 2 +- functions/v2.tryCatch.html | 2 +- functions/v3.array2obj.html | 2 +- functions/v3.asyncSend.html | 2 +- functions/v3.childSend.html | 2 +- functions/v3.delay.html | 2 +- functions/v3.errorToJSON.html | 2 +- functions/v3.getNextMillis.html | 2 +- functions/v3.getParentKey.html | 2 +- functions/v3.isEmpty.html | 2 +- functions/v3.isNotConnectionError.html | 2 +- functions/v3.isRedisCluster.html | 2 +- functions/v3.isRedisInstance.html | 2 +- functions/v3.isRedisVersionLowerThan.html | 2 +- functions/v3.lengthInUtf8Bytes.html | 4 +- functions/v3.parseObjectValues.html | 2 +- functions/v3.raw2NextJobData.html | 2 +- functions/v3.removeAllQueueData.html | 2 +- functions/v3.tryCatch.html | 2 +- functions/v4.array2obj.html | 2 +- functions/v4.asyncSend.html | 2 +- functions/v4.childSend.html | 2 +- functions/v4.decreaseMaxListeners.html | 2 +- functions/v4.delay.html | 2 +- functions/v4.errorToJSON.html | 2 +- functions/v4.getNextMillis.html | 2 +- functions/v4.getParentKey.html | 2 +- functions/v4.increaseMaxListeners.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 | 4 +- functions/v4.parseObjectValues.html | 2 +- functions/v4.raw2NextJobData.html | 2 +- functions/v4.removeAllQueueData.html | 2 +- functions/v4.tryCatch.html | 2 +- functions/v5.array2obj.html | 2 +- functions/v5.asyncSend.html | 2 +- functions/v5.childSend.html | 2 +- functions/v5.decreaseMaxListeners.html | 2 +- functions/v5.delay.html | 2 +- functions/v5.errorToJSON.html | 2 +- functions/v5.getNextMillis.html | 2 +- functions/v5.getParentKey.html | 2 +- functions/v5.increaseMaxListeners.html | 2 +- functions/v5.invertObject.html | 2 +- functions/v5.isEmpty.html | 2 +- functions/v5.isNotConnectionError.html | 2 +- functions/v5.isRedisCluster.html | 2 +- functions/v5.isRedisInstance.html | 2 +- functions/v5.isRedisVersionLowerThan.html | 2 +- functions/v5.lengthInUtf8Bytes.html | 4 +- functions/v5.parseObjectValues.html | 2 +- functions/v5.raw2NextJobData.html | 2 +- functions/v5.removeAllQueueData.html | 2 +- functions/v5.toString.html | 2 +- functions/v5.tryCatch.html | 2 +- hierarchy.html | 2 +- index.html | 4 +- interfaces/v1.AddChildrenOpts.html | 4 +- interfaces/v1.AddNodeOpts.html | 4 +- interfaces/v1.AdvancedOptions.html | 4 +- interfaces/v1.AdvancedRepeatOptions.html | 4 +- interfaces/v1.BackoffOptions.html | 4 +- interfaces/v1.BaseJobOptions.html | 4 +- interfaces/v1.ChildMessage.html | 4 +- interfaces/v1.ChildProcessExt.html | 4 +- interfaces/v1.Command.html | 4 +- interfaces/v1.DependenciesOpts.html | 4 +- interfaces/v1.FlowJob.html | 4 +- interfaces/v1.FlowOpts.html | 4 +- interfaces/v1.FlowProducerListener.html | 4 +- interfaces/v1.GetNextJobOptions.html | 4 +- interfaces/v1.IConnection.html | 4 +- interfaces/v1.IoredisListener.html | 4 +- interfaces/v1.JobInformation3.html | 4 +- interfaces/v1.JobJson.html | 4 +- interfaces/v1.JobJsonRaw.html | 4 +- interfaces/v1.JobNode.html | 4 +- interfaces/v1.JobPromise3.html | 4 +- interfaces/v1.JobsOptions.html | 4 +- interfaces/v1.KeepJobs.html | 4 +- interfaces/v1.Metrics.html | 4 +- interfaces/v1.MetricsOptions.html | 4 +- interfaces/v1.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v1.NodeOpts.html | 4 +- interfaces/v1.ObliterateOpts.html | 4 +- interfaces/v1.Parent.html | 4 +- interfaces/v1.ParentKeys.html | 4 +- interfaces/v1.ParentMessage.html | 4 +- interfaces/v1.QueueBaseOptions.html | 4 +- interfaces/v1.QueueEventsListener.html | 4 +- interfaces/v1.QueueEventsOptions.html | 4 +- interfaces/v1.QueueListener.html | 4 +- interfaces/v1.QueueOptions.html | 4 +- interfaces/v1.QueueSchedulerListener.html | 4 +- interfaces/v1.QueueSchedulerOptions.html | 4 +- interfaces/v1.RateLimiterOptions.html | 4 +- interfaces/v1.RepeatBaseOptions.html | 4 +- interfaces/v1.RepeatOptions.html | 4 +- interfaces/v1.SandboxedJob.html | 4 +- interfaces/v1.ScriptMetadata.html | 4 +- interfaces/v1.Strategies.html | 2 +- interfaces/v1.WorkerListener.html | 4 +- interfaces/v1.WorkerOptions.html | 4 +- interfaces/v2.AddChildrenOpts.html | 4 +- interfaces/v2.AddNodeOpts.html | 4 +- interfaces/v2.AdvancedOptions.html | 4 +- interfaces/v2.AdvancedRepeatOptions.html | 4 +- interfaces/v2.BackoffOptions.html | 4 +- interfaces/v2.BaseJobOptions.html | 4 +- interfaces/v2.ChildMessage.html | 4 +- interfaces/v2.ChildProcessExt.html | 4 +- interfaces/v2.Command.html | 4 +- interfaces/v2.DefaultJobOptions.html | 4 +- interfaces/v2.DependenciesOpts.html | 4 +- interfaces/v2.FlowOpts.html | 4 +- interfaces/v2.FlowProducerListener.html | 4 +- interfaces/v2.GetNextJobOptions.html | 4 +- interfaces/v2.IConnection.html | 4 +- interfaces/v2.IoredisListener.html | 4 +- interfaces/v2.JobJson.html | 4 +- interfaces/v2.JobJsonRaw.html | 4 +- interfaces/v2.JobNode.html | 4 +- interfaces/v2.KeepJobs.html | 4 +- interfaces/v2.Metrics.html | 4 +- interfaces/v2.MetricsOptions.html | 4 +- interfaces/v2.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v2.NodeOpts.html | 4 +- interfaces/v2.ObliterateOpts.html | 4 +- interfaces/v2.Parent.html | 4 +- interfaces/v2.ParentKeys.html | 4 +- interfaces/v2.ParentMessage.html | 4 +- interfaces/v2.QueueBaseOptions.html | 4 +- interfaces/v2.QueueEventsListener.html | 4 +- interfaces/v2.QueueEventsOptions.html | 4 +- interfaces/v2.QueueListener.html | 4 +- interfaces/v2.QueueOptions.html | 4 +- interfaces/v2.RateLimiterOptions.html | 4 +- interfaces/v2.RawCommand.html | 4 +- interfaces/v2.RepeatBaseOptions.html | 4 +- interfaces/v2.RepeatOptions.html | 4 +- interfaces/v2.SandboxedJob.html | 4 +- interfaces/v2.ScriptMetadata.html | 4 +- interfaces/v2.Strategies.html | 2 +- interfaces/v2.WorkerListener.html | 4 +- interfaces/v2.WorkerOptions.html | 4 +- interfaces/v3.AddChildrenOpts.html | 4 +- interfaces/v3.AddNodeOpts.html | 4 +- interfaces/v3.AdvancedOptions.html | 4 +- interfaces/v3.AdvancedRepeatOptions.html | 4 +- interfaces/v3.BackoffOptions.html | 4 +- interfaces/v3.BaseJobOptions.html | 4 +- interfaces/v3.BaseOptions.html | 4 +- interfaces/v3.BuiltInStrategies.html | 2 +- interfaces/v3.ChildMessage.html | 4 +- interfaces/v3.Command.html | 4 +- interfaces/v3.DefaultJobOptions.html | 4 +- interfaces/v3.DependenciesOpts.html | 4 +- interfaces/v3.FlowJobBase.html | 4 +- interfaces/v3.FlowOpts.html | 4 +- interfaces/v3.FlowProducerListener.html | 4 +- interfaces/v3.GetNextJobOptions.html | 4 +- interfaces/v3.IConnection.html | 4 +- interfaces/v3.IoredisListener.html | 4 +- interfaces/v3.JobJson.html | 4 +- interfaces/v3.JobJsonRaw.html | 4 +- interfaces/v3.JobNode.html | 4 +- interfaces/v3.KeepJobs.html | 4 +- interfaces/v3.Metrics.html | 4 +- interfaces/v3.MetricsOptions.html | 4 +- interfaces/v3.MinimalJob.html | 4 +- interfaces/v3.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v3.NodeOpts.html | 4 +- interfaces/v3.ObliterateOpts.html | 4 +- interfaces/v3.Parent.html | 4 +- interfaces/v3.ParentKeys.html | 4 +- interfaces/v3.ParentMessage.html | 4 +- interfaces/v3.QueueBaseOptions.html | 4 +- interfaces/v3.QueueEventsListener.html | 4 +- interfaces/v3.QueueEventsOptions.html | 4 +- interfaces/v3.QueueListener.html | 4 +- interfaces/v3.QueueOptions.html | 4 +- interfaces/v3.RateLimiterOptions.html | 4 +- interfaces/v3.RawCommand.html | 4 +- interfaces/v3.RepeatBaseOptions.html | 4 +- interfaces/v3.RepeatOptions.html | 4 +- interfaces/v3.SandboxedJob.html | 4 +- interfaces/v3.ScriptMetadata.html | 4 +- interfaces/v3.WorkerListener.html | 4 +- interfaces/v3.WorkerOptions.html | 4 +- interfaces/v4.AddChildrenOpts.html | 4 +- interfaces/v4.AddNodeOpts.html | 4 +- interfaces/v4.AdvancedOptions.html | 4 +- interfaces/v4.AdvancedRepeatOptions.html | 4 +- interfaces/v4.BackoffOptions.html | 4 +- interfaces/v4.BaseJobOptions.html | 4 +- interfaces/v4.BaseOptions.html | 4 +- interfaces/v4.BuiltInStrategies.html | 2 +- interfaces/v4.ChildMessage.html | 4 +- interfaces/v4.Command.html | 4 +- interfaces/v4.DefaultJobOptions.html | 4 +- interfaces/v4.DependenciesOpts.html | 4 +- interfaces/v4.FlowJobBase.html | 4 +- interfaces/v4.FlowOpts.html | 4 +- interfaces/v4.FlowProducerListener.html | 4 +- interfaces/v4.GetNextJobOptions.html | 4 +- interfaces/v4.IConnection.html | 4 +- interfaces/v4.IoredisListener.html | 4 +- interfaces/v4.JobJson.html | 4 +- interfaces/v4.JobJsonRaw.html | 4 +- interfaces/v4.JobNode.html | 4 +- interfaces/v4.KeepJobs.html | 4 +- interfaces/v4.Metrics.html | 4 +- interfaces/v4.MetricsOptions.html | 4 +- interfaces/v4.MinimalJob.html | 4 +- interfaces/v4.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v4.NodeOpts.html | 4 +- interfaces/v4.ObliterateOpts.html | 4 +- interfaces/v4.Parent.html | 4 +- interfaces/v4.ParentKeys.html | 4 +- interfaces/v4.ParentMessage.html | 4 +- interfaces/v4.QueueBaseOptions.html | 4 +- interfaces/v4.QueueEventsListener.html | 4 +- interfaces/v4.QueueEventsOptions.html | 4 +- interfaces/v4.QueueListener.html | 4 +- interfaces/v4.QueueOptions.html | 4 +- interfaces/v4.RateLimiterOptions.html | 4 +- interfaces/v4.RawCommand.html | 4 +- interfaces/v4.RepeatBaseOptions.html | 4 +- interfaces/v4.RepeatOptions.html | 4 +- interfaces/v4.SandboxedJob.html | 4 +- interfaces/v4.ScriptMetadata.html | 4 +- interfaces/v4.WorkerListener.html | 4 +- interfaces/v4.WorkerOptions.html | 4 +- interfaces/v5.AddChildrenOpts.html | 4 +- interfaces/v5.AddNodeOpts.html | 6 +- interfaces/v5.AdvancedOptions.html | 8 +- interfaces/v5.AdvancedRepeatOptions.html | 6 +- interfaces/v5.BackoffOptions.html | 8 +- interfaces/v5.BaseJobOptions.html | 34 +++--- interfaces/v5.BaseOptions.html | 4 +- interfaces/v5.BuiltInStrategies.html | 2 +- interfaces/v5.ChildMessage.html | 4 +- interfaces/v5.DebounceOptions.html | 8 +- interfaces/v5.DefaultJobOptions.html | 24 ++-- interfaces/v5.DependenciesOpts.html | 4 +- interfaces/v5.FlowJobBase.html | 4 +- interfaces/v5.FlowOpts.html | 4 +- interfaces/v5.FlowProducerListener.html | 6 +- interfaces/v5.GetNextJobOptions.html | 4 +- interfaces/v5.IConnection.html | 4 +- interfaces/v5.IoredisListener.html | 4 +- interfaces/v5.JobJson.html | 4 +- interfaces/v5.JobJsonRaw.html | 4 +- interfaces/v5.JobNode.html | 4 +- interfaces/v5.KeepJobs.html | 8 +- interfaces/v5.Metrics.html | 4 +- interfaces/v5.MetricsOptions.html | 4 +- interfaces/v5.MinimalJob.html | 48 ++++---- interfaces/v5.MoveToDelayedOpts.html | 4 +- interfaces/v5.MoveToWaitingChildrenOpts.html | 4 +- interfaces/v5.NodeOpts.html | 12 +- interfaces/v5.ObliterateOpts.html | 6 +- interfaces/v5.Parent.html | 6 +- interfaces/v5.ParentKeys.html | 4 +- interfaces/v5.ParentMessage.html | 4 +- interfaces/v5.QueueBaseOptions.html | 12 +- interfaces/v5.QueueEventsListener.html | 40 +++--- interfaces/v5.QueueEventsOptions.html | 18 +-- interfaces/v5.QueueListener.html | 18 +-- interfaces/v5.QueueOptions.html | 14 +-- interfaces/v5.RateLimiterOptions.html | 6 +- interfaces/v5.RawCommand.html | 4 +- interfaces/v5.RepeatBaseOptions.html | 12 +- interfaces/v5.RepeatOptions.html | 16 +-- interfaces/v5.SandboxedJob.html | 6 +- interfaces/v5.WorkerListener.html | 28 ++--- interfaces/v5.WorkerOptions.html | 46 +++---- modules/v1.html | 4 +- modules/v2.html | 4 +- modules/v3.html | 4 +- modules/v4.html | 4 +- modules/v5.html | 4 +- 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 | 4 +- types/v4.KeysMap.html | 2 +- types/v4.MinimalQueue.html | 2 +- types/v4.ParentOpts.html | 2 +- types/v4.Processor.html | 4 +- types/v4.RedisClient.html | 2 +- types/v4.RedisJobOptions.html | 4 +- types/v4.RedisOptions.html | 2 +- types/v4.RepeatStrategy.html | 2 +- types/v4.RepeatableJob.html | 2 +- types/v4.SandboxedJobProcessor.html | 4 +- types/v4.StreamName.html | 2 +- types/v4.StreamReadRaw.html | 2 +- types/v5.BackoffStrategy.html | 2 +- types/v5.BulkJobOptions.html | 2 +- types/v5.ClusterOptions.html | 2 +- types/v5.ConnectionOptions.html | 2 +- types/v5.EntryId.html | 2 +- types/v5.EntryRaw.html | 2 +- types/v5.FinishedPropValAttribute.html | 2 +- types/v5.FinishedStatus.html | 2 +- types/v5.FlowChildJob.html | 2 +- types/v5.FlowJob.html | 2 +- types/v5.FlowQueuesOpts.html | 2 +- types/v5.JobData.html | 2 +- types/v5.JobJsonSandbox.html | 2 +- types/v5.JobState.html | 2 +- types/v5.JobType.html | 2 +- types/v5.JobsOptions.html | 4 +- types/v5.KeysMap.html | 2 +- types/v5.MinimalQueue.html | 2 +- types/v5.ParentOpts.html | 2 +- types/v5.Processor.html | 4 +- types/v5.RedisClient.html | 2 +- types/v5.RedisJobOptions.html | 4 +- types/v5.RedisOptions.html | 2 +- types/v5.RepeatStrategy.html | 2 +- types/v5.RepeatableJob.html | 2 +- types/v5.RepeatableOptions.html | 2 +- types/v5.SandboxedJobProcessor.html | 4 +- types/v5.StreamName.html | 2 +- types/v5.StreamReadRaw.html | 2 +- variables/v1.DELAY_TIME_1.html | 2 +- variables/v1.DELAY_TIME_5.html | 2 +- variables/v1.QUEUE_EVENT_SUFFIX.html | 2 +- variables/v1.QUEUE_SCHEDULER_SUFFIX.html | 2 +- variables/v1.WORKER_SUFFIX.html | 2 +- variables/v1.clientCommandMessageReg.html | 2 +- variables/v1.errorObject.html | 2 +- variables/v1.scriptLoader-1.html | 2 +- variables/v2.DELAY_TIME_1.html | 2 +- variables/v2.DELAY_TIME_5.html | 2 +- variables/v2.QUEUE_EVENT_SUFFIX.html | 2 +- variables/v2.QUEUE_SCHEDULER_SUFFIX.html | 2 +- variables/v2.WORKER_SUFFIX.html | 2 +- variables/v2.clientCommandMessageReg.html | 2 +- variables/v2.errorObject.html | 2 +- variables/v2.scriptLoader-1.html | 2 +- variables/v3.DELAY_TIME_1.html | 2 +- variables/v3.DELAY_TIME_5.html | 2 +- variables/v3.QUEUE_EVENT_SUFFIX.html | 2 +- variables/v3.WORKER_SUFFIX.html | 2 +- variables/v3.clientCommandMessageReg.html | 2 +- variables/v3.errorObject.html | 2 +- variables/v3.scriptLoader-1.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.RATE_LIMIT_ERROR.html | 2 +- variables/v4.WORKER_SUFFIX.html | 2 +- variables/v4.clientCommandMessageReg.html | 2 +- variables/v4.errorObject.html | 2 +- variables/v4.scriptLoader-1.html | 2 +- variables/v5.DELAY_TIME_1.html | 2 +- variables/v5.DELAY_TIME_5.html | 2 +- variables/v5.PRIORITY_LIMIT.html | 2 +- variables/v5.QUEUE_EVENT_SUFFIX.html | 2 +- variables/v5.RATE_LIMIT_ERROR.html | 2 +- variables/v5.clientCommandMessageReg.html | 2 +- variables/v5.errorObject.html | 2 +- 539 files changed, 1262 insertions(+), 1262 deletions(-) diff --git a/classes/v1.Backoffs.html b/classes/v1.Backoffs.html index 50fe26c703..b66696df04 100644 --- a/classes/v1.Backoffs.html +++ b/classes/v1.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.6

Class Backoffs

Constructors

constructor +Backoffs | bullmq - v5.12.7

Class Backoffs

Constructors

constructor

Properties

builtinStrategies

Methods

calculate normalize -

Constructors

constructor

Properties

Static builtinStrategies

builtinStrategies: BuiltInStrategies = ...

Methods

Static calculate

Static normalize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Static builtinStrategies

builtinStrategies: BuiltInStrategies = ...

Methods

Static calculate

Static normalize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ChildPool.html b/classes/v1.ChildPool.html index 3a8b8e8443..516fd8dbea 100644 --- a/classes/v1.ChildPool.html +++ b/classes/v1.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.6

Class ChildPool

Constructors

constructor +ChildPool | bullmq - v5.12.7

Class ChildPool

Constructors

constructor

Properties

free retained

Methods

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

Constructors

constructor

Properties

free

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

Type declaration

retained

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

Type declaration

Methods

clean

getAllFree

getFree

kill

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

  • Parameters

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

    Returns Promise<void>

release

remove

retain

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

free

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

Type declaration

retained

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

Type declaration

Methods

clean

getAllFree

getFree

kill

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

  • Parameters

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

    Returns Promise<void>

release

remove

retain

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ChildProcessor.html b/classes/v1.ChildProcessor.html index a3f7cc5743..ae8b552527 100644 --- a/classes/v1.ChildProcessor.html +++ b/classes/v1.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.6

Class ChildProcessor

ChildProcessor

+ChildProcessor | bullmq - v5.12.7

Class ChildProcessor

ChildProcessor

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

Constructors

constructor @@ -9,4 +9,4 @@ start stop waitForCurrentJobAndExit -

Constructors

constructor

Properties

currentJobPromise

currentJobPromise: Promise<unknown>

processor

processor: any

status

status: ChildStatus

Methods

init

start

stop

waitForCurrentJobAndExit

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

currentJobPromise

currentJobPromise: Promise<unknown>

processor

processor: any

status

status: ChildStatus

Methods

init

start

stop

waitForCurrentJobAndExit

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FlowProducer.html b/classes/v1.FlowProducer.html index 3d6875f8c2..f2100f97cf 100644 --- a/classes/v1.FlowProducer.html +++ b/classes/v1.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.6

Class FlowProducer

This class allows to add jobs with dependencies between them in such +FlowProducer | bullmq - v5.12.7

Class FlowProducer

This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent @@ -37,4 +37,4 @@ will be processed before their parents.

Returns Promise<JobNode[]>

close

disconnect

emit

getFlow

off

on

once

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<JobNode>

off

on

once

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Job.html b/classes/v1.Job.html index 66ba5a99a8..b52534d83d 100644 --- a/classes/v1.Job.html +++ b/classes/v1.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.6

Class Job<DataType, ReturnType, NameType>

Job

+Job | bullmq - v5.12.7

Class Job<DataType, ReturnType, NameType>

Job

This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

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

@@ -154,4 +154,4 @@

Type Parameters

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

Parameters

  • queue: MinimalQueue

    the queue where the job belongs to.

  • json: JobJsonRaw

    the plain object containing the job.

  • Optional jobId: string

    an optional job id (overrides the id coming from the JSON object)

    -

Returns Job<T, R, N>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Job<T, R, N>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Queue.html b/classes/v1.Queue.html index 334ceca5aa..3f8b990240 100644 --- a/classes/v1.Queue.html +++ b/classes/v1.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.6

Class Queue<DataType, ResultType, NameType>

Queue

+Queue | bullmq - v5.12.7

Class Queue<DataType, ResultType, NameType>

Queue

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

Type Parameters

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

Hierarchy (view full)

Constructors

constructor @@ -193,4 +193,4 @@

Parameters

  • opts: {
        count?: number;
        state?: FinishedStatus;
        timestamp?: number;
    } = {}

    contains number to limit how many jobs will be moved to wait status per iteration, state (failed, completed) failed by default or from which timestamp.

    • Optional count?: number
    • Optional state?: FinishedStatus
    • Optional timestamp?: number

Returns Promise<void>

trimEvents

  • trimEvents(maxLength): Promise<number>

  • Trim the event stream to an approximately maxLength.

    -

    Parameters

    • maxLength: number

    Returns Promise<number>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • maxLength: number

Returns Promise<number>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Queue3.html b/classes/v1.Queue3.html index 9803ae3ac4..0f4856523e 100644 --- a/classes/v1.Queue3.html +++ b/classes/v1.Queue3.html @@ -1,4 +1,4 @@ -Queue3 | bullmq - v5.12.6

Class Queue3<T>

Deprecated

Use Queue class instead https://docs.bullmq.io/guide/queues

+Queue3 | bullmq - v5.12.7

Class Queue3<T>

Deprecated

Use Queue class instead https://docs.bullmq.io/guide/queues

Type Parameters

  • T = any

Hierarchy

  • EventEmitter
    • Queue3

Constructors

constructor

Properties

name queueEvents @@ -143,4 +143,4 @@ instances.

Resuming a queue that is not paused does nothing.

Returns Promise<void>

resumeWorker

retryJob

setWorkerName

  • setWorkerName(): Promise<any>

  • Set clientName to Redis.client

    -

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.QueueBase.html b/classes/v1.QueueBase.html index aaa4b42a6c..56acac24a4 100644 --- a/classes/v1.QueueBase.html +++ b/classes/v1.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.6

Class QueueBase

Description

Base class for all classes that need to interact with queues. +QueueBase | bullmq - v5.12.7

Class QueueBase

Description

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

Hierarchy (view full)

Constructors

constructor

Properties

closing @@ -24,4 +24,4 @@

disconnect

emit

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

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

    Parameters

    • event: string | symbol

      The emitted event.

      -
    • Rest ...args: any[]

    Returns boolean

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

    • Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.QueueEvents.html b/classes/v1.QueueEvents.html index c7bf2039f6..727171017d 100644 --- a/classes/v1.QueueEvents.html +++ b/classes/v1.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.6

    Class QueueEvents

    The QueueEvents class is used for listening to the global events +QueueEvents | bullmq - v5.12.7

    Class QueueEvents

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

    This class requires a dedicated redis connection.

    Hierarchy (view full)

    Constructors

    constructor @@ -27,4 +27,4 @@

    Type Parameters

    Parameters

    Returns boolean

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

      -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.QueueGetters.html b/classes/v1.QueueGetters.html index 058407969d..08865c726f 100644 --- a/classes/v1.QueueGetters.html +++ b/classes/v1.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.6

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.7

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys @@ -112,4 +112,4 @@

    Returns Promise<{
        [index: string]: string;
    }[]>

    • Returns an array with workers info.
    -

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.QueueKeys.html b/classes/v1.QueueKeys.html index a6228d5153..c2d5db740d 100644 --- a/classes/v1.QueueKeys.html +++ b/classes/v1.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.6

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.7

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getPrefixedQueueName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.QueueScheduler.html b/classes/v1.QueueScheduler.html index 8eea258658..f128178ec0 100644 --- a/classes/v1.QueueScheduler.html +++ b/classes/v1.QueueScheduler.html @@ -1,4 +1,4 @@ -QueueScheduler | bullmq - v5.12.6

    Class QueueScheduler

    This class is just used for some automatic bookkeeping of the queue, +QueueScheduler | bullmq - v5.12.7

    Class QueueScheduler

    This class is just used for some automatic bookkeeping of the queue, such as updating the delay set as well as moving stalled jobs back to the waiting list.

    Jobs are checked for stallness once every "visibility window" seconds. @@ -41,4 +41,4 @@ and will not return until the scheduler is closed.

    If the QueueScheduler was instantiated with autorun: false, then it is not needed to manually call this method.

    -

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.RedisConnection.html b/classes/v1.RedisConnection.html index 83da03666c..d2a30a04e5 100644 --- a/classes/v1.RedisConnection.html +++ b/classes/v1.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.6

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.7

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

    minimumVersion

    Accessors

    client redisVersion @@ -7,4 +7,4 @@ reconnect waitUntilReady

    Constructors

    constructor

    Properties

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.Repeat.html b/classes/v1.Repeat.html index 5d48270bca..1438d748b2 100644 --- a/classes/v1.Repeat.html +++ b/classes/v1.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.6

    Class Repeat

    Description

    Base class for all classes that need to interact with queues. +Repeat | bullmq - v5.12.7

    Class Repeat

    Description

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing @@ -25,4 +25,4 @@

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          cron: string;
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          cron: string;
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.ScriptLoader.html b/classes/v1.ScriptLoader.html index e07b47382c..c2e48b4464 100644 --- a/classes/v1.ScriptLoader.html +++ b/classes/v1.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.6

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.7

    Class ScriptLoader

    Lua script loader with include support

    Constructors

    constructor

    Methods

    addPathMapping clearCache @@ -33,4 +33,4 @@

    Returns Promise<ScriptMetadata>

    resolvePath

    • resolvePath(scriptName, stack?): string

    • Resolve the script path considering path mappings

      Parameters

      • scriptName: string

        the name of the script

      • stack: string[] = []

        the include stack, for nicer errors

        -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.ScriptLoaderError.html b/classes/v1.ScriptLoaderError.html index 797f478257..37ae5ddc47 100644 --- a/classes/v1.ScriptLoaderError.html +++ b/classes/v1.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.12.6

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.7

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor

    Properties

    includes line path position

    Constructors

    constructor

    Properties

    Readonly includes

    includes: string[]

    The include stack

    -

    Readonly line

    line: number

    Readonly path

    path: string

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly line

    line: number

    Readonly path

    path: string

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.Scripts.html b/classes/v1.Scripts.html index 027a6a4c0d..1c8ae3cbef 100644 --- a/classes/v1.Scripts.html +++ b/classes/v1.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.6

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.7

    Class Scripts

    Constructors

    constructor

    Methods

    addJob changeDelay cleanJobsInSet @@ -53,4 +53,4 @@

    Throws

    JobNotInState -2 means the job was not found in the expected set

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): string[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns string[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • data: T

      Returns Promise<void>

    updateDelaySet

    • updateDelaySet(delayedTimestamp): Promise<[number, string]>

    • It checks if the job in the top of the delay set should be moved back to the top of the wait queue (so that it will be processed as soon as possible)

      -

      Parameters

      • delayedTimestamp: number

      Returns Promise<[number, string]>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • delayedTimestamp: number

    Returns Promise<[number, string]>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.TimerManager.html b/classes/v1.TimerManager.html index 03e7a61c0f..61325ec6eb 100644 --- a/classes/v1.TimerManager.html +++ b/classes/v1.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.12.6

    Class TimerManager

    Keeps track on timers created with setTimeout to help clearTimeout +TimerManager | bullmq - v5.12.7

    Class TimerManager

    Keeps track on timers created with setTimeout to help clearTimeout for all timers when no more delayed actions needed

    Constructors

    constructor

    Methods

    clearAllTimers @@ -8,4 +8,4 @@

    Parameters

    • name: string

      Readable name for the timer

    • delay: number

      Delay in milliseconds

    • fn: Function

      Callback function that is executed after the timer expires

      -

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.UnrecoverableError.html b/classes/v1.UnrecoverableError.html index 1c856357a9..f00b513c69 100644 --- a/classes/v1.UnrecoverableError.html +++ b/classes/v1.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.6

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.7

    Class UnrecoverableError

    UnrecoverableError

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

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.Worker.html b/classes/v1.Worker.html index e3d3580e26..a3a5cf18aa 100644 --- a/classes/v1.Worker.html +++ b/classes/v1.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.6

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. +Worker | bullmq - v5.12.7

    Class Worker<DataType, ResultType, NameType>

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -50,4 +50,4 @@

    Parameters

    • Optional doNotWaitActive: boolean

    Returns Promise<void>

    processJob

    • processJob(job, token, fetchNextCallback?): Promise<void | Job<DataType, ResultType, NameType>>

    • Parameters

      • job: Job<DataType, ResultType, NameType>
      • token: string
      • fetchNextCallback: (() => boolean) = ...
          • (): boolean

          • Returns boolean

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

    resume

    • resume(): void

    • Resumes processing of this worker (if paused).

      Returns void

    run

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Backoffs.html b/classes/v2.Backoffs.html index a0416a72c7..38e2b6e10c 100644 --- a/classes/v2.Backoffs.html +++ b/classes/v2.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.6

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.7

    Class Backoffs

    Constructors

    constructor

    Properties

    builtinStrategies

    Methods

    calculate normalize -

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.ChildPool.html b/classes/v2.ChildPool.html index a1d181ecea..fd57d74dd6 100644 --- a/classes/v2.ChildPool.html +++ b/classes/v2.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.6

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.7

    Class ChildPool

    Constructors

    constructor

    Properties

    free retained

    Methods

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

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    retained

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

    Type declaration

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    retained

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

    Type declaration

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.ChildProcessor.html b/classes/v2.ChildProcessor.html index eb70290d65..80bee19008 100644 --- a/classes/v2.ChildProcessor.html +++ b/classes/v2.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.6

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.7

    Class ChildProcessor

    ChildProcessor

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

    Constructors

    constructor @@ -9,4 +9,4 @@ start stop waitForCurrentJobAndExit -

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    status

    status: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    status

    status: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.FlowProducer.html b/classes/v2.FlowProducer.html index 3930ed4c18..cf2c02dfd9 100644 --- a/classes/v2.FlowProducer.html +++ b/classes/v2.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.6

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such +FlowProducer | bullmq - v5.12.7

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent @@ -37,4 +37,4 @@ will be processed before their parents.

    Returns Promise<JobNode[]>

    close

    disconnect

    emit

    getFlow

    off

    on

    once

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<JobNode>

    off

    on

    once

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Job.html b/classes/v2.Job.html index d2b3edfc44..418eb2f7ae 100644 --- a/classes/v2.Job.html +++ b/classes/v2.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.6

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.7

    Class Job<DataType, ReturnType, NameType>

    Job

    This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

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

    @@ -158,4 +158,4 @@

    Type Parameters

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

    Parameters

    • queue: MinimalQueue

      the queue where the job belongs to.

    • json: JobJsonRaw

      the plain object containing the job.

    • Optional jobId: string

      an optional job id (overrides the id coming from the JSON object)

      -

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Queue.html b/classes/v2.Queue.html index 46dea49a52..5c8b86560d 100644 --- a/classes/v2.Queue.html +++ b/classes/v2.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.6

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.7

    Class Queue<DataType, ResultType, NameType>

    Queue

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -193,4 +193,4 @@

    Parameters

    • opts: {
          count?: number;
          state?: FinishedStatus;
          timestamp?: number;
      } = {}

      contains number to limit how many jobs will be moved to wait status per iteration, state (failed, completed) failed by default or from which timestamp.

      • Optional count?: number
      • Optional state?: FinishedStatus
      • Optional timestamp?: number

    Returns Promise<void>

    trimEvents

    • trimEvents(maxLength): Promise<number>

    • Trim the event stream to an approximately maxLength.

      -

      Parameters

      • maxLength: number

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • maxLength: number

    Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.QueueBase.html b/classes/v2.QueueBase.html index 48aae99ec1..6cc9934c68 100644 --- a/classes/v2.QueueBase.html +++ b/classes/v2.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.6

    Class QueueBase

    Description

    Base class for all classes that need to interact with queues. +QueueBase | bullmq - v5.12.7

    Class QueueBase

    Description

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing @@ -24,4 +24,4 @@

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.QueueEvents.html b/classes/v2.QueueEvents.html index d27191e09f..85e45e16a3 100644 --- a/classes/v2.QueueEvents.html +++ b/classes/v2.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.6

    Class QueueEvents

    The QueueEvents class is used for listening to the global events +QueueEvents | bullmq - v5.12.7

    Class QueueEvents

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

    This class requires a dedicated redis connection.

    Hierarchy (view full)

    Constructors

    constructor @@ -27,4 +27,4 @@

    Type Parameters

    Parameters

    Returns boolean

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

      -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.QueueGetters.html b/classes/v2.QueueGetters.html index 230ddcc662..2c1dc42ab9 100644 --- a/classes/v2.QueueGetters.html +++ b/classes/v2.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.6

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.7

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys @@ -112,4 +112,4 @@

    Returns Promise<{
        [index: string]: string;
    }[]>

    • Returns an array with workers info.
    -

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.QueueKeys.html b/classes/v2.QueueKeys.html index f8b7d02c00..39b0e673ea 100644 --- a/classes/v2.QueueKeys.html +++ b/classes/v2.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.6

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.7

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getPrefixedQueueName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.RedisConnection.html b/classes/v2.RedisConnection.html index 10dfb0b7df..a418eca932 100644 --- a/classes/v2.RedisConnection.html +++ b/classes/v2.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.6

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.7

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

    closing minimumVersion recommendedMinimumVersion @@ -9,4 +9,4 @@ reconnect waitUntilReady

    Constructors

    constructor

    Properties

    closing

    closing: boolean

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Repeat.html b/classes/v2.Repeat.html index 86e0df6968..e604288406 100644 --- a/classes/v2.Repeat.html +++ b/classes/v2.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.6

    Class Repeat

    Description

    Base class for all classes that need to interact with queues. +Repeat | bullmq - v5.12.7

    Class Repeat

    Description

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing @@ -25,4 +25,4 @@

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          cron: string;
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          cron: string;
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.ScriptLoader.html b/classes/v2.ScriptLoader.html index 5ffa3f9fd7..ec67af64db 100644 --- a/classes/v2.ScriptLoader.html +++ b/classes/v2.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.6

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.7

    Class ScriptLoader

    Lua script loader with include support

    Constructors

    constructor

    Methods

    addPathMapping clearCache @@ -33,4 +33,4 @@

    Returns Promise<ScriptMetadata>

    resolvePath

    • resolvePath(scriptName, stack?): string

    • Resolve the script path considering path mappings

      Parameters

      • scriptName: string

        the name of the script

      • stack: string[] = []

        the include stack, for nicer errors

        -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.ScriptLoaderError.html b/classes/v2.ScriptLoaderError.html index 253e4c0245..05eae18ce8 100644 --- a/classes/v2.ScriptLoaderError.html +++ b/classes/v2.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.12.6

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.7

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor

    Properties

    includes line path position

    Constructors

    constructor

    Properties

    Readonly includes

    includes: string[]

    The include stack

    -

    Readonly line

    line: number

    Readonly path

    path: string

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly line

    line: number

    Readonly path

    path: string

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Scripts.html b/classes/v2.Scripts.html index 3bc15d814c..833af4f8f3 100644 --- a/classes/v2.Scripts.html +++ b/classes/v2.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.6

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.7

    Class Scripts

    Constructors

    constructor

    Methods

    addJob changeDelay cleanJobsInSet @@ -50,4 +50,4 @@

    Throws

    JobNotInState 0 means the job does not exist -1 means the job is currently locked and can't be retried. -2 means the job was not found in the expected set

    -

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): string[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns string[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • data: T

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): string[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns string[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • data: T

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • job: Job<T, R, N>
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.TimerManager.html b/classes/v2.TimerManager.html index d4eefcc8d4..a133a2fccc 100644 --- a/classes/v2.TimerManager.html +++ b/classes/v2.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.12.6

    Class TimerManager

    Keeps track on timers created with setTimeout to help clearTimeout +TimerManager | bullmq - v5.12.7

    Class TimerManager

    Keeps track on timers created with setTimeout to help clearTimeout for all timers when no more delayed actions needed

    Constructors

    constructor

    Methods

    clearAllTimers @@ -8,4 +8,4 @@

    Parameters

    • name: string

      Readable name for the timer

    • delay: number

      Delay in milliseconds

    • fn: Function

      Callback function that is executed after the timer expires

      -

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.UnrecoverableError.html b/classes/v2.UnrecoverableError.html index 66f9246b09..6f7b08e4a2 100644 --- a/classes/v2.UnrecoverableError.html +++ b/classes/v2.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.6

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.7

    Class UnrecoverableError

    UnrecoverableError

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

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.Worker.html b/classes/v2.Worker.html index 9371824596..985ef41f3e 100644 --- a/classes/v2.Worker.html +++ b/classes/v2.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.6

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. +Worker | bullmq - v5.12.7

    Class Worker<DataType, ResultType, NameType>

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -51,4 +51,4 @@

    Parameters

    • Optional doNotWaitActive: boolean

    Returns Promise<void>

    processJob

    • processJob(job, token, fetchNextCallback?): Promise<void | Job<DataType, ResultType, NameType>>

    • Parameters

      • job: Job<DataType, ResultType, NameType>
      • token: string
      • fetchNextCallback: (() => boolean) = ...
          • (): boolean

          • Returns boolean

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

    resume

    • resume(): void

    • Resumes processing of this worker (if paused).

      Returns void

    run

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.AsyncFifoQueue.html b/classes/v3.AsyncFifoQueue.html index a8eb381a95..aebf65f1b9 100644 --- a/classes/v3.AsyncFifoQueue.html +++ b/classes/v3.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.6

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.7

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

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

    TODO: Optimize using a linked list for the queue instead of an array. @@ -13,4 +13,4 @@ numQueued numTotal waitAll -

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Backoffs.html b/classes/v3.Backoffs.html index 2474f9c203..2cc0b5816f 100644 --- a/classes/v3.Backoffs.html +++ b/classes/v3.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.6

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.7

    Class Backoffs

    Constructors

    constructor

    Properties

    builtinStrategies

    Methods

    calculate normalize -

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.ChildPool.html b/classes/v3.ChildPool.html index 8ce5c9fae9..08b76eebe6 100644 --- a/classes/v3.ChildPool.html +++ b/classes/v3.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.6

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.7

    Class ChildPool

    Constructors

    constructor

    Properties

    free retained

    Methods

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

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.ChildProcessor.html b/classes/v3.ChildProcessor.html index f7dded6055..21ad42558c 100644 --- a/classes/v3.ChildProcessor.html +++ b/classes/v3.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.6

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.7

    Class ChildProcessor

    ChildProcessor

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

    Constructors

    constructor @@ -9,4 +9,4 @@ start stop waitForCurrentJobAndExit -

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.DelayedError.html b/classes/v3.DelayedError.html index e697cf68dc..4f2a38264b 100644 --- a/classes/v3.DelayedError.html +++ b/classes/v3.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.6

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.7

    Class DelayedError

    DelayedError

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

    Hierarchy

    • Error
      • DelayedError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.FlowProducer.html b/classes/v3.FlowProducer.html index 5c6a1b91a6..daf2a649e2 100644 --- a/classes/v3.FlowProducer.html +++ b/classes/v3.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.6

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such +FlowProducer | bullmq - v5.12.7

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent @@ -37,4 +37,4 @@ will be processed before their parents.

    Returns Promise<JobNode[]>

    close

    disconnect

    emit

    getFlow

    off

    on

    once

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<JobNode>

    off

    on

    once

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Job.html b/classes/v3.Job.html index c73bf18e3a..0318954352 100644 --- a/classes/v3.Job.html +++ b/classes/v3.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.6

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.7

    Class Job<DataType, ReturnType, NameType>

    Job

    This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

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

    @@ -166,4 +166,4 @@

    Type Parameters

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

    Parameters

    • queue: MinimalQueue

      the queue where the job belongs to.

    • json: JobJsonRaw

      the plain object containing the job.

    • Optional jobId: string

      an optional job id (overrides the id coming from the JSON object)

      -

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Queue.html b/classes/v3.Queue.html index 7545e7ff7e..9508747e32 100644 --- a/classes/v3.Queue.html +++ b/classes/v3.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.6

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.7

    Class Queue<DataType, ResultType, NameType>

    Queue

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -193,4 +193,4 @@

    Parameters

    • opts: {
          count?: number;
          state?: FinishedStatus;
          timestamp?: number;
      } = {}

      contains number to limit how many jobs will be moved to wait status per iteration, state (failed, completed) failed by default or from which timestamp.

      • Optional count?: number
      • Optional state?: FinishedStatus
      • Optional timestamp?: number

    Returns Promise<void>

    trimEvents

    • trimEvents(maxLength): Promise<number>

    • Trim the event stream to an approximately maxLength.

      -

      Parameters

      • maxLength: number

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • maxLength: number

    Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.QueueBase.html b/classes/v3.QueueBase.html index cfbb5a2931..3c8149e583 100644 --- a/classes/v3.QueueBase.html +++ b/classes/v3.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.6

    Class QueueBase

    Description

    Base class for all classes that need to interact with queues. +QueueBase | bullmq - v5.12.7

    Class QueueBase

    Description

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

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    closing @@ -24,4 +24,4 @@

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.QueueEvents.html b/classes/v3.QueueEvents.html index 4fe16b7db1..d55366ba88 100644 --- a/classes/v3.QueueEvents.html +++ b/classes/v3.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.6

    Class QueueEvents

    The QueueEvents class is used for listening to the global events +QueueEvents | bullmq - v5.12.7

    Class QueueEvents

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

    This class requires a dedicated redis connection.

    Hierarchy (view full)

    Constructors

    constructor @@ -27,4 +27,4 @@

    Type Parameters

    Parameters

    Returns boolean

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

      -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.QueueGetters.html b/classes/v3.QueueGetters.html index 50ee9125b1..d398499c3a 100644 --- a/classes/v3.QueueGetters.html +++ b/classes/v3.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.6

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.7

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys @@ -113,4 +113,4 @@

    Returns Promise<{
        [index: string]: string;
    }[]>

    • Returns an array with workers info.
    -

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.QueueKeys.html b/classes/v3.QueueKeys.html index 6085570d52..442bdc2670 100644 --- a/classes/v3.QueueKeys.html +++ b/classes/v3.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.6

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.7

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getPrefixedQueueName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getPrefixedQueueName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.RedisConnection.html b/classes/v3.RedisConnection.html index 8de7bce778..823eb0004c 100644 --- a/classes/v3.RedisConnection.html +++ b/classes/v3.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.6

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.7

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

    closing minimumVersion recommendedMinimumVersion @@ -9,4 +9,4 @@ reconnect waitUntilReady

    Constructors

    constructor

    Properties

    closing

    closing: boolean

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Repeat.html b/classes/v3.Repeat.html index c807710bd4..19744d1b25 100644 --- a/classes/v3.Repeat.html +++ b/classes/v3.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.6

    Class Repeat

    Description

    Base class for all classes that need to interact with queues. +Repeat | bullmq - v5.12.7

    Class Repeat

    Description

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing @@ -25,4 +25,4 @@

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    getRepeatableCount

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<{
          endDate: number;
          id: string;
          key: string;
          name: string;
          next: number;
          pattern: string;
          tz: string;
      }[]>

    • Parameters

      • start: number = 0
      • end: number = -1
      • asc: boolean = false

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

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.ScriptLoader.html b/classes/v3.ScriptLoader.html index bfb360650f..0b5f28e994 100644 --- a/classes/v3.ScriptLoader.html +++ b/classes/v3.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.6

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.7

    Class ScriptLoader

    Lua script loader with include support

    Constructors

    constructor

    Methods

    addPathMapping clearCache @@ -33,4 +33,4 @@

    Returns Promise<ScriptMetadata>

    resolvePath

    • resolvePath(scriptName, stack?): string

    • Resolve the script path considering path mappings

      Parameters

      • scriptName: string

        the name of the script

      • stack: string[] = []

        the include stack, for nicer errors

        -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.ScriptLoaderError.html b/classes/v3.ScriptLoaderError.html index d2315ed66e..deb600b1e1 100644 --- a/classes/v3.ScriptLoaderError.html +++ b/classes/v3.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.12.6

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.7

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor

    Properties

    includes line position

    Constructors

    constructor

    Properties

    Readonly includes

    includes: string[]

    The include stack

    -

    Readonly line

    line: number

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly line

    line: number

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Scripts.html b/classes/v3.Scripts.html index bd3912721e..edd6212867 100644 --- a/classes/v3.Scripts.html +++ b/classes/v3.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.6

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.7

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

    addJob changeDelay @@ -61,4 +61,4 @@

    Throws

    JobNotInState 0 means the job does not exist -1 means the job is currently locked and can't be retried. -2 means the job was not found in the expected set

    -

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): (string | number)[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns (string | number)[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    saveStacktraceArgs

    • saveStacktraceArgs(jobId, stacktrace, failedReason): string[]

    • Parameters

      • jobId: string
      • stacktrace: string
      • failedReason: string

      Returns string[]

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): (string | number)[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns (string | number)[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    saveStacktraceArgs

    • saveStacktraceArgs(jobId, stacktrace, failedReason): string[]

    • Parameters

      • jobId: string
      • stacktrace: string
      • failedReason: string

      Returns string[]

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(job, progress): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.UnrecoverableError.html b/classes/v3.UnrecoverableError.html index aa0d206735..354d423bdf 100644 --- a/classes/v3.UnrecoverableError.html +++ b/classes/v3.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.6

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.7

    Class UnrecoverableError

    UnrecoverableError

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

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.WaitingChildrenError.html b/classes/v3.WaitingChildrenError.html index 02886863b3..299f263021 100644 --- a/classes/v3.WaitingChildrenError.html +++ b/classes/v3.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.6

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.7

    Class WaitingChildrenError

    WaitingChildrenError

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

    Hierarchy

    • Error
      • WaitingChildrenError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v3.Worker.html b/classes/v3.Worker.html index 179c70cf8a..ff512ab1ef 100644 --- a/classes/v3.Worker.html +++ b/classes/v3.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.6

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. +Worker | bullmq - v5.12.7

    Class Worker<DataType, ResultType, NameType>

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -64,4 +64,4 @@

    Returns Promise<void>

    See

    https://docs.bullmq.io/patterns/manually-fetching-jobs

    waitUntilReady

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.AsyncFifoQueue.html b/classes/v4.AsyncFifoQueue.html index 460cabd49e..a33ca6cf77 100644 --- a/classes/v4.AsyncFifoQueue.html +++ b/classes/v4.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.6

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.7

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

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

    TODO: Optimize using a linked list for the queue instead of an array. @@ -13,4 +13,4 @@ numQueued numTotal waitAll -

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Backoffs.html b/classes/v4.Backoffs.html index 39ffcae9a3..f7623fd353 100644 --- a/classes/v4.Backoffs.html +++ b/classes/v4.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.6

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.7

    Class Backoffs

    Constructors

    constructor

    Properties

    builtinStrategies

    Methods

    calculate normalize -

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.ChildPool.html b/classes/v4.ChildPool.html index 641d6a3135..760b256259 100644 --- a/classes/v4.ChildPool.html +++ b/classes/v4.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.6

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.7

    Class ChildPool

    Constructors

    constructor

    Properties

    free retained

    Methods

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

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.ChildProcessor.html b/classes/v4.ChildProcessor.html index 7db25eec23..94d30c723f 100644 --- a/classes/v4.ChildProcessor.html +++ b/classes/v4.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.6

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.7

    Class ChildProcessor

    ChildProcessor

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

    Constructors

    constructor @@ -9,4 +9,4 @@ start stop waitForCurrentJobAndExit -

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.DelayedError.html b/classes/v4.DelayedError.html index 359d9d349d..65fcefb6c2 100644 --- a/classes/v4.DelayedError.html +++ b/classes/v4.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.6

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.7

    Class DelayedError

    DelayedError

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

    Hierarchy

    • Error
      • DelayedError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.FlowProducer.html b/classes/v4.FlowProducer.html index b9767aed45..76f846042b 100644 --- a/classes/v4.FlowProducer.html +++ b/classes/v4.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.6

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such +FlowProducer | bullmq - v5.12.7

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent @@ -41,4 +41,4 @@

    Returns Promise<void>

    disconnect

    emit

    getFlow

    off

    on

    once

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<JobNode>

    off

    on

    once

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Job.html b/classes/v4.Job.html index 228951a9c4..700edf869e 100644 --- a/classes/v4.Job.html +++ b/classes/v4.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.6

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.7

    Class Job<DataType, ReturnType, NameType>

    Job

    This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

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

    @@ -185,4 +185,4 @@

    See

    Type Parameters

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

    Parameters

    • queue: MinimalQueue

      the queue where the job belongs to.

    • json: JobJsonRaw

      the plain object containing the job.

    • Optional jobId: string

      an optional job id (overrides the id coming from the JSON object)

      -

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Queue.html b/classes/v4.Queue.html index 32d0297dde..448cc9ff0d 100644 --- a/classes/v4.Queue.html +++ b/classes/v4.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.6

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.7

    Class Queue<DataType, ResultType, NameType>

    Queue

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -231,4 +231,4 @@

    Parameters

    • maxLength: number

    Returns Promise<number>

    updateJobProgress

    • updateJobProgress(jobId, progress): Promise<void>

    • Updates the given job's progress.

      Parameters

      • jobId: string

        The id of the job to update

      • progress: number | object

        number or object to be saved as progress.

        -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.QueueBase.html b/classes/v4.QueueBase.html index ee1b456e58..3b9fc4ca01 100644 --- a/classes/v4.QueueBase.html +++ b/classes/v4.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.6

    Class QueueBase

    Description

    Base class for all classes that need to interact with queues. +QueueBase | bullmq - v5.12.7

    Class QueueBase

    Description

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

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    closing @@ -25,4 +25,4 @@

    Returns Promise<void>

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.QueueEvents.html b/classes/v4.QueueEvents.html index 261762c7ac..e64dd582db 100644 --- a/classes/v4.QueueEvents.html +++ b/classes/v4.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.6

    Class QueueEvents

    The QueueEvents class is used for listening to the global events +QueueEvents | bullmq - v5.12.7

    Class QueueEvents

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

    This class requires a dedicated redis connection.

    Hierarchy (view full)

    Constructors

    constructor @@ -28,4 +28,4 @@

    Type Parameters

    Parameters

    Returns boolean

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

      -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.QueueGetters.html b/classes/v4.QueueGetters.html index f67dbe5437..7cfa39bb5c 100644 --- a/classes/v4.QueueGetters.html +++ b/classes/v4.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.6

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.7

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys @@ -138,4 +138,4 @@

    Returns Promise<{
        [index: string]: string;
    }[]>

    • Returns an array with workers info.
    -

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.QueueKeys.html b/classes/v4.QueueKeys.html index 27b01779d2..ad7f577f37 100644 --- a/classes/v4.QueueKeys.html +++ b/classes/v4.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.6

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.7

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getQueueQualifiedName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.RateLimitError.html b/classes/v4.RateLimitError.html index 3e9217f033..3ab49b6879 100644 --- a/classes/v4.RateLimitError.html +++ b/classes/v4.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.12.6

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.12.7

    Class RateLimitError

    RateLimitError

    Error to be thrown when queue reaches a rate limit.

    Hierarchy

    • Error
      • RateLimitError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.RedisConnection.html b/classes/v4.RedisConnection.html index 59c8f51f4a..0e3435c21f 100644 --- a/classes/v4.RedisConnection.html +++ b/classes/v4.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.6

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.7

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

    capabilities closing minimumVersion @@ -10,4 +10,4 @@ reconnect waitUntilReady

    Constructors

    constructor

    Properties

    capabilities

    capabilities: RedisCapabilities = ...

    closing

    closing: boolean

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Repeat.html b/classes/v4.Repeat.html index a1827f7505..dbcfce55e9 100644 --- a/classes/v4.Repeat.html +++ b/classes/v4.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.6

    Class Repeat

    Description

    Base class for all classes that need to interact with queues. +Repeat | bullmq - v5.12.7

    Class Repeat

    Description

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing @@ -26,4 +26,4 @@

    Returns Promise<void>

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.ScriptLoader.html b/classes/v4.ScriptLoader.html index 07aeae00ab..816037f0c6 100644 --- a/classes/v4.ScriptLoader.html +++ b/classes/v4.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.6

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.7

    Class ScriptLoader

    Lua script loader with include support

    Constructors

    constructor

    Methods

    addPathMapping clearCache @@ -33,4 +33,4 @@

    Returns Promise<ScriptMetadata>

    resolvePath

    • resolvePath(scriptName, stack?): string

    • Resolve the script path considering path mappings

      Parameters

      • scriptName: string

        the name of the script

      • stack: string[] = []

        the include stack, for nicer errors

        -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.ScriptLoaderError.html b/classes/v4.ScriptLoaderError.html index f6f5c08b44..c5e44240ea 100644 --- a/classes/v4.ScriptLoaderError.html +++ b/classes/v4.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.12.6

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.7

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor

    Properties

    includes line position

    Constructors

    constructor

    Properties

    Readonly includes

    includes: string[]

    The include stack

    -

    Readonly line

    line: number

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly line

    line: number

    Readonly position

    position: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Scripts.html b/classes/v4.Scripts.html index c9e6232984..a03a72ce81 100644 --- a/classes/v4.Scripts.html +++ b/classes/v4.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.6

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.7

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

    addJob changeDelay @@ -64,4 +64,4 @@

    Throws

    JobNotInState 0 means the job does not exist -1 means the job is currently locked and can't be retried. -2 means the job was not found in the expected set

    -

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): (string | number)[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns (string | number)[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    saveStacktraceArgs

    • saveStacktraceArgs(jobId, stacktrace, failedReason): string[]

    • Parameters

      • jobId: string
      • stacktrace: string
      • failedReason: string

      Returns string[]

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(jobId, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • jobId: string
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): (string | number)[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns (string | number)[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    saveStacktraceArgs

    • saveStacktraceArgs(jobId, stacktrace, failedReason): string[]

    • Parameters

      • jobId: string
      • stacktrace: string
      • failedReason: string

      Returns string[]

    updateData

    • updateData<T, R, N>(job, data): Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    updateProgress

    • updateProgress<T, R, N>(jobId, progress): Promise<void>

    • Type Parameters

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

      Parameters

      • jobId: string
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.UnrecoverableError.html b/classes/v4.UnrecoverableError.html index ed0768e02d..c18efed3cc 100644 --- a/classes/v4.UnrecoverableError.html +++ b/classes/v4.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.6

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.7

    Class UnrecoverableError

    UnrecoverableError

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

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.WaitingChildrenError.html b/classes/v4.WaitingChildrenError.html index 0d967ece30..8bc3f2cfe7 100644 --- a/classes/v4.WaitingChildrenError.html +++ b/classes/v4.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.6

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.7

    Class WaitingChildrenError

    WaitingChildrenError

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

    Hierarchy

    • Error
      • WaitingChildrenError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v4.Worker.html b/classes/v4.Worker.html index 19e98adc85..10129020cf 100644 --- a/classes/v4.Worker.html +++ b/classes/v4.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.6

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. +Worker | bullmq - v5.12.7

    Class Worker<DataType, ResultType, NameType>

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

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor @@ -65,4 +65,4 @@

    Returns Promise<void>

    See

    https://docs.bullmq.io/patterns/manually-fetching-jobs

    waitUntilReady

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.AsyncFifoQueue.html b/classes/v5.AsyncFifoQueue.html index fa1ef49255..da81f3748c 100644 --- a/classes/v5.AsyncFifoQueue.html +++ b/classes/v5.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.6

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.7

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

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

    TODO: Optimize using a linked list for the queue instead of an array. @@ -6,11 +6,11 @@ For a linked linked implementation, we can exploit the fact that the maximum number of elements in the list will never exceen the concurrency factor of the worker, so the nodes of the list could be pre-allocated.

    -

    Type Parameters

    • T

    Constructors

    constructor +

    Type Parameters

    • T

    Constructors

    constructor

    Methods

    add fetch numPending numQueued numTotal waitAll -

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Backoffs.html b/classes/v5.Backoffs.html index 3ff72a30a0..aaa1b52db3 100644 --- a/classes/v5.Backoffs.html +++ b/classes/v5.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.6

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.7

    Class Backoffs

    Constructors

    constructor

    Properties

    builtinStrategies

    Methods

    calculate normalize -

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Static builtinStrategies

    builtinStrategies: BuiltInStrategies = ...

    Methods

    Static calculate

    Static normalize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.ChildPool.html b/classes/v5.ChildPool.html index e9057f4489..c3c276e011 100644 --- a/classes/v5.ChildPool.html +++ b/classes/v5.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.6

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.7

    Class ChildPool

    Constructors

    constructor

    Properties

    free retained

    Methods

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

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    free

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

    Type declaration

    • [key: string]: Child[]

    retained

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

    Type declaration

    • [key: number]: Child

    Methods

    clean

    getAllFree

    getFree

    kill

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

    • Parameters

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

      Returns Promise<void>

    release

    remove

    retain

    • retain(processFile): Promise<Child>

    • Parameters

      • processFile: string

      Returns Promise<Child>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.ChildProcessor.html b/classes/v5.ChildProcessor.html index cfed511f64..878c8b8b59 100644 --- a/classes/v5.ChildProcessor.html +++ b/classes/v5.ChildProcessor.html @@ -1,7 +1,7 @@ -ChildProcessor | bullmq - v5.12.6

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.7

    Class ChildProcessor

    ChildProcessor

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

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    currentJobPromise

    currentJobPromise: Promise<unknown>

    processor

    processor: any

    Optional status

    status?: ChildStatus

    Methods

    init

    start

    stop

    waitForCurrentJobAndExit

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.DelayedError.html b/classes/v5.DelayedError.html index b563a745f0..348f5d8a0c 100644 --- a/classes/v5.DelayedError.html +++ b/classes/v5.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.6

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.7

    Class DelayedError

    DelayedError

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

    -

    Hierarchy

    • Error
      • DelayedError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • Error
      • DelayedError

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.FlowProducer.html b/classes/v5.FlowProducer.html index b716047076..1d2c981c10 100644 --- a/classes/v5.FlowProducer.html +++ b/classes/v5.FlowProducer.html @@ -1,10 +1,10 @@ -FlowProducer | bullmq - v5.12.6

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such +FlowProducer | bullmq - v5.12.7

    Class FlowProducer

    This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data. All Jobs can be in different queues, either children or parents,

    -

    Hierarchy

    • EventEmitter
      • FlowProducer

    Constructors

    constructor +

    Hierarchy

    • EventEmitter
      • FlowProducer

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    opts

    opts: QueueBaseOptions = ...

    queueKeys

    queueKeys: QueueKeys

    toKey

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

    Type declaration

      • (name, type): string

      • Parameters

        • name: string
        • type: string

        Returns string

    Accessors

    client

    Methods

    add

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

    • Adds a flow.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    opts

    opts: QueueBaseOptions = ...

    queueKeys

    queueKeys: QueueKeys

    toKey

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

    Type declaration

      • (name, type): string

      • Parameters

        • name: string
        • type: string

        Returns string

    Accessors

    client

    Methods

    add

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

    • Adds a flow.

      This call would be atomic, either it fails and no jobs will be added to the queues, or it succeeds and all jobs will be added.

      Parameters

      • flow: FlowJob

        an object with a tree-like structure where children jobs will be processed before their parents.

      • Optional opts: FlowOpts

        options that will be applied to the flow object.

        -

      Returns Promise<JobNode>

    addBulk

    • addBulk(flows): Promise<JobNode[]>

    • Adds multiple flows.

      +

    Returns Promise<JobNode>

    addBulk

    • addBulk(flows): Promise<JobNode[]>

    • Adds multiple flows.

      A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data.

      @@ -37,8 +37,8 @@ be added to the queues, or it succeeds and all jobs will be added.

      Parameters

      • flows: FlowJob[]

        an array of objects with a tree-like structure where children jobs will be processed before their parents.

        -

      Returns Promise<JobNode[]>

    close

    • close(): Promise<void>

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

      -

      Returns Promise<void>

    disconnect

    emit

    getFlow

    • getFlow(opts): Promise<JobNode>

    • Get a flow.

      +

    Returns Promise<JobNode[]>

    close

    • close(): Promise<void>

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

      +

      Returns Promise<void>

    disconnect

    emit

    getFlow

    off

    on

    once

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<JobNode>

    off

    on

    once

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Job.html b/classes/v5.Job.html index 2686bde17f..4378c744ed 100644 --- a/classes/v5.Job.html +++ b/classes/v5.Job.html @@ -1,9 +1,9 @@ -Job | bullmq - v5.12.6

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.7

    Class Job<DataType, ReturnType, NameType>

    Job

    This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

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

    Job

    -

    Type Parameters

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

    Implements

    Constructors

    constructor +

    Type Parameters

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

    Implements

    Constructors

    constructor

    Properties

    attemptsMade attemptsStarted data @@ -67,137 +67,137 @@

    Constructors

    constructor

    Properties

    attemptsMade

    attemptsMade: number = 0

    Number of attempts after the job has failed.

    +
  • Optional id: string

    • Returns Job<DataType, ReturnType, NameType>

    Properties

    attemptsMade

    attemptsMade: number = 0

    Number of attempts after the job has failed.

    Default Value

    0
    -

    attemptsStarted

    attemptsStarted: number = 0

    Number of attempts when job is moved to active.

    +

    attemptsStarted

    attemptsStarted: number = 0

    Number of attempts when job is moved to active.

    Default Value

    0
    -

    data

    data: DataType

    The payload for this job.

    -

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    -

    delay

    delay: number

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

    +

    data

    data: DataType

    The payload for this job.

    +

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    +

    delay

    delay: number

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

    Default Value

    0
    -

    failedReason

    failedReason: string

    Reason for failing.

    -

    Optional finishedOn

    finishedOn?: number

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

    -

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    -

    opts

    opts: JobsOptions = {}

    The options object for this job.

    -

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    -

    Optional parentKey

    parentKey?: string

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

    -

    Optional processedBy

    processedBy?: string

    The worker name that is processing or processed this job.

    -

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    -

    progress

    progress: number | object = 0

    The progress a job has performed so far.

    +

    failedReason

    failedReason: string

    Reason for failing.

    +

    Optional finishedOn

    finishedOn?: number

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

    +

    Optional id

    id?: string

    name

    name: NameType

    The name of the Job

    +

    opts

    opts: JobsOptions = {}

    The options object for this job.

    +

    Optional parent

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    +

    Optional parentKey

    parentKey?: string

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

    +

    Optional processedBy

    processedBy?: string

    The worker name that is processing or processed this job.

    +

    Optional processedOn

    processedOn?: number

    Timestamp for when the job was processed.

    +

    progress

    progress: number | object = 0

    The progress a job has performed so far.

    Default Value

    0
    -

    Readonly queueQualifiedName

    queueQualifiedName: string

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

    +

    Readonly queueQualifiedName

    queueQualifiedName: string

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

    See

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

    -

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    -

    returnvalue

    returnvalue: ReturnType = null

    The value returned by the processor when processing this job.

    +

    Optional repeatJobKey

    repeatJobKey?: string

    Base repeat job key.

    +

    returnvalue

    returnvalue: ReturnType = null

    The value returned by the processor when processing this job.

    Default Value

    null
    -

    stacktrace

    stacktrace: string[] = null

    Stacktrace for the error (for failed jobs).

    +

    stacktrace

    stacktrace: string[] = null

    Stacktrace for the error (for failed jobs).

    Default Value

    null
    -

    timestamp

    timestamp: number

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

    -

    Optional token

    token?: string

    The token used for locking this job.

    -

    Accessors

    prefix

    • get prefix(): string

    • Returns string

      the prefix that is used.

      -

    queueName

    • get queueName(): string

    • Returns string

      the queue name this job belongs to.

      -

    Methods

    addJob

    asJSON

    asJSONSandbox

    changeDelay

    timestamp

    timestamp: number

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

    +

    Optional token

    token?: string

    The token used for locking this job.

    +

    Accessors

    prefix

    • get prefix(): string

    • Returns string

      the prefix that is used.

      +

    queueName

    • get queueName(): string

    • Returns string

      the queue name this job belongs to.

      +

    Methods

    addJob

    asJSON

    asJSONSandbox

    changeDelay

    • changeDelay(delay): Promise<void>

    • Change delay of a delayed job.

      Parameters

      • delay: number

        milliseconds to be added to current time.

      Returns Promise<void>

      void

      -

    changePriority

    changePriority

    • changePriority(opts): Promise<void>

    • Change job priority.

      Parameters

      • opts: {
            lifo?: boolean;
            priority?: number;
        }
        • Optional lifo?: boolean
        • Optional priority?: number

      Returns Promise<void>

      void

      -

    clearLogs

    clearLogs

    • clearLogs(keepLogs?): Promise<void>

    • Clears job's logs

      Parameters

      • Optional keepLogs: number

        the amount of log entries to preserve

        -

      Returns Promise<void>

    discard

    • discard(): void

    • Marks a job to not be retried if it fails (even if attempts has been configured)

      -

      Returns void

    extendLock

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

    • Extend the lock for this job.

      +

    Returns Promise<void>

    discard

    • discard(): void

    • Marks a job to not be retried if it fails (even if attempts has been configured)

      +

      Returns void

    extendLock

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

    • Extend the lock for this job.

      Parameters

      • token: string

        unique token for the lock

      • duration: number

        lock duration in milliseconds

        -

      Returns Promise<number>

    getChildrenValues

    • getChildrenValues<CT>(): Promise<{
          [jobKey: string]: CT;
      }>

    • Get this jobs children result values if any.

      +

    Returns Promise<number>

    getChildrenValues

    • getChildrenValues<CT>(): Promise<{
          [jobKey: string]: CT;
      }>

    • Get this jobs children result values if any.

      Type Parameters

      • CT = any

      Returns Promise<{
          [jobKey: string]: CT;
      }>

      Object mapping children job keys with their values.

      -

    getDependencies

    • getDependencies(opts?): Promise<{
          nextProcessedCursor?: number;
          nextUnprocessedCursor?: number;
          processed?: Record<string, any>;
          unprocessed?: string[];
      }>

    • Get children job keys if this job is a parent and has children.

      +

    getDependencies

    • getDependencies(opts?): Promise<{
          nextProcessedCursor?: number;
          nextUnprocessedCursor?: number;
          processed?: Record<string, any>;
          unprocessed?: string[];
      }>

    • Get children job keys if this job is a parent and has children.

      Parameters

      Returns Promise<{
          nextProcessedCursor?: number;
          nextUnprocessedCursor?: number;
          processed?: Record<string, any>;
          unprocessed?: string[];
      }>

      dependencies separated by processed and unprocessed.

      Remarks

      Count options before Redis v7.2 works as expected with any quantity of entries on processed/unprocessed dependencies, since v7.2 you must consider that count won't have any effect until processed/unprocessed dependencies have a length greater than 127

      See

      https://redis.io/docs/management/optimization/memory-optimization/#redis--72

      -

    getDependenciesCount

    • getDependenciesCount(opts?): Promise<{
          processed?: number;
          unprocessed?: number;
      }>

    • Get children job counts if this job is a parent and has children.

      +

    getDependenciesCount

    • getDependenciesCount(opts?): Promise<{
          processed?: number;
          unprocessed?: number;
      }>

    • Get children job counts if this job is a parent and has children.

      Parameters

      • opts: {
            processed?: boolean;
            unprocessed?: boolean;
        } = {}
        • Optional processed?: boolean
        • Optional unprocessed?: boolean

      Returns Promise<{
          processed?: number;
          unprocessed?: number;
      }>

      dependencies count separated by processed and unprocessed.

      -

    getFailedChildrenValues

    • getFailedChildrenValues(): Promise<{
          [jobKey: string]: string;
      }>

    • Get this jobs children failure values if any.

      +

    getFailedChildrenValues

    • getFailedChildrenValues(): Promise<{
          [jobKey: string]: string;
      }>

    • Get this jobs children failure values if any.

      Returns Promise<{
          [jobKey: string]: string;
      }>

      Object mapping children job keys with their failure values.

      -

    getState

    getState

    • getState(): Promise<"unknown" | JobState>

    • Get current state.

      Returns Promise<"unknown" | JobState>

      Returns one of these values: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.

      -

    isActive

    • isActive(): Promise<boolean>

    • Returns Promise<boolean>

      true of the job is active.

      -

    isCompleted

    • isCompleted(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has completed.

      -

    isDelayed

    • isDelayed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is delayed.

      -

    isFailed

    • isFailed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has failed.

      -

    isWaiting

    • isWaiting(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting.

      -

    isWaitingChildren

    • isWaitingChildren(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting for children.

      -

    log

    isActive

    • isActive(): Promise<boolean>

    • Returns Promise<boolean>

      true of the job is active.

      +

    isCompleted

    • isCompleted(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has completed.

      +

    isDelayed

    • isDelayed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is delayed.

      +

    isFailed

    • isFailed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has failed.

      +

    isWaiting

    • isWaiting(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting.

      +

    isWaitingChildren

    • isWaitingChildren(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting for children.

      +

    log

    • log(logRow): Promise<number>

    • Logs one row of log data.

      Parameters

      • logRow: string

        string with log data to be logged.

      Returns Promise<number>

      The total number of log entries for this job so far.

      -

    moveToCompleted

    • moveToCompleted(returnValue, token, fetchNext?): Promise<void | any[]>

    • Moves a job to the completed queue. +

    moveToCompleted

    • moveToCompleted(returnValue, token, fetchNext?): Promise<void | any[]>

    • Moves a job to the completed queue. Returned job to be used with Queue.prototype.nextJobFromJobData.

      Parameters

      • returnValue: ReturnType

        The jobs success message.

      • token: string

        Worker token used to acquire completed job.

      • fetchNext: boolean = true

        True when wanting to fetch the next job.

      Returns Promise<void | any[]>

      Returns the jobData of the next job in the waiting queue or void.

      -

    moveToDelayed

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

    • Moves the job to the delay set.

      +

    moveToDelayed

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

    • Moves the job to the delay set.

      Parameters

      • timestamp: number

        timestamp where the job should be moved back to "wait"

      • Optional token: string

        token to check job is locked by current worker

        -

      Returns Promise<void>

    moveToFailed

    • moveToFailed<E>(err, token, fetchNext?): Promise<void | any[]>

    • Moves a job to the failed queue.

      +

    Returns Promise<void>

    moveToFailed

    moveToWaitingChildren

    moveToWaitingChildren

    promote

    remove

    promote

    remove

    removeChildDependency

    Returns Promise<void>

    removeChildDependency

    retry

    retry

    toJSON

    updateData

    toJSON

    updateData

    updateProgress

    Returns Promise<void>

    updateProgress

    waitUntilFinished

    Returns Promise<void>

    waitUntilFinished

    Static addJobLog

    Returns Promise<ReturnType>

    Static addJobLog

    Static create

    Static create

    Static createBulk

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

    Static createBulk

    Static fromId

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

    Static fromId

    Static fromJSON

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

    Static fromJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Queue.html b/classes/v5.Queue.html index afd1350bed..ecb424b638 100644 --- a/classes/v5.Queue.html +++ b/classes/v5.Queue.html @@ -1,7 +1,7 @@ -Queue | bullmq - v5.12.6

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.7

    Class Queue<DataType, ResultType, NameType>

    Queue

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

    -

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing jobsOpts keys @@ -73,55 +73,55 @@ trimEvents updateJobProgress waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    jobsOpts

    jobsOpts: BaseJobOptions

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueOptions

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    token

    token: string = ...

    Accessors

    client

    defaultJobOptions

    metaValues

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

    • Returns Record<string, string | number>

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    repeat

    Methods

    add

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    jobsOpts

    jobsOpts: BaseJobOptions

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueOptions

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    token

    token: string = ...

    Accessors

    client

    defaultJobOptions

    metaValues

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

    • Returns Record<string, string | number>

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    repeat

    Methods

    add

    addBulk

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

    addBulk

    addJobLog

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

    • Logs one row of job's log data.

      +

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

    addJobLog

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

    • Logs one row of job's log data.

      Parameters

      • jobId: string

        The job id to log against.

      • logRow: string

        String with log data to be logged.

      • Optional keepLogs: number

        Max number of log entries to keep (0 for unlimited).

      Returns Promise<number>

      The total number of log entries for this job so far.

      -

    clean

    • clean(grace, limit, type?): Promise<string[]>

    • Cleans jobs from a queue. Similar to drain but keeps jobs within a certain +

    clean

    • clean(grace, limit, type?): Promise<string[]>

    • Cleans jobs from a queue. Similar to drain but keeps jobs within a certain grace period.

      Parameters

      • grace: number

        The grace period

      • limit: number

        Max number of jobs to clean

      • type: "failed" | "active" | "paused" | "completed" | "wait" | "prioritized" | "delayed" = 'completed'

        The type of job to clean Possible values are completed, wait, active, paused, delayed, failed. Defaults to completed.

      Returns Promise<string[]>

      Id jobs from the deleted records

      -

    close

    count

    • count(): Promise<number>

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

    close

    count

    • count(): Promise<number>

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

      -

      Returns Promise<number>

    disconnect

    drain

    disconnect

    drain

    • drain(delayed?): Promise<void>

    • Drains the queue, i.e., removes all jobs that are waiting or delayed, but not active, completed or failed.

      Parameters

      • delayed: boolean = false

        Pass true if it should also clean the delayed jobs.

        -

      Returns Promise<void>

    emit

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

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

      +

    Returns Promise<void>

    emit

    getActive

    Returns boolean

    getActive

    getActiveCount

    getCompleted

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

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDelayed

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

    getCompletedCount

    getCountsPerPriority

    getDelayed

    getDelayedCount

    getDependencies

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

    getDelayedCount

    getDependencies

    getFailed

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

    getFailed

    getFailedCount

    getGlobalConcurrency

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

    getFailedCount

    getGlobalConcurrency

    getJob

    getJobCountByTypes

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobState

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

    getJobState

    getJobs

    getJobs

    getMetrics

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

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

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

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getRepeatableJobs

    getRepeatableJobs

    getWaiting

    Returns Promise<RepeatableJob[]>

    getWaiting

    getWaitingChildren

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

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

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

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    getWorkersCount

    getWorkersCount

    isMaxed

    isPaused

    obliterate

    isMaxed

    isPaused

    obliterate

    off

    on

    once

    pause

    Returns Promise<void>

    off

    on

    once

    pause

    promoteJobs

    remove

    promoteJobs

    remove

    removeDebounceKey

    removeDebounceKey

    removeDeprecatedPriorityKey

    removeRepeatable

    Returns Promise<number>

    removeDeprecatedPriorityKey

    removeRepeatable

    removeRepeatableByKey

    removeRepeatableByKey

    resume

    resume

    retryJobs

    setGlobalConcurrency

    retryJobs

    setGlobalConcurrency

    trimEvents

    updateJobProgress

    Returns Promise<number>

    trimEvents

    updateJobProgress

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueBase.html b/classes/v5.QueueBase.html index 1207e0d658..126c09edcf 100644 --- a/classes/v5.QueueBase.html +++ b/classes/v5.QueueBase.html @@ -1,7 +1,7 @@ -QueueBase | bullmq - v5.12.6

    Class QueueBase

    QueueBase

    +QueueBase | bullmq - v5.12.7

    Class QueueBase

    QueueBase

    Description

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

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    closing keys name @@ -18,12 +18,12 @@
  • opts: QueueBaseOptions = ...

    Options for the queue.

  • Connection: typeof RedisConnection = RedisConnection

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

    -

    • Returns QueueBase

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

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

      -

      Returns Promise<void>

    disconnect

    emit

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

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

      +

    Returns QueueBase

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

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

      +

      Returns Promise<void>

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueEvents.html b/classes/v5.QueueEvents.html index a0f445359a..135a65a38e 100644 --- a/classes/v5.QueueEvents.html +++ b/classes/v5.QueueEvents.html @@ -1,7 +1,7 @@ -QueueEvents | bullmq - v5.12.6

    Class QueueEvents

    The QueueEvents class is used for listening to the global events +QueueEvents | bullmq - v5.12.7

    Class QueueEvents

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

    This class requires a dedicated redis connection.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -18,14 +18,14 @@ once run waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    Methods

    close

    disconnect

    emit

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

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

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    Methods

    close

    disconnect

    emit

    off

    on

    once

    run

    • run(): Promise<void>

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

    • Rest ...args: Parameters<QueueEventsListener[U]>

    Returns boolean

    off

    on

    once

    run

    • run(): Promise<void>

    • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

      -

      Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueGetters.html b/classes/v5.QueueGetters.html index c0194bb9b7..e28668ebbc 100644 --- a/classes/v5.QueueGetters.html +++ b/classes/v5.QueueGetters.html @@ -1,6 +1,6 @@ -QueueGetters | bullmq - v5.12.6

    Class QueueGetters<DataType, ResultType, NameType>

    QueueGetters

    +QueueGetters | bullmq - v5.12.7

    Class QueueGetters<DataType, ResultType, NameType>

    QueueGetters

    Description

    Provides different getters for different aspects of a queue.

    -

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • DataType
    • ResultType
    • NameType extends string

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -46,30 +46,30 @@
  • opts: QueueBaseOptions = ...

    Options for the queue.

  • Connection: typeof RedisConnection = RedisConnection

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

    -

    • Returns QueueGetters<DataType, ResultType, NameType>

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    Methods

    close

    • close(): Promise<void>

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

      -

      Returns Promise<void>

    count

    • count(): Promise<number>

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

    Returns QueueGetters<DataType, ResultType, NameType>

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    Methods

    close

    • close(): Promise<void>

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

      +

      Returns Promise<void>

    count

    • count(): Promise<number>

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

      -

      Returns Promise<number>

    disconnect

    emit

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

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

      +

      Returns Promise<number>

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getActive

    Returns boolean

    getActive

    getActiveCount

    • getActiveCount(): Promise<number>

    • Returns the number of jobs in active status.

      -

      Returns Promise<number>

    getCompleted

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

    getActiveCount

    • getActiveCount(): Promise<number>

    • Returns the number of jobs in active status.

      +

      Returns Promise<number>

    getCompleted

    getCompletedCount

    • getCompletedCount(): Promise<number>

    • Returns the number of jobs in completed status.

      -

      Returns Promise<number>

    getCountsPerPriority

    • getCountsPerPriority(priorities): Promise<{
          [index: string]: number;
      }>

    • Returns the number of jobs per priority.

      -

      Parameters

      • priorities: number[]

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

    getDelayed

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

    getCompletedCount

    getCountsPerPriority

    getDelayed

    getDelayedCount

    getDependencies

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

    getDelayedCount

    getDependencies

    getFailed

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

    getFailed

    getFailedCount

    getJob

    getJobCountByTypes

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

    getFailedCount

    getJob

    getJobCountByTypes

    getJobCounts

    getJobCounts

    getJobLogs

    getJobLogs

    getJobState

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

    getJobState

    getJobs

    getJobs

    getMetrics

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

    getMetrics

    Returns Promise<Metrics>

    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

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

    getPrioritizedCount

    getQueueEvents

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    getWaiting

    getWaiting

    getWaitingChildren

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

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

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

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    getWorkersCount

    getWorkersCount

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueKeys.html b/classes/v5.QueueKeys.html index 75b8407481..2de28dfa10 100644 --- a/classes/v5.QueueKeys.html +++ b/classes/v5.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.6

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.7

    Class QueueKeys

    Constructors

    constructor

    Properties

    prefix

    Methods

    getKeys getQueueQualifiedName toKey -

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly prefix

    prefix: string = 'bull'

    Methods

    getKeys

    getQueueQualifiedName

    toKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.RateLimitError.html b/classes/v5.RateLimitError.html index 66104b4e33..71f449ca09 100644 --- a/classes/v5.RateLimitError.html +++ b/classes/v5.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.12.6

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.12.7

    Class RateLimitError

    RateLimitError

    Error to be thrown when queue reaches a rate limit.

    -

    Hierarchy

    • Error
      • RateLimitError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • Error
      • RateLimitError

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.7

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    capabilities

    capabilities: RedisCapabilities = ...

    closing

    closing: boolean

    status

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

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    capabilities

    capabilities: RedisCapabilities = ...

    closing

    closing: boolean

    status

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

    Static minimumVersion

    minimumVersion: string = '5.0.0'

    Static recommendedMinimumVersion

    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    client

    redisVersion

    Methods

    close

    disconnect

    reconnect

    Static waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Repeat.html b/classes/v5.Repeat.html index fa251013e7..50fea50431 100644 --- a/classes/v5.Repeat.html +++ b/classes/v5.Repeat.html @@ -1,7 +1,7 @@ -Repeat | bullmq - v5.12.6

    Class Repeat

    QueueBase

    +Repeat | bullmq - v5.12.7

    Class Repeat

    QueueBase

    Description

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -20,12 +20,12 @@ removeRepeatable removeRepeatableByKey waitUntilReady -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    Methods

    addNextRepeatableJob

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

    • Type Parameters

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

      Parameters

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

    close

    • close(): Promise<void>

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

      -

      Returns Promise<void>

    disconnect

    emit

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

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

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    opts

    opts: QueueBaseOptions = ...

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    Methods

    addNextRepeatableJob

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

    • Type Parameters

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

      Parameters

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

    close

    • close(): Promise<void>

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

      +

      Returns Promise<void>

    disconnect

    emit

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

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

      Parameters

      • event: string | symbol

        The emitted event.

        -
      • Rest ...args: any[]

      Returns boolean

    getRepeatJobKey

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

    • Type Parameters

      • T = any
      • N extends string = string

      Parameters

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

      Returns string

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns boolean

    getRepeatJobKey

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

    • Type Parameters

      • T = any
      • N extends string = string

      Parameters

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

      Returns string

    getRepeatableCount

    getRepeatableJobs

    removeRepeatable

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

    • Parameters

      Returns Promise<number>

    removeRepeatableByKey

    • removeRepeatableByKey(repeatJobKey): Promise<number>

    • Parameters

      • repeatJobKey: string

      Returns Promise<number>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Scripts.html b/classes/v5.Scripts.html index b200754563..d2a236ad94 100644 --- a/classes/v5.Scripts.html +++ b/classes/v5.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.6

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.7

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

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

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

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

      Returns Promise<string>

    changeDelay

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

    • Parameters

      • jobId: string
      • delay: number

      Returns Promise<void>

    changePriority

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

    • Parameters

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

      Returns Promise<void>

    cleanJobsInSet

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

    • Remove jobs in a specific state.

      +

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

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

      Returns Promise<string>

    changeDelay

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

    • Parameters

      • jobId: string
      • delay: number

      Returns Promise<void>

    changePriority

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

    • Parameters

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

      Returns Promise<void>

    cleanJobsInSet

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

    • Remove jobs in a specific state.

      Parameters

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

      Returns Promise<string[]>

      Id jobs from the deleted records.

      -

    drain

    extendLock

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

    • Parameters

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

      Returns Promise<number>

    finishedErrors

    • finishedErrors(__namedParameters): Error

    • Parameters

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

      Returns Error

    getCounts

    getCountsPerPriority

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

    • Parameters

      • priorities: number[]

      Returns Promise<number[]>

    getRanges

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

    • Parameters

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

      Returns Promise<[string][]>

    getRateLimitTtl

    • getRateLimitTtl(maxJobs?): Promise<number>

    • Parameters

      • Optional maxJobs: number

      Returns Promise<number>

    getRateLimitTtlArgs

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

    • Parameters

      • Optional maxJobs: number

      Returns (string | number)[]

    getRepeatConcatOptions

    • getRepeatConcatOptions(repeatConcatOptions, repeatJobKey): string

    • Parameters

      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns string

    getState

    isFinished

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

    • Parameters

      • jobId: string
      • returnValue: boolean = false

      Returns Promise<number | [number, string]>

    isJobInList

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

    • Parameters

      • listKey: string
      • jobId: string

      Returns Promise<boolean>

    isMaxed

    isMaxedArgs

    moveJobFromActiveToWait

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

    • Moves a job back from Active to Wait. +

    drain

    extendLock

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

    • Parameters

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

      Returns Promise<number>

    finishedErrors

    • finishedErrors(__namedParameters): Error

    • Parameters

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

      Returns Error

    getCounts

    getCountsPerPriority

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

    • Parameters

      • priorities: number[]

      Returns Promise<number[]>

    getRanges

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

    • Parameters

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

      Returns Promise<[string][]>

    getRateLimitTtl

    • getRateLimitTtl(maxJobs?): Promise<number>

    • Parameters

      • Optional maxJobs: number

      Returns Promise<number>

    getRateLimitTtlArgs

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

    • Parameters

      • Optional maxJobs: number

      Returns (string | number)[]

    getRepeatConcatOptions

    • getRepeatConcatOptions(repeatConcatOptions, repeatJobKey): string

    • Parameters

      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns string

    getState

    isFinished

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

    • Parameters

      • jobId: string
      • returnValue: boolean = false

      Returns Promise<number | [number, string]>

    isJobInList

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

    • Parameters

      • listKey: string
      • jobId: string

      Returns Promise<boolean>

    isMaxed

    isMaxedArgs

    moveJobFromActiveToWait

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

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

      Parameters

      • jobId: string

        Job id

        -
      • token: string

      Returns Promise<any>

    moveStalledJobsToWait

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

    • Looks for unlocked jobs in the active queue.

      +
    • token: string

    Returns Promise<any>

    moveStalledJobsToWait

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

    • Looks for unlocked jobs in the active queue.

      The job was being worked on, but the worker process died and it failed to renew the lock. We call these jobs 'stalled'. This is the most common case. We resolve these by moving them back to wait to be re-processed. To prevent jobs from cycling endlessly between active and wait, (e.g. if the job handler keeps crashing), we limit the number stalled job recoveries to settings.maxStalledCount.

      -

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

    moveToActive

    moveToCompletedArgs

    • moveToCompletedArgs<T, R, N>(job, returnvalue, removeOnComplete, token, fetchNext?): (string | number | boolean | Buffer)[]

    • Type Parameters

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

      Parameters

      • job: MinimalJob<T, R, N>
      • returnvalue: R
      • removeOnComplete: number | boolean | KeepJobs
      • token: string
      • fetchNext: boolean = false

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

    moveToDelayed

    • moveToDelayed(jobId, timestamp, delay, token?, opts?): Promise<void>

    • Parameters

      • jobId: string
      • timestamp: number
      • delay: number
      • token: string = '0'
      • opts: MoveToDelayedOpts = {}

      Returns Promise<void>

    moveToDelayedArgs

    • moveToDelayedArgs(jobId, timestamp, token, delay, opts?): (string | number)[]

    • Parameters

      Returns (string | number)[]

    moveToFailedArgs

    • moveToFailedArgs<T, R, N>(job, failedReason, removeOnFailed, token, fetchNext?): (string | number | boolean | Buffer)[]

    • Type Parameters

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

      Parameters

      • job: MinimalJob<T, R, N>
      • failedReason: string
      • removeOnFailed: number | boolean | KeepJobs
      • token: string
      • fetchNext: boolean = false

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

    moveToFinished

    • moveToFinished(jobId, args): Promise<any[]>

    • Parameters

      • jobId: string
      • args: (string | number | boolean | Buffer)[]

      Returns Promise<any[]>

    moveToWaitingChildren

    • moveToWaitingChildren(jobId, token, opts?): Promise<boolean>

    • Move parent job to waiting-children state.

      +

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

    moveToActive

    moveToCompletedArgs

    • moveToCompletedArgs<T, R, N>(job, returnvalue, removeOnComplete, token, fetchNext?): (string | number | boolean | Buffer)[]

    • Type Parameters

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

      Parameters

      • job: MinimalJob<T, R, N>
      • returnvalue: R
      • removeOnComplete: number | boolean | KeepJobs
      • token: string
      • fetchNext: boolean = false

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

    moveToDelayed

    • moveToDelayed(jobId, timestamp, delay, token?, opts?): Promise<void>

    • Parameters

      • jobId: string
      • timestamp: number
      • delay: number
      • token: string = '0'
      • opts: MoveToDelayedOpts = {}

      Returns Promise<void>

    moveToDelayedArgs

    • moveToDelayedArgs(jobId, timestamp, token, delay, opts?): (string | number)[]

    • Parameters

      Returns (string | number)[]

    moveToFailedArgs

    • moveToFailedArgs<T, R, N>(job, failedReason, removeOnFailed, token, fetchNext?): (string | number | boolean | Buffer)[]

    • Type Parameters

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

      Parameters

      • job: MinimalJob<T, R, N>
      • failedReason: string
      • removeOnFailed: number | boolean | KeepJobs
      • token: string
      • fetchNext: boolean = false

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

    moveToFinished

    • moveToFinished(jobId, args): Promise<any[]>

    • Parameters

      • jobId: string
      • args: (string | number | boolean | Buffer)[]

      Returns Promise<any[]>

    moveToWaitingChildren

    • moveToWaitingChildren(jobId, token, opts?): Promise<boolean>

    • Move parent job to waiting-children state.

      Parameters

      Returns Promise<boolean>

      true if job is successfully moved, false if there are pending dependencies.

      Throws

      JobNotExist This exception is thrown if jobId is missing.

      @@ -64,8 +64,8 @@

      Throws

      JobLockNotExist This exception is thrown if job lock is missing.

      Throws

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

      -

    moveToWaitingChildrenArgs

    obliterate

    • obliterate(opts): Promise<number>

    • Parameters

      • opts: {
            count: number;
            force: boolean;
        }
        • count: number
        • force: boolean

      Returns Promise<number>

    paginate

    • paginate(key, opts): Promise<{
          cursor: string;
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs?: JobJsonRaw[];
          total: number;
      }>

    • Paginate a set or hash keys.

      -

      Parameters

      • key: string
      • opts: {
            end: number;
            fetchJobs?: boolean;
            start: number;
        }
        • end: number
        • Optional fetchJobs?: boolean
        • start: number

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

    pause

    promote

    promoteJobs

    • promoteJobs(count?): Promise<number>

    • Parameters

      • count: number = 1000

      Returns Promise<number>

    remove

    • remove(jobId, removeChildren): Promise<number>

    • Parameters

      • jobId: string
      • removeChildren: boolean

      Returns Promise<number>

    removeChildDependency

    • removeChildDependency(jobId, parentKey): Promise<boolean>

    • Parameters

      • jobId: string
      • parentKey: string

      Returns Promise<boolean>

    removeRepeatable

    • removeRepeatable(legacyRepeatJobId, repeatConcatOptions, repeatJobKey): Promise<number>

    • Parameters

      • legacyRepeatJobId: string
      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns Promise<number>

    reprocessJob

    moveToWaitingChildrenArgs

    obliterate

    • obliterate(opts): Promise<number>

    • Parameters

      • opts: {
            count: number;
            force: boolean;
        }
        • count: number
        • force: boolean

      Returns Promise<number>

    paginate

    • paginate(key, opts): Promise<{
          cursor: string;
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs?: JobJsonRaw[];
          total: number;
      }>

    • Paginate a set or hash keys.

      +

      Parameters

      • key: string
      • opts: {
            end: number;
            fetchJobs?: boolean;
            start: number;
        }
        • end: number
        • Optional fetchJobs?: boolean
        • start: number

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

    pause

    promote

    promoteJobs

    • promoteJobs(count?): Promise<number>

    • Parameters

      • count: number = 1000

      Returns Promise<number>

    remove

    • remove(jobId, removeChildren): Promise<number>

    • Parameters

      • jobId: string
      • removeChildren: boolean

      Returns Promise<number>

    removeChildDependency

    • removeChildDependency(jobId, parentKey): Promise<boolean>

    • Parameters

      • jobId: string
      • parentKey: string

      Returns Promise<boolean>

    removeRepeatable

    • removeRepeatable(legacyRepeatJobId, repeatConcatOptions, repeatJobKey): Promise<number>

    • Parameters

      • legacyRepeatJobId: string
      • repeatConcatOptions: string
      • repeatJobKey: string

      Returns Promise<number>

    reprocessJob

    • reprocessJob<T, R, N>(job, state): Promise<void>

    • Attempts to reprocess a job

      Type Parameters

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

      Parameters

      • job: MinimalJob<T, R, N>
      • state: "failed" | "completed"

        The expected job state. If the job is not found on the provided state, then it's not reprocessed. Supported states: 'failed', 'completed'

      Returns Promise<void>

      Returns a promise that evaluates to a return code: @@ -73,4 +73,4 @@

      Throws

      JobNotInState 0 means the job does not exist -1 means the job is currently locked and can't be retried. -2 means the job was not found in the expected set

      -

    retryJobArgs

    • retryJobArgs(jobId, lifo, token): (string | number)[]

    • Parameters

      • jobId: string
      • lifo: boolean
      • token: string

      Returns (string | number)[]

    retryJobs

    • retryJobs(state?, count?, timestamp?): Promise<number>

    • Parameters

      • state: FinishedStatus = 'failed'
      • count: number = 1000
      • timestamp: number = ...

      Returns Promise<number>

    saveStacktraceArgs

    • saveStacktraceArgs(jobId, stacktrace, failedReason): string[]

    • Parameters

      • jobId: string
      • stacktrace: string
      • failedReason: string

      Returns string[]

    updateData

    updateProgress

    • updateProgress(jobId, progress): Promise<void>

    • Parameters

      • jobId: string
      • progress: number | object

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    retryJobArgs

    retryJobs

    saveStacktraceArgs

    updateData

    updateProgress

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.UnrecoverableError.html b/classes/v5.UnrecoverableError.html index d79c755e05..3ae1d4eef7 100644 --- a/classes/v5.UnrecoverableError.html +++ b/classes/v5.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.6

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.7

    Class UnrecoverableError

    UnrecoverableError

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

    -

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • Error
      • UnrecoverableError

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.WaitingChildrenError.html b/classes/v5.WaitingChildrenError.html index cd768b22fa..caa96c838b 100644 --- a/classes/v5.WaitingChildrenError.html +++ b/classes/v5.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.6

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.7

    Class WaitingChildrenError

    WaitingChildrenError

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

    -

    Hierarchy

    • Error
      • WaitingChildrenError

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • Error
      • WaitingChildrenError

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Worker.html b/classes/v5.Worker.html index 22a6624f42..d180d7280d 100644 --- a/classes/v5.Worker.html +++ b/classes/v5.Worker.html @@ -1,7 +1,7 @@ -Worker | bullmq - v5.12.6

    Class Worker<DataType, ResultType, NameType>

    This class represents a worker that is able to process jobs from the queue. +Worker | bullmq - v5.12.7

    Class Worker<DataType, ResultType, NameType>

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

    -

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing id keys @@ -32,31 +32,31 @@ startStalledCheckTimer waitUntilReady RateLimitError -

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    Readonly id

    id: string

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    -

    Readonly opts

    opts: WorkerOptions

    Options for the queue.

    -

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    concurrency

    • set concurrency(concurrency): void

    • Parameters

      • concurrency: number

      Returns void

    minimumBlockTimeout

    redisVersion

    • get redisVersion(): string

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

      -

      Returns string

    repeat

    Methods

    close

    • close(force?): Promise<void>

    • Closes the worker and related redis connections.

      +

    Constructors

    constructor

    Properties

    closing

    closing: Promise<void>

    Readonly id

    id: string

    keys

    keys: KeysMap

    Readonly name

    name: string

    The name of the queue.

    +

    Readonly opts

    opts: WorkerOptions

    Options for the queue.

    +

    Readonly qualifiedName

    qualifiedName: string

    toKey

    toKey: ((type) => string)

    Type declaration

      • (type): string

      • Parameters

        • type: string

        Returns string

    Accessors

    client

    concurrency

    • set concurrency(concurrency): void

    • Parameters

      • concurrency: number

      Returns void

    minimumBlockTimeout

    redisVersion

    • get redisVersion(): string

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

      +

      Returns string

    repeat

    Methods

    close

    • close(force?): Promise<void>

    • Closes the worker and related redis connections.

      This method waits for current jobs to finalize before returning.

      Parameters

      • force: boolean = false

        Use force boolean parameter if you do not want to wait for current jobs to be processed.

      Returns Promise<void>

      Promise that resolves when the worker has been closed.

      -

    delay

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

    • This function is exposed only for testing purposes.

      -

      Parameters

      • Optional milliseconds: number
      • Optional abortController: AbortController

      Returns Promise<void>

    disconnect

    emit

    delay

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

    • This function is exposed only for testing purposes.

      +

      Parameters

      • Optional milliseconds: number
      • Optional abortController: AbortController

      Returns Promise<void>

    disconnect

    emit

    getNextJob

    Returns boolean

    getNextJob

    isPaused

    isPaused

    • isPaused(): boolean

    • Checks if worker is paused.

      Returns boolean

      true if worker is paused, false otherwise.

      -

    isRunning

    isRunning

    • isRunning(): boolean

    • Checks if worker is currently running.

      Returns boolean

      true if worker is running, false otherwise.

      -

    off

    on

    once

    pause

    • pause(doNotWaitActive?): Promise<void>

    • Pauses the processing of this queue only for this worker.

      -

      Parameters

      • Optional doNotWaitActive: boolean

      Returns Promise<void>

    processJob

    rateLimit

    • rateLimit(expireTimeMs): Promise<void>

    • Overrides the rate limit to be active for the next jobs.

      +

    off

    on

    once

    pause

    • pause(doNotWaitActive?): Promise<void>

    • Pauses the processing of this queue only for this worker.

      +

      Parameters

      • Optional doNotWaitActive: boolean

      Returns Promise<void>

    processJob

    rateLimit

    • rateLimit(expireTimeMs): Promise<void>

    • Overrides the rate limit to be active for the next jobs.

      Parameters

      • expireTimeMs: number

        expire time in ms of this rate limit.

        -

      Returns Promise<void>

    resume

    • resume(): void

    • Resumes processing of this worker (if paused).

      -

      Returns void

    run

    startStalledCheckTimer

    • startStalledCheckTimer(): Promise<void>

    • Manually starts the stalled checker. +

    Returns Promise<void>

    resume

    • resume(): void

    • Resumes processing of this worker (if paused).

      +

      Returns void

    run

    startStalledCheckTimer

    • startStalledCheckTimer(): Promise<void>

    • Manually starts the stalled checker. The check will run once as soon as this method is called, and then every opts.stalledInterval milliseconds until the worker is closed. Note: Normally you do not need to call this method, since the stalled checker @@ -64,6 +64,6 @@ calling run. However if you want to process the jobs manually you need to call this method to start the stalled checker.

      Returns Promise<void>

      See

      https://docs.bullmq.io/patterns/manually-fetching-jobs

      -

    waitUntilReady

    waitUntilReady

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<RedisClient>

    Static RateLimitError

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v1.ChildCommand.html b/enums/v1.ChildCommand.html index 61603fe5dc..c9eddbd67b 100644 --- a/enums/v1.ChildCommand.html +++ b/enums/v1.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.6

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.7

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v1.ClientType.html b/enums/v1.ClientType.html index 82f6a8d63d..3d6d434db6 100644 --- a/enums/v1.ClientType.html +++ b/enums/v1.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.6

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.7

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v1.ErrorCode.html b/enums/v1.ErrorCode.html index 29da2d6414..f67320f22a 100644 --- a/enums/v1.ErrorCode.html +++ b/enums/v1.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.12.6

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.12.7

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobNotExist -

    Enumeration Members

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v1.MetricsTime.html b/enums/v1.MetricsTime.html index bfde66adf9..8db975be53 100644 --- a/enums/v1.MetricsTime.html +++ b/enums/v1.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.6

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.7

    Enumeration MetricsTime

    Enumeration Members

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

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v1.ParentCommand.html b/enums/v1.ParentCommand.html index 036684cef0..73254d4d8f 100644 --- a/enums/v1.ParentCommand.html +++ b/enums/v1.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.6

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.7

    Enumeration ParentCommand

    Enumeration Members

    Completed Error Failed InitCompleted @@ -6,4 +6,4 @@ Log Progress Update -

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v2.ChildCommand.html b/enums/v2.ChildCommand.html index cc97d7264b..d6a4e21c01 100644 --- a/enums/v2.ChildCommand.html +++ b/enums/v2.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.6

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.7

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v2.ClientType.html b/enums/v2.ClientType.html index de06332a1c..dc5da3d679 100644 --- a/enums/v2.ClientType.html +++ b/enums/v2.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.6

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.7

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v2.ErrorCode.html b/enums/v2.ErrorCode.html index 6dde7cb3ae..e9ebaa1d95 100644 --- a/enums/v2.ErrorCode.html +++ b/enums/v2.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.12.6

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.12.7

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobNotExist -

    Enumeration Members

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v2.MetricsTime.html b/enums/v2.MetricsTime.html index 09a2609b71..746cda2802 100644 --- a/enums/v2.MetricsTime.html +++ b/enums/v2.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.6

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.7

    Enumeration MetricsTime

    Enumeration Members

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

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v2.ParentCommand.html b/enums/v2.ParentCommand.html index 11fed56e0e..5f5dc2d651 100644 --- a/enums/v2.ParentCommand.html +++ b/enums/v2.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.6

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.7

    Enumeration ParentCommand

    Enumeration Members

    Completed Error Failed InitCompleted @@ -6,4 +6,4 @@ Log Progress Update -

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v3.ChildCommand.html b/enums/v3.ChildCommand.html index 0d263df8fd..cd461a1195 100644 --- a/enums/v3.ChildCommand.html +++ b/enums/v3.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.6

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.7

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v3.ClientType.html b/enums/v3.ClientType.html index a55059b66d..d2256780c3 100644 --- a/enums/v3.ClientType.html +++ b/enums/v3.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.6

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.7

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v3.ErrorCode.html b/enums/v3.ErrorCode.html index 1b65b62f13..bf55fd25c2 100644 --- a/enums/v3.ErrorCode.html +++ b/enums/v3.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.12.6

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.7

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobNotExist -

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v3.MetricsTime.html b/enums/v3.MetricsTime.html index 5bd390e9c8..ac9846dd0d 100644 --- a/enums/v3.MetricsTime.html +++ b/enums/v3.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.6

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.7

    Enumeration MetricsTime

    Enumeration Members

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

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v3.ParentCommand.html b/enums/v3.ParentCommand.html index 1fdb3c1ed9..ff5e3264d7 100644 --- a/enums/v3.ParentCommand.html +++ b/enums/v3.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.6

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.7

    Enumeration ParentCommand

    Enumeration Members

    Completed Error Failed InitCompleted @@ -6,4 +6,4 @@ Log Progress Update -

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    Progress

    Progress: 6

    Update

    Update: 7

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v4.ChildCommand.html b/enums/v4.ChildCommand.html index 385127ac00..5da8d9c392 100644 --- a/enums/v4.ChildCommand.html +++ b/enums/v4.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.6

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.7

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v4.ClientType.html b/enums/v4.ClientType.html index ae6809d292..26badaae71 100644 --- a/enums/v4.ClientType.html +++ b/enums/v4.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.6

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.7

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v4.ErrorCode.html b/enums/v4.ErrorCode.html index 2cbbe6d27d..6d1aa54c3a 100644 --- a/enums/v4.ErrorCode.html +++ b/enums/v4.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.12.6

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.7

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobNotExist -

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v4.MetricsTime.html b/enums/v4.MetricsTime.html index 02bb752b2b..fcf90b7e24 100644 --- a/enums/v4.MetricsTime.html +++ b/enums/v4.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.6

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.7

    Enumeration MetricsTime

    Enumeration Members

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

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v4.ParentCommand.html b/enums/v4.ParentCommand.html index f87862d9bc..e149f8fb97 100644 --- a/enums/v4.ParentCommand.html +++ b/enums/v4.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.6

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.7

    Enumeration ParentCommand

    Enumeration Members

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

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ChildCommand.html b/enums/v5.ChildCommand.html index 0489f13835..9b0282ce1f 100644 --- a/enums/v5.ChildCommand.html +++ b/enums/v5.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.6

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.7

    Enumeration ChildCommand

    Enumeration Members

    Init Start Stop -

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Init

    Init: 0

    Start

    Start: 1

    Stop

    Stop: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ClientType.html b/enums/v5.ClientType.html index dd7fd4ac60..2fb70eb3a8 100644 --- a/enums/v5.ClientType.html +++ b/enums/v5.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.6

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.7

    Enumeration ClientType

    Enumeration Members

    blocking normal -

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    blocking

    blocking: "blocking"

    normal

    normal: "normal"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ErrorCode.html b/enums/v5.ErrorCode.html index 05d6b1f7d6..731717fb2b 100644 --- a/enums/v5.ErrorCode.html +++ b/enums/v5.ErrorCode.html @@ -1,8 +1,8 @@ -ErrorCode | bullmq - v5.12.6

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.7

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch JobLockNotExist JobNotExist JobNotInState JobPendingDependencies ParentJobCannotBeReplaced ParentJobNotExist -

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobCannotBeReplaced

    ParentJobCannotBeReplaced: -7

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    JobLockMismatch

    JobLockMismatch: -6

    JobLockNotExist

    JobLockNotExist: -2

    JobNotExist

    JobNotExist: -1

    JobNotInState

    JobNotInState: -3

    JobPendingDependencies

    JobPendingDependencies: -4

    ParentJobCannotBeReplaced

    ParentJobCannotBeReplaced: -7

    ParentJobNotExist

    ParentJobNotExist: -5

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.MetricsTime.html b/enums/v5.MetricsTime.html index 196390f0b7..35bf26cf8f 100644 --- a/enums/v5.MetricsTime.html +++ b/enums/v5.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.6

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.7

    Enumeration MetricsTime

    Enumeration Members

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

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    FIFTEEN_MINUTES

    FIFTEEN_MINUTES: 15

    FIVE_MINUTES

    FIVE_MINUTES: 5

    ONE_HOUR

    ONE_HOUR: 60

    ONE_MINUTE

    ONE_MINUTE: 1

    ONE_MONTH

    ONE_MONTH: 80640

    ONE_WEEK

    ONE_WEEK: 10080

    THIRTY_MINUTES

    THIRTY_MINUTES: 30

    TWO_WEEKS

    TWO_WEEKS: 20160

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.ParentCommand.html b/enums/v5.ParentCommand.html index 1c59e93298..5a9df4decc 100644 --- a/enums/v5.ParentCommand.html +++ b/enums/v5.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.6

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.7

    Enumeration ParentCommand

    Enumeration Members

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

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Completed

    Completed: 0

    Error

    Error: 1

    Failed

    Failed: 2

    InitCompleted

    InitCompleted: 4

    InitFailed

    InitFailed: 3

    Log

    Log: 5

    MoveToDelayed

    MoveToDelayed: 6

    Progress

    Progress: 7

    Update

    Update: 8

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.array2obj.html b/functions/v1.array2obj.html index 1fc63d0133..d97d79816b 100644 --- a/functions/v1.array2obj.html +++ b/functions/v1.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.6

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.asyncSend.html b/functions/v1.asyncSend.html index a2fd6860ba..5c54218478 100644 --- a/functions/v1.asyncSend.html +++ b/functions/v1.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.6

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.childSend.html b/functions/v1.childSend.html index e3289ba497..9c63dcdab5 100644 --- a/functions/v1.childSend.html +++ b/functions/v1.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.6

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.delay.html b/functions/v1.delay.html index dd6cc078b6..30dcaf7e80 100644 --- a/functions/v1.delay.html +++ b/functions/v1.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.6

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.getNextMillis.html b/functions/v1.getNextMillis.html index 41647d2e86..bec5547d06 100644 --- a/functions/v1.getNextMillis.html +++ b/functions/v1.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.6

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.getParentKey.html b/functions/v1.getParentKey.html index e75362a4d9..9e15e506af 100644 --- a/functions/v1.getParentKey.html +++ b/functions/v1.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.6

    Function getParentKey

    • getParentKey(opts): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getParentKey

    • getParentKey(opts): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.isEmpty.html b/functions/v1.isEmpty.html index 31e90ba720..672971dd55 100644 --- a/functions/v1.isEmpty.html +++ b/functions/v1.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.6

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.isNotConnectionError.html b/functions/v1.isNotConnectionError.html index d168bf7e5d..a2e47727e4 100644 --- a/functions/v1.isNotConnectionError.html +++ b/functions/v1.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.6

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.isRedisCluster.html b/functions/v1.isRedisCluster.html index eab497cd79..2f572ec49b 100644 --- a/functions/v1.isRedisCluster.html +++ b/functions/v1.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.6

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.isRedisInstance.html b/functions/v1.isRedisInstance.html index 57edee932b..4380942b72 100644 --- a/functions/v1.isRedisInstance.html +++ b/functions/v1.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.6

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.isRedisVersionLowerThan.html b/functions/v1.isRedisVersionLowerThan.html index 4b75a9ba2a..30d6117e1e 100644 --- a/functions/v1.isRedisVersionLowerThan.html +++ b/functions/v1.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.6

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.jobIdForGroup.html b/functions/v1.jobIdForGroup.html index 3a72dd5e1f..e6c920bb9c 100644 --- a/functions/v1.jobIdForGroup.html +++ b/functions/v1.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.12.6

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +jobIdForGroup | bullmq - v5.12.7

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.killAsync.html b/functions/v1.killAsync.html index ad9823f2e6..51c1a87977 100644 --- a/functions/v1.killAsync.html +++ b/functions/v1.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.12.6

    Function killAsync

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

    • Sends a kill signal to a child resolving when the child has exited, +killAsync | bullmq - v5.12.7

      Function killAsync

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

      • Sends a kill signal to a child resolving when the child has exited, resorting to SIGKILL if the given timeout is reached

        -

        Parameters

        • child: ChildProcess
        • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
        • timeoutMs: number = undefined

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • child: ChildProcess
      • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
      • timeoutMs: number = undefined

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.lengthInUtf8Bytes.html b/functions/v1.lengthInUtf8Bytes.html index f29672a674..4ff10f5e69 100644 --- a/functions/v1.lengthInUtf8Bytes.html +++ b/functions/v1.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.6

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.parentSend.html b/functions/v1.parentSend.html index cd86873e53..dde5fab5ac 100644 --- a/functions/v1.parentSend.html +++ b/functions/v1.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.12.6

    Function parentSend

    • parentSend(child, msg): Promise<void>

    • Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +parentSend | bullmq - v5.12.7

    Function parentSend

    • parentSend(child, msg): Promise<void>

    • Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.raw2jobData.html b/functions/v1.raw2jobData.html index 24377f08a6..b7f32cb52b 100644 --- a/functions/v1.raw2jobData.html +++ b/functions/v1.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.12.6

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +raw2jobData | bullmq - v5.12.7

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.removeAllQueueData.html b/functions/v1.removeAllQueueData.html index d1e75357b2..00423ab092 100644 --- a/functions/v1.removeAllQueueData.html +++ b/functions/v1.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.6

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v1.tryCatch.html b/functions/v1.tryCatch.html index 94aa8fc9ed..3af0df857e 100644 --- a/functions/v1.tryCatch.html +++ b/functions/v1.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.6

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.array2obj.html b/functions/v2.array2obj.html index a4bfa7cde8..0f0f068610 100644 --- a/functions/v2.array2obj.html +++ b/functions/v2.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.6

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.asyncSend.html b/functions/v2.asyncSend.html index 5f4cedb584..f6ada66e84 100644 --- a/functions/v2.asyncSend.html +++ b/functions/v2.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.6

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.childSend.html b/functions/v2.childSend.html index db2ef26ee9..7c29300c5b 100644 --- a/functions/v2.childSend.html +++ b/functions/v2.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.6

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.delay.html b/functions/v2.delay.html index 6ad728c649..f7182bc4eb 100644 --- a/functions/v2.delay.html +++ b/functions/v2.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.6

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.getNextMillis.html b/functions/v2.getNextMillis.html index 95d30f257a..5ee6596a54 100644 --- a/functions/v2.getNextMillis.html +++ b/functions/v2.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.6

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.getParentKey.html b/functions/v2.getParentKey.html index 77d0e8eb76..ce1921395a 100644 --- a/functions/v2.getParentKey.html +++ b/functions/v2.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.6

    Function getParentKey

    • getParentKey(opts): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getParentKey

    • getParentKey(opts): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.isEmpty.html b/functions/v2.isEmpty.html index 30731f4023..fa6a03087f 100644 --- a/functions/v2.isEmpty.html +++ b/functions/v2.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.6

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.isNotConnectionError.html b/functions/v2.isNotConnectionError.html index ad6ce3e509..af87b986f4 100644 --- a/functions/v2.isNotConnectionError.html +++ b/functions/v2.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.6

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.isRedisCluster.html b/functions/v2.isRedisCluster.html index 20cd311934..8ad982b52e 100644 --- a/functions/v2.isRedisCluster.html +++ b/functions/v2.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.6

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.isRedisInstance.html b/functions/v2.isRedisInstance.html index 881f5165f4..fcfc9594c4 100644 --- a/functions/v2.isRedisInstance.html +++ b/functions/v2.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.6

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.isRedisVersionLowerThan.html b/functions/v2.isRedisVersionLowerThan.html index 83bdff0172..0596c7d057 100644 --- a/functions/v2.isRedisVersionLowerThan.html +++ b/functions/v2.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.6

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.jobIdForGroup.html b/functions/v2.jobIdForGroup.html index df1351bac9..39fec1e87a 100644 --- a/functions/v2.jobIdForGroup.html +++ b/functions/v2.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.12.6

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +jobIdForGroup | bullmq - v5.12.7

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.killAsync.html b/functions/v2.killAsync.html index 3cae0662d3..015479b0d5 100644 --- a/functions/v2.killAsync.html +++ b/functions/v2.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.12.6

    Function killAsync

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

    • Sends a kill signal to a child resolving when the child has exited, +killAsync | bullmq - v5.12.7

      Function killAsync

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

      • Sends a kill signal to a child resolving when the child has exited, resorting to SIGKILL if the given timeout is reached

        -

        Parameters

        • child: ChildProcess
        • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
        • timeoutMs: number = undefined

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • child: ChildProcess
      • signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
      • timeoutMs: number = undefined

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.lengthInUtf8Bytes.html b/functions/v2.lengthInUtf8Bytes.html index 169cba3d28..752fb5232e 100644 --- a/functions/v2.lengthInUtf8Bytes.html +++ b/functions/v2.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.6

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.parentSend.html b/functions/v2.parentSend.html index 517d898871..2ddf600703 100644 --- a/functions/v2.parentSend.html +++ b/functions/v2.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.12.6

    Function parentSend

    • parentSend(child, msg): Promise<void>

    • Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +parentSend | bullmq - v5.12.7

    Function parentSend

    • parentSend(child, msg): Promise<void>

    • Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.raw2jobData.html b/functions/v2.raw2jobData.html index 3c2d47f24c..0f5bcb7f5e 100644 --- a/functions/v2.raw2jobData.html +++ b/functions/v2.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.12.6

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +raw2jobData | bullmq - v5.12.7

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.removeAllQueueData.html b/functions/v2.removeAllQueueData.html index 8f5b15efa9..750727eabb 100644 --- a/functions/v2.removeAllQueueData.html +++ b/functions/v2.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.6

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v2.tryCatch.html b/functions/v2.tryCatch.html index e3172ad91b..d79fd38f8b 100644 --- a/functions/v2.tryCatch.html +++ b/functions/v2.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.6

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.array2obj.html b/functions/v3.array2obj.html index cb420ecd67..17a04caec6 100644 --- a/functions/v3.array2obj.html +++ b/functions/v3.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.6

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.asyncSend.html b/functions/v3.asyncSend.html index 3304c68d52..8f8504e622 100644 --- a/functions/v3.asyncSend.html +++ b/functions/v3.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.6

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.childSend.html b/functions/v3.childSend.html index dab5f82d42..6124f9ab9a 100644 --- a/functions/v3.childSend.html +++ b/functions/v3.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.6

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.delay.html b/functions/v3.delay.html index 948411b611..77c3771c07 100644 --- a/functions/v3.delay.html +++ b/functions/v3.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.6

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function delay

    • delay(ms): Promise<void>

    • Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.errorToJSON.html b/functions/v3.errorToJSON.html index ec56dcf901..1d326a6a58 100644 --- a/functions/v3.errorToJSON.html +++ b/functions/v3.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.6

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.getNextMillis.html b/functions/v3.getNextMillis.html index 0fc8ec43de..1c33b5a07e 100644 --- a/functions/v3.getNextMillis.html +++ b/functions/v3.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.6

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.getParentKey.html b/functions/v3.getParentKey.html index 9dcb3ad35e..9207c07e73 100644 --- a/functions/v3.getParentKey.html +++ b/functions/v3.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.6

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.isEmpty.html b/functions/v3.isEmpty.html index ed24034cf8..7ffa20b467 100644 --- a/functions/v3.isEmpty.html +++ b/functions/v3.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.6

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.isNotConnectionError.html b/functions/v3.isNotConnectionError.html index 9c9e56c11d..cf26ccc54e 100644 --- a/functions/v3.isNotConnectionError.html +++ b/functions/v3.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.6

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.isRedisCluster.html b/functions/v3.isRedisCluster.html index b786a5ece6..5fc36c0852 100644 --- a/functions/v3.isRedisCluster.html +++ b/functions/v3.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.6

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.isRedisInstance.html b/functions/v3.isRedisInstance.html index 10dad6f0cb..7a356f34f2 100644 --- a/functions/v3.isRedisInstance.html +++ b/functions/v3.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.6

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.isRedisVersionLowerThan.html b/functions/v3.isRedisVersionLowerThan.html index 6a26af33c6..0b2c145abc 100644 --- a/functions/v3.isRedisVersionLowerThan.html +++ b/functions/v3.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.6

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.lengthInUtf8Bytes.html b/functions/v3.lengthInUtf8Bytes.html index 79e2fd0522..6e356b1d3f 100644 --- a/functions/v3.lengthInUtf8Bytes.html +++ b/functions/v3.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.6

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.parseObjectValues.html b/functions/v3.parseObjectValues.html index 8a797abc1e..26d0905158 100644 --- a/functions/v3.parseObjectValues.html +++ b/functions/v3.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.6

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.raw2NextJobData.html b/functions/v3.raw2NextJobData.html index dd1ebc99a9..a9093d4980 100644 --- a/functions/v3.raw2NextJobData.html +++ b/functions/v3.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.6

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.removeAllQueueData.html b/functions/v3.removeAllQueueData.html index 4dff7ab171..75f49fc779 100644 --- a/functions/v3.removeAllQueueData.html +++ b/functions/v3.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.6

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function removeAllQueueData

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

    • Parameters

      • client: RedisClient
      • queueName: string
      • prefix: string = 'bull'

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v3.tryCatch.html b/functions/v3.tryCatch.html index 5e8fd9554d..900b630745 100644 --- a/functions/v3.tryCatch.html +++ b/functions/v3.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.6

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.array2obj.html b/functions/v4.array2obj.html index 83975d6431..96554e8cf8 100644 --- a/functions/v4.array2obj.html +++ b/functions/v4.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.6

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.asyncSend.html b/functions/v4.asyncSend.html index 53e6ebdf18..23c521d35f 100644 --- a/functions/v4.asyncSend.html +++ b/functions/v4.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.6

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.childSend.html b/functions/v4.childSend.html index 88750fd01b..1a527a8a41 100644 --- a/functions/v4.childSend.html +++ b/functions/v4.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.6

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.decreaseMaxListeners.html b/functions/v4.decreaseMaxListeners.html index 5fcc4d805e..9bb4aae721 100644 --- a/functions/v4.decreaseMaxListeners.html +++ b/functions/v4.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.12.6

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.delay.html b/functions/v4.delay.html index 7517fd5f07..b9ad07b8b5 100644 --- a/functions/v4.delay.html +++ b/functions/v4.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.6

    Function delay

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

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function delay

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

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.errorToJSON.html b/functions/v4.errorToJSON.html index 2342e119d8..bfffbfd27b 100644 --- a/functions/v4.errorToJSON.html +++ b/functions/v4.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.6

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.getNextMillis.html b/functions/v4.getNextMillis.html index 23b0d27a1f..33e0d2dfd1 100644 --- a/functions/v4.getNextMillis.html +++ b/functions/v4.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.6

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.getParentKey.html b/functions/v4.getParentKey.html index bfb1126f4f..9c31926538 100644 --- a/functions/v4.getParentKey.html +++ b/functions/v4.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.6

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.increaseMaxListeners.html b/functions/v4.increaseMaxListeners.html index 71a0cb51d7..0c9756d148 100644 --- a/functions/v4.increaseMaxListeners.html +++ b/functions/v4.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.12.6

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.isEmpty.html b/functions/v4.isEmpty.html index 36a8e2b89b..b40ffa885c 100644 --- a/functions/v4.isEmpty.html +++ b/functions/v4.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.6

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.isNotConnectionError.html b/functions/v4.isNotConnectionError.html index 06528ed970..71f5abbb41 100644 --- a/functions/v4.isNotConnectionError.html +++ b/functions/v4.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.6

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.isRedisCluster.html b/functions/v4.isRedisCluster.html index 56ee9dccbf..b87b973026 100644 --- a/functions/v4.isRedisCluster.html +++ b/functions/v4.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.6

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.isRedisInstance.html b/functions/v4.isRedisInstance.html index 2de6a1d1a6..d9d302560c 100644 --- a/functions/v4.isRedisInstance.html +++ b/functions/v4.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.6

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.isRedisVersionLowerThan.html b/functions/v4.isRedisVersionLowerThan.html index 0627d69e55..b55bff6481 100644 --- a/functions/v4.isRedisVersionLowerThan.html +++ b/functions/v4.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.6

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.lengthInUtf8Bytes.html b/functions/v4.lengthInUtf8Bytes.html index c43c4e921d..b7c34566df 100644 --- a/functions/v4.lengthInUtf8Bytes.html +++ b/functions/v4.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.6

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.parseObjectValues.html b/functions/v4.parseObjectValues.html index 87ad058ed9..a762a59384 100644 --- a/functions/v4.parseObjectValues.html +++ b/functions/v4.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.6

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.raw2NextJobData.html b/functions/v4.raw2NextJobData.html index cb630b7d8b..2ae46b5c38 100644 --- a/functions/v4.raw2NextJobData.html +++ b/functions/v4.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.6

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.removeAllQueueData.html b/functions/v4.removeAllQueueData.html index b5d0429267..a43515c703 100644 --- a/functions/v4.removeAllQueueData.html +++ b/functions/v4.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.6

    Function removeAllQueueData

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

    • Parameters

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

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function removeAllQueueData

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

    • Parameters

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

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v4.tryCatch.html b/functions/v4.tryCatch.html index 0f529bc0cb..5766c31f84 100644 --- a/functions/v4.tryCatch.html +++ b/functions/v4.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.6

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.array2obj.html b/functions/v5.array2obj.html index 39127f1ff0..710a7f608c 100644 --- a/functions/v5.array2obj.html +++ b/functions/v5.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.6

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function array2obj

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

    • Parameters

      • arr: string[]

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.asyncSend.html b/functions/v5.asyncSend.html index af246d2830..62ec41ea0b 100644 --- a/functions/v5.asyncSend.html +++ b/functions/v5.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.6

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function asyncSend

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

    • Type Parameters

      • T extends procSendLike

      Parameters

      • proc: T
      • msg: any

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.childSend.html b/functions/v5.childSend.html index 394f864c3d..84e65e4139 100644 --- a/functions/v5.childSend.html +++ b/functions/v5.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.6

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.decreaseMaxListeners.html b/functions/v5.decreaseMaxListeners.html index 4dfc5a870d..8500a0f581 100644 --- a/functions/v5.decreaseMaxListeners.html +++ b/functions/v5.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.12.6

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function decreaseMaxListeners

    • decreaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.delay.html b/functions/v5.delay.html index 6d54714767..6887b31499 100644 --- a/functions/v5.delay.html +++ b/functions/v5.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.6

    Function delay

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

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function delay

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

    • Parameters

      • ms: number
      • Optional abortController: AbortController

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.errorToJSON.html b/functions/v5.errorToJSON.html index fd314b0737..1d769c0e77 100644 --- a/functions/v5.errorToJSON.html +++ b/functions/v5.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.6

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function errorToJSON

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

    • Parameters

      • value: any

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.getNextMillis.html b/functions/v5.getNextMillis.html index 4b7a0b1cfd..cf4807ade3 100644 --- a/functions/v5.getNextMillis.html +++ b/functions/v5.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.6

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.getParentKey.html b/functions/v5.getParentKey.html index e033d4f981..49c340d8c1 100644 --- a/functions/v5.getParentKey.html +++ b/functions/v5.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.6

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getParentKey

    • getParentKey(opts): string | undefined

    • Parameters

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

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.increaseMaxListeners.html b/functions/v5.increaseMaxListeners.html index fab85d7254..2342427b57 100644 --- a/functions/v5.increaseMaxListeners.html +++ b/functions/v5.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.12.6

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function increaseMaxListeners

    • increaseMaxListeners(emitter, count): void

    • Parameters

      • emitter: EventEmitter
      • count: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.invertObject.html b/functions/v5.invertObject.html index 486d1f73a7..dc60dbdb74 100644 --- a/functions/v5.invertObject.html +++ b/functions/v5.invertObject.html @@ -1 +1 @@ -invertObject | bullmq - v5.12.6

    Function invertObject

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

    • Parameters

      • obj: Record<string, string>

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function invertObject

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

    • Parameters

      • obj: Record<string, string>

      Returns Record<string, string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isEmpty.html b/functions/v5.isEmpty.html index 8a980977db..2af06cd1bb 100644 --- a/functions/v5.isEmpty.html +++ b/functions/v5.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.6

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isEmpty

    • isEmpty(obj): boolean

    • Parameters

      • obj: object

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isNotConnectionError.html b/functions/v5.isNotConnectionError.html index 259f47d385..6e05c32799 100644 --- a/functions/v5.isNotConnectionError.html +++ b/functions/v5.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.6

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isNotConnectionError

    • isNotConnectionError(error): boolean

    • Parameters

      • error: Error

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisCluster.html b/functions/v5.isRedisCluster.html index 5598ab9afa..14c652ce52 100644 --- a/functions/v5.isRedisCluster.html +++ b/functions/v5.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.6

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisCluster

    • isRedisCluster(obj): obj is Cluster

    • Parameters

      • obj: unknown

      Returns obj is Cluster

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisInstance.html b/functions/v5.isRedisInstance.html index 39c48fa898..cbfec2d648 100644 --- a/functions/v5.isRedisInstance.html +++ b/functions/v5.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.6

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisInstance

    • isRedisInstance(obj): obj is Cluster | Redis

    • Parameters

      • obj: any

      Returns obj is Cluster | Redis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.isRedisVersionLowerThan.html b/functions/v5.isRedisVersionLowerThan.html index 6d2056967b..37dee8a335 100644 --- a/functions/v5.isRedisVersionLowerThan.html +++ b/functions/v5.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.6

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function isRedisVersionLowerThan

    • isRedisVersionLowerThan(currentVersion, minimumVersion): boolean

    • Parameters

      • currentVersion: string
      • minimumVersion: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.lengthInUtf8Bytes.html b/functions/v5.lengthInUtf8Bytes.html index 51ac907489..6deef4f3cc 100644 --- a/functions/v5.lengthInUtf8Bytes.html +++ b/functions/v5.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.6

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.parseObjectValues.html b/functions/v5.parseObjectValues.html index bfd7999549..b02797f4eb 100644 --- a/functions/v5.parseObjectValues.html +++ b/functions/v5.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.6

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function parseObjectValues

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

    • Parameters

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

      Returns Record<string, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.raw2NextJobData.html b/functions/v5.raw2NextJobData.html index ac4e92ebb3..65ee7c84af 100644 --- a/functions/v5.raw2NextJobData.html +++ b/functions/v5.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.6

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.removeAllQueueData.html b/functions/v5.removeAllQueueData.html index 9822811500..f8c630a3b1 100644 --- a/functions/v5.removeAllQueueData.html +++ b/functions/v5.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.6

    Function removeAllQueueData

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

    • Parameters

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

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function removeAllQueueData

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

    • Parameters

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

      Returns Promise<void | boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function toString

    • toString(value): string

    • Parameters

      • value: any

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function toString

    • toString(value): string

    • Parameters

      • value: any

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.tryCatch.html b/functions/v5.tryCatch.html index b441f9025a..301b92d24e 100644 --- a/functions/v5.tryCatch.html +++ b/functions/v5.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.6

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function tryCatch

    • tryCatch(fn, ctx, args): any

    • Parameters

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

          • Parameters

            • Rest ...args: any

            Returns any

      • ctx: any
      • args: any[]

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index d0c3d5c659..e47f70e9ea 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -bullmq - v5.12.6

    bullmq - v5.12.6

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bullmq - v5.12.7

    bullmq - v5.12.7

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index c720a328a6..65f17cb1bc 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -bullmq - v5.12.6

    bullmq - v5.12.6

    +bullmq - v5.12.7

    bullmq - v5.12.7



    @@ -347,4 +347,4 @@

    Thanks

    Thanks for all the contributors that made this library possible, also a special mention to Leon van Kammen that kindly donated his npm bullmq repo.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v1.AddChildrenOpts.html b/interfaces/v1.AddChildrenOpts.html index 19a5dd32ce..bccde6d49f 100644 --- a/interfaces/v1.AddChildrenOpts.html +++ b/interfaces/v1.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.6

    Interface AddChildrenOpts

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

    Properties

    multi +AddChildrenOpts | bullmq - v5.12.7

    Interface AddChildrenOpts

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

    Properties

    multi nodes parent queuesOpts? -

    Properties

    multi

    multi: ChainableCommander

    nodes

    nodes: FlowJob[]

    parent

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

    Type declaration

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

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    multi

    multi: ChainableCommander

    nodes

    nodes: FlowJob[]

    parent

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

    Type declaration

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

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v1.AddNodeOpts.html b/interfaces/v1.AddNodeOpts.html index b016829056..805e25687e 100644 --- a/interfaces/v1.AddNodeOpts.html +++ b/interfaces/v1.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.6

    Interface AddNodeOpts

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

    Properties

    multi +AddNodeOpts | bullmq - v5.12.7

    Interface AddNodeOpts

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

    Properties

    multi node parent? queuesOpts?

    Properties

    multi

    multi: ChainableCommander

    node

    node: FlowJob

    Optional parent

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

    Type declaration

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

    Optional queuesOpts

    queuesOpts?: FlowQueuesOpts

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v1.AdvancedOptions.html b/interfaces/v1.AdvancedOptions.html index c8b020e338..9bf3a89b82 100644 --- a/interfaces/v1.AdvancedOptions.html +++ b/interfaces/v1.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.6

    Interface AdvancedOptions

    interface AdvancedOptions {
        backoffStrategies?: {};
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    backoffStrategies? +AdvancedOptions | bullmq - v5.12.7

    Interface AdvancedOptions

    interface AdvancedOptions {
        backoffStrategies?: {};
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    backoffStrategies? repeatStrategy?

    Properties

    Optional backoffStrategies

    backoffStrategies?: {}

    A set of custom backoff strategies keyed by name.

    Type declaration

      Optional repeatStrategy

      repeatStrategy?: RepeatStrategy

      A set of custom cron strategies keyed by name.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.AdvancedRepeatOptions.html b/interfaces/v1.AdvancedRepeatOptions.html index 15d1ee44fb..f81f964465 100644 --- a/interfaces/v1.AdvancedRepeatOptions.html +++ b/interfaces/v1.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.6

      Interface AdvancedRepeatOptions

      interface AdvancedRepeatOptions {
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.7

      Interface AdvancedRepeatOptions

      interface AdvancedRepeatOptions {
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      repeatStrategy?

      Properties

      Optional repeatStrategy

      repeatStrategy?: RepeatStrategy

      A set of custom cron strategies keyed by name.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.BackoffOptions.html b/interfaces/v1.BackoffOptions.html index e321485109..03b487e1b7 100644 --- a/interfaces/v1.BackoffOptions.html +++ b/interfaces/v1.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.6

      Interface BackoffOptions

      Settings for backing off failed jobs.

      +BackoffOptions | bullmq - v5.12.7

      Interface BackoffOptions

      Settings for backing off failed jobs.

      See

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

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

      Properties

      delay? type

      Properties

      Optional delay

      delay?: number

      Delay in milliseconds.

      type

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

      Name of the backoff strategy.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.BaseJobOptions.html b/interfaces/v1.BaseJobOptions.html index 37c3e35be8..5c1c40c867 100644 --- a/interfaces/v1.BaseJobOptions.html +++ b/interfaces/v1.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.6

      Interface BaseJobOptions

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

      Hierarchy (view full)

      Properties

      attempts? +BaseJobOptions | bullmq - v5.12.7

      Interface BaseJobOptions

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

      Hierarchy (view full)

      Properties

      attempts? backoff? delay? lifo? @@ -36,4 +36,4 @@

      Optional stackTraceLimit

      stackTraceLimit?: number

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

      Optional timestamp

      timestamp?: number

      Timestamp when the job was created.

      Default Value

      Date.now()

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ChildMessage.html b/interfaces/v1.ChildMessage.html index 991f1e6119..cfa0ddc86c 100644 --- a/interfaces/v1.ChildMessage.html +++ b/interfaces/v1.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.6

      Interface ChildMessage

      interface ChildMessage {
          cmd: ParentCommand;
          err?: Error;
          value?: any;
      }

      Properties

      cmd +ChildMessage | bullmq - v5.12.7

      Interface ChildMessage

      interface ChildMessage {
          cmd: ParentCommand;
          err?: Error;
          value?: any;
      }

      Properties

      cmd err? value? -

      Properties

      cmd

      cmd: ParentCommand

      Optional err

      err?: Error

      Optional value

      value?: any

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      cmd

      cmd: ParentCommand

      Optional err

      err?: Error

      Optional value

      value?: any

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ChildProcessExt.html b/interfaces/v1.ChildProcessExt.html index 959c01c957..76b5afd40f 100644 --- a/interfaces/v1.ChildProcessExt.html +++ b/interfaces/v1.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.12.6

      Interface ChildProcessExt

      interface ChildProcessExt {
          processFile?: string;
      }

      Hierarchy

      • ChildProcess
        • ChildProcessExt

      Properties

      processFile? -

      Properties

      Optional processFile

      processFile?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +ChildProcessExt | bullmq - v5.12.7

      Interface ChildProcessExt

      interface ChildProcessExt {
          processFile?: string;
      }

      Hierarchy

      • ChildProcess
        • ChildProcessExt

      Properties

      processFile? +

      Properties

      Optional processFile

      processFile?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.Command.html b/interfaces/v1.Command.html index f1dc4d24fc..7f4907e759 100644 --- a/interfaces/v1.Command.html +++ b/interfaces/v1.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.6

      Interface Command

      interface Command {
          name: string;
          options: {
              lua: string;
              numberOfKeys: number;
          };
      }

      Properties

      name +Command | bullmq - v5.12.7

      Interface Command

      interface Command {
          name: string;
          options: {
              lua: string;
              numberOfKeys: number;
          };
      }

      Properties

      name options -

      Properties

      name

      name: string

      options

      options: {
          lua: string;
          numberOfKeys: number;
      }

      Type declaration

      • lua: string
      • numberOfKeys: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      name

      name: string

      options

      options: {
          lua: string;
          numberOfKeys: number;
      }

      Type declaration

      • lua: string
      • numberOfKeys: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.DependenciesOpts.html b/interfaces/v1.DependenciesOpts.html index 620725eaf7..81c97dd102 100644 --- a/interfaces/v1.DependenciesOpts.html +++ b/interfaces/v1.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.6

      Interface DependenciesOpts

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

      Properties

      processed? +DependenciesOpts | bullmq - v5.12.7

      Interface DependenciesOpts

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

      Properties

      processed? unprocessed? -

      Properties

      Optional processed

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

      Type declaration

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

      Optional unprocessed

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

      Type declaration

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

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      Optional processed

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

      Type declaration

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

      Optional unprocessed

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

      Type declaration

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

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.FlowJob.html b/interfaces/v1.FlowJob.html index a5479d21a2..3da1d4670f 100644 --- a/interfaces/v1.FlowJob.html +++ b/interfaces/v1.FlowJob.html @@ -1,7 +1,7 @@ -FlowJob | bullmq - v5.12.6

      Interface FlowJob

      interface FlowJob {
          children?: FlowJob[];
          data?: any;
          name: string;
          opts?: Omit<JobsOptions, "repeat" | "parent">;
          prefix?: string;
          queueName: string;
      }

      Properties

      children? +FlowJob | bullmq - v5.12.7

      Interface FlowJob

      interface FlowJob {
          children?: FlowJob[];
          data?: any;
          name: string;
          opts?: Omit<JobsOptions, "repeat" | "parent">;
          prefix?: string;
          queueName: string;
      }

      Properties

      children? data? name opts? prefix? queueName -

      Properties

      Optional children

      children?: FlowJob[]

      Optional data

      data?: any

      name

      name: string

      Optional opts

      opts?: Omit<JobsOptions, "repeat" | "parent">

      Optional prefix

      prefix?: string

      queueName

      queueName: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      Optional children

      children?: FlowJob[]

      Optional data

      data?: any

      name

      name: string

      Optional opts

      opts?: Omit<JobsOptions, "repeat" | "parent">

      Optional prefix

      prefix?: string

      queueName

      queueName: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.FlowOpts.html b/interfaces/v1.FlowOpts.html index 3820ac4577..64a7798b2f 100644 --- a/interfaces/v1.FlowOpts.html +++ b/interfaces/v1.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.6

      Interface FlowOpts

      interface FlowOpts {
          queuesOptions: FlowQueuesOpts;
      }

      Properties

      queuesOptions +FlowOpts | bullmq - v5.12.7

      Interface FlowOpts

      interface FlowOpts {
          queuesOptions: FlowQueuesOpts;
      }

      Properties

      queuesOptions

      Properties

      queuesOptions

      queuesOptions: FlowQueuesOpts

      Map of options for Queue classes.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.FlowProducerListener.html b/interfaces/v1.FlowProducerListener.html index fd8abacf18..4963b61db8 100644 --- a/interfaces/v1.FlowProducerListener.html +++ b/interfaces/v1.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.6

      Interface FlowProducerListener

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

      Hierarchy (view full)

      Properties

      error +FlowProducerListener | bullmq - v5.12.7

      Interface FlowProducerListener

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

      Hierarchy (view full)

      Properties

      error ioredis:close

      Properties

      error

      error: ((failedReason) => void)

      Type declaration

        • (failedReason): void

        • Listen to 'error' event.

          This event is triggered when an error is throw.

          Parameters

          • failedReason: Error

          Returns void

      ioredis:close

      ioredis:close: (() => void)

      Type declaration

        • (): void

        • Listen to 'ioredis:close' event.

          This event is triggered when ioredis is closed.

          -

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.GetNextJobOptions.html b/interfaces/v1.GetNextJobOptions.html index b69e85b41d..348d320502 100644 --- a/interfaces/v1.GetNextJobOptions.html +++ b/interfaces/v1.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.6

      Interface GetNextJobOptions

      interface GetNextJobOptions {
          block?: boolean;
      }

      Properties

      block? -

      Properties

      Optional block

      block?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

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

      Interface GetNextJobOptions

      interface GetNextJobOptions {
          block?: boolean;
      }

      Properties

      block? +

      Properties

      Optional block

      block?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.IConnection.html b/interfaces/v1.IConnection.html index e41df1b18f..fac1800a76 100644 --- a/interfaces/v1.IConnection.html +++ b/interfaces/v1.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.6

      Interface IConnection

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

      Hierarchy

      • EventEmitter
        • IConnection

      Properties

      client +IConnection | bullmq - v5.12.7

      Interface IConnection

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

      Hierarchy

      • EventEmitter
        • IConnection

      Properties

      client

      Methods

      waitUntilReady -

      Properties

      client

      client: Promise<RedisClient>

      Methods

      waitUntilReady

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      client

      client: Promise<RedisClient>

      Methods

      waitUntilReady

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.IoredisListener.html b/interfaces/v1.IoredisListener.html index 2400125f29..e9f230bfd9 100644 --- a/interfaces/v1.IoredisListener.html +++ b/interfaces/v1.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.6

      Interface IoredisListener

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

      Hierarchy (view full)

      Properties

      ioredis:close +IoredisListener | bullmq - v5.12.7

      Interface IoredisListener

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

      Hierarchy (view full)

      Properties

      ioredis:close

      Properties

      ioredis:close

      ioredis:close: (() => void)

      Type declaration

        • (): void

        • Listen to 'ioredis:close' event.

          This event is triggered when ioredis is closed.

          -

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobInformation3.html b/interfaces/v1.JobInformation3.html index c628285478..d22e3d85e6 100644 --- a/interfaces/v1.JobInformation3.html +++ b/interfaces/v1.JobInformation3.html @@ -1,8 +1,8 @@ -JobInformation3 | bullmq - v5.12.6

      Interface JobInformation3

      interface JobInformation3 {
          cron: string;
          endDate?: number;
          id?: string;
          key: string;
          name: string;
          next: number;
          tz?: string;
      }

      Properties

      cron +JobInformation3 | bullmq - v5.12.7

      Interface JobInformation3

      interface JobInformation3 {
          cron: string;
          endDate?: number;
          id?: string;
          key: string;
          name: string;
          next: number;
          tz?: string;
      }

      Properties

      cron endDate? id? key name next tz? -

      Properties

      cron

      cron: string

      Optional endDate

      endDate?: number

      Optional id

      id?: string

      key

      key: string

      name

      name: string

      next

      next: number

      Optional tz

      tz?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      cron

      cron: string

      Optional endDate

      endDate?: number

      Optional id

      id?: string

      key

      key: string

      name

      name: string

      next

      next: number

      Optional tz

      tz?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobJson.html b/interfaces/v1.JobJson.html index cd0dfd3c77..94af6810f8 100644 --- a/interfaces/v1.JobJson.html +++ b/interfaces/v1.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.6

      Interface JobJson

      interface JobJson {
          attemptsMade: number;
          data: string;
          failedReason: string;
          finishedOn?: number;
          id: string;
          name: string;
          opts: JobsOptions;
          parent?: ParentKeys;
          parentKey?: string;
          processedOn?: number;
          progress: number | object;
          repeatJobKey?: string;
          returnvalue: string;
          stacktrace: string;
          timestamp: number;
      }

      Properties

      attemptsMade +JobJson | bullmq - v5.12.7

      Interface JobJson

      interface JobJson {
          attemptsMade: number;
          data: string;
          failedReason: string;
          finishedOn?: number;
          id: string;
          name: string;
          opts: JobsOptions;
          parent?: ParentKeys;
          parentKey?: string;
          processedOn?: number;
          progress: number | object;
          repeatJobKey?: string;
          returnvalue: string;
          stacktrace: string;
          timestamp: number;
      }

      Properties

      attemptsMade data failedReason finishedOn? @@ -13,4 +13,4 @@ returnvalue stacktrace timestamp -

      Properties

      attemptsMade

      attemptsMade: number

      data

      data: string

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: number

      id

      id: string

      name

      name: string

      opts

      opts: JobsOptions

      Optional parent

      parent?: ParentKeys

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: number

      progress

      progress: number | object

      Optional repeatJobKey

      repeatJobKey?: string

      returnvalue

      returnvalue: string

      stacktrace

      stacktrace: string

      timestamp

      timestamp: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      attemptsMade

      attemptsMade: number

      data

      data: string

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: number

      id

      id: string

      name

      name: string

      opts

      opts: JobsOptions

      Optional parent

      parent?: ParentKeys

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: number

      progress

      progress: number | object

      Optional repeatJobKey

      repeatJobKey?: string

      returnvalue

      returnvalue: string

      stacktrace

      stacktrace: string

      timestamp

      timestamp: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobJsonRaw.html b/interfaces/v1.JobJsonRaw.html index 0b4405229b..af980ec08a 100644 --- a/interfaces/v1.JobJsonRaw.html +++ b/interfaces/v1.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.6

      Interface JobJsonRaw

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

      Properties

      attemptsMade +JobJsonRaw | bullmq - v5.12.7

      Interface JobJsonRaw

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

      Properties

      attemptsMade data delay failedReason @@ -14,4 +14,4 @@ rjk? stacktrace timestamp -

      Properties

      attemptsMade

      attemptsMade: string

      data

      data: string

      delay

      delay: string

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: string

      id

      id: string

      name

      name: string

      opts

      opts: string

      Optional parent

      parent?: string

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: string

      progress

      progress: string

      returnvalue

      returnvalue: string

      Optional rjk

      rjk?: string

      stacktrace

      stacktrace: string[]

      timestamp

      timestamp: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      attemptsMade

      attemptsMade: string

      data

      data: string

      delay

      delay: string

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: string

      id

      id: string

      name

      name: string

      opts

      opts: string

      Optional parent

      parent?: string

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: string

      progress

      progress: string

      returnvalue

      returnvalue: string

      Optional rjk

      rjk?: string

      stacktrace

      stacktrace: string[]

      timestamp

      timestamp: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobNode.html b/interfaces/v1.JobNode.html index 9052094a2c..d2a546cb3a 100644 --- a/interfaces/v1.JobNode.html +++ b/interfaces/v1.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.6

      Interface JobNode

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

      Properties

      children? +JobNode | bullmq - v5.12.7

      Interface JobNode

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

      Properties

      children? job -

      Properties

      Optional children

      children?: JobNode[]

      job

      job: Job<any, any, string>

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      Optional children

      children?: JobNode[]

      job

      job: Job<any, any, string>

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobPromise3.html b/interfaces/v1.JobPromise3.html index 6775b07107..f056005b29 100644 --- a/interfaces/v1.JobPromise3.html +++ b/interfaces/v1.JobPromise3.html @@ -1,3 +1,3 @@ -JobPromise3 | bullmq - v5.12.6

      Interface JobPromise3

      interface JobPromise3 {
          cancel(): void;
      }

      Methods

      cancel +JobPromise3 | bullmq - v5.12.7

      Interface JobPromise3

      interface JobPromise3 {
          cancel(): void;
      }

      Methods

      cancel

      Methods

      cancel

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.JobsOptions.html b/interfaces/v1.JobsOptions.html index c0f690bab8..8eeafc3002 100644 --- a/interfaces/v1.JobsOptions.html +++ b/interfaces/v1.JobsOptions.html @@ -1,4 +1,4 @@ -JobsOptions | bullmq - v5.12.6

      Interface JobsOptions

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

      Hierarchy (view full)

      Properties

      attempts? +JobsOptions | bullmq - v5.12.7

      Interface JobsOptions

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

      Hierarchy (view full)

      Properties

      attempts? backoff? delay? jobId? @@ -49,4 +49,4 @@

      Optional stackTraceLimit

      stackTraceLimit?: number

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

      Optional timestamp

      timestamp?: number

      Timestamp when the job was created.

      Default Value

      Date.now()

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.KeepJobs.html b/interfaces/v1.KeepJobs.html index bbfa113ca6..14441d8e9c 100644 --- a/interfaces/v1.KeepJobs.html +++ b/interfaces/v1.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.6

      Interface KeepJobs

      KeepJobs

      +KeepJobs | bullmq - v5.12.7

      Interface KeepJobs

      KeepJobs

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

      @@ -6,4 +6,4 @@ count?

      Properties

      Optional age

      age?: number

      Maximum age in seconds for job to be kept.

      Optional count

      count?: number

      Maximum count of jobs to be kept.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.Metrics.html b/interfaces/v1.Metrics.html index d4667ecedd..07b549e16a 100644 --- a/interfaces/v1.Metrics.html +++ b/interfaces/v1.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.6

      Interface Metrics

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

      Properties

      count +Metrics | bullmq - v5.12.7

      Interface Metrics

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

      Properties

      count data meta -

      Properties

      count

      count: number

      data

      data: number[]

      meta

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

      Type declaration

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

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      count

      count: number

      data

      data: number[]

      meta

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

      Type declaration

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

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.MetricsOptions.html b/interfaces/v1.MetricsOptions.html index c6a043d443..9483e08fbb 100644 --- a/interfaces/v1.MetricsOptions.html +++ b/interfaces/v1.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.6

      Interface MetricsOptions

      interface MetricsOptions {
          maxDataPoints?: number;
      }

      Properties

      maxDataPoints? +MetricsOptions | bullmq - v5.12.7

      Interface MetricsOptions

      interface MetricsOptions {
          maxDataPoints?: number;
      }

      Properties

      maxDataPoints?

      Properties

      Optional maxDataPoints

      maxDataPoints?: number

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

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.MoveToWaitingChildrenOpts.html b/interfaces/v1.MoveToWaitingChildrenOpts.html index 141fe351c3..d2d43ef6e9 100644 --- a/interfaces/v1.MoveToWaitingChildrenOpts.html +++ b/interfaces/v1.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.6

      Interface MoveToWaitingChildrenOpts

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

      Properties

      child? -

      Properties

      Optional child

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

      Type declaration

      • id: string
      • queue: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

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

      Interface MoveToWaitingChildrenOpts

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

      Properties

      child? +

      Properties

      Optional child

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

      Type declaration

      • id: string
      • queue: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.NodeOpts.html b/interfaces/v1.NodeOpts.html index e6a45f8267..0fa42cd9bd 100644 --- a/interfaces/v1.NodeOpts.html +++ b/interfaces/v1.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.6

      Interface NodeOpts

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

      Properties

      depth? +NodeOpts | bullmq - v5.12.7

      Interface NodeOpts

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

      Properties

      depth? id maxChildren? prefix? @@ -8,4 +8,4 @@

      Optional maxChildren

      maxChildren?: number

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

      Optional prefix

      prefix?: string

      Prefix included in job key.

      queueName

      queueName: string

      Root job queue name.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ObliterateOpts.html b/interfaces/v1.ObliterateOpts.html index 449f4f7ab0..3b3edf0d79 100644 --- a/interfaces/v1.ObliterateOpts.html +++ b/interfaces/v1.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.6

      Interface ObliterateOpts

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

      Properties

      count? +ObliterateOpts | bullmq - v5.12.7

      Interface ObliterateOpts

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

      Properties

      count? force?

      Properties

      Optional count

      count?: number

      Use count with the maximum number of deleted keys per iteration

      Default Value

      1000

      Optional force

      force?: boolean

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

      Default Value

      false

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.Parent.html b/interfaces/v1.Parent.html index 904f9e1464..de6ef28492 100644 --- a/interfaces/v1.Parent.html +++ b/interfaces/v1.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.6

      Interface Parent<T>

      Describes the parent for a Job.

      +Parent | bullmq - v5.12.7

      Interface Parent<T>

      Describes the parent for a Job.

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

      Type Parameters

      • T

      Properties

      data? name opts? prefix? queue? -

      Properties

      Optional data

      data?: T

      name

      name: string

      Optional opts

      opts?: JobsOptions

      Optional prefix

      prefix?: string

      Optional queue

      queue?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      Optional data

      data?: T

      name

      name: string

      Optional opts

      opts?: JobsOptions

      Optional prefix

      prefix?: string

      Optional queue

      queue?: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ParentKeys.html b/interfaces/v1.ParentKeys.html index 89166728dc..ac24a87bb8 100644 --- a/interfaces/v1.ParentKeys.html +++ b/interfaces/v1.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.6

      Interface ParentKeys

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

      Properties

      id +ParentKeys | bullmq - v5.12.7

      Interface ParentKeys

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

      Properties

      id queueKey -

      Properties

      id

      id: string

      queueKey

      queueKey: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      id

      id: string

      queueKey

      queueKey: string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ParentMessage.html b/interfaces/v1.ParentMessage.html index 7683eb5ce3..ff53506bde 100644 --- a/interfaces/v1.ParentMessage.html +++ b/interfaces/v1.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.6

      Interface ParentMessage

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

      Properties

      cmd +ParentMessage | bullmq - v5.12.7

      Interface ParentMessage

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

      Properties

      cmd err? job? value? -

      Properties

      cmd

      cmd: ChildCommand

      Optional err

      err?: Error

      Optional job

      job?: JobJson

      Optional value

      value?: any

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      cmd

      cmd: ChildCommand

      Optional err

      err?: Error

      Optional job

      job?: JobJson

      Optional value

      value?: any

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueBaseOptions.html b/interfaces/v1.QueueBaseOptions.html index 27040fa760..6d71f5370e 100644 --- a/interfaces/v1.QueueBaseOptions.html +++ b/interfaces/v1.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.6

      Interface QueueBaseOptions

      Base Queue options

      +QueueBaseOptions | bullmq - v5.12.7

      Interface QueueBaseOptions

      Base Queue options

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

      Hierarchy (view full)

      Properties

      blockingConnection? connection? prefix? @@ -7,4 +7,4 @@

      Optional connection

      connection?: ConnectionOptions

      Options for connecting to a Redis instance.

      Optional prefix

      prefix?: string

      Prefix for all queue keys.

      Optional sharedConnection

      sharedConnection?: boolean

      Specify if the connection is shared.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueEventsListener.html b/interfaces/v1.QueueEventsListener.html index 3e82eaf453..57e911a56b 100644 --- a/interfaces/v1.QueueEventsListener.html +++ b/interfaces/v1.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.6

      Interface QueueEventsListener

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

      Hierarchy (view full)

      Properties

      active +QueueEventsListener | bullmq - v5.12.7

      Interface QueueEventsListener

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

      Hierarchy (view full)

      Properties

      active added cleaned completed @@ -57,4 +57,4 @@

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

      Parameters

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

      Returns void

      waiting-children

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

      Type declaration

        • (args, id): void

        • Listen to 'waiting-children' event.

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

          -

          Parameters

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

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

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

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueEventsOptions.html b/interfaces/v1.QueueEventsOptions.html index 1700b79949..f56cc7a75f 100644 --- a/interfaces/v1.QueueEventsOptions.html +++ b/interfaces/v1.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.6

      Interface QueueEventsOptions

      Options for QueueEvents

      +QueueEventsOptions | bullmq - v5.12.7

      Interface QueueEventsOptions

      Options for QueueEvents

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

      Hierarchy (view full)

      Properties

      autorun? blockingConnection? blockingTimeout? @@ -15,4 +15,4 @@ produced event.

      Optional prefix

      prefix?: string

      Prefix for all queue keys.

      Optional sharedConnection

      sharedConnection?: boolean

      Specify if the connection is shared.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueListener.html b/interfaces/v1.QueueListener.html index ec1142101c..7c0a34b170 100644 --- a/interfaces/v1.QueueListener.html +++ b/interfaces/v1.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.6

      Interface QueueListener<DataType, ResultType, NameType>

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

      Type Parameters

      • DataType
      • ResultType
      • NameType extends string

      Hierarchy (view full)

      Properties

      cleaned +QueueListener | bullmq - v5.12.7

      Interface QueueListener<DataType, ResultType, NameType>

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

      Type Parameters

      • DataType
      • ResultType
      • NameType extends string

      Hierarchy (view full)

      Properties

      cleaned error ioredis:close paused @@ -22,4 +22,4 @@

      This event is triggered when the queue is resumed.

      Returns void

      waiting

      waiting: ((job) => void)

      Type declaration

        • (job): void

        • Listen to 'waiting' event.

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

          -

          Parameters

          • job: Job<DataType, ResultType, NameType>

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • job: Job<DataType, ResultType, NameType>

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueOptions.html b/interfaces/v1.QueueOptions.html index 84bc7d0556..e2d110f126 100644 --- a/interfaces/v1.QueueOptions.html +++ b/interfaces/v1.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.6

      Interface QueueOptions

      Options for the Queue class.

      +QueueOptions | bullmq - v5.12.7

      Interface QueueOptions

      Options for the Queue class.

      interface QueueOptions {
          blockingConnection?: boolean;
          connection?: ConnectionOptions;
          defaultJobOptions?: BaseJobOptions;
          limiter?: {
              groupKey: string;
          };
          prefix?: string;
          settings?: AdvancedRepeatOptions;
          sharedConnection?: boolean;
          streams?: {
              events: {
                  maxLen: number;
              };
          };
      }

      Hierarchy (view full)

      Properties

      blockingConnection? connection? defaultJobOptions? @@ -17,4 +17,4 @@

      Optional streams

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

      Options for the streams used internally in BullMQ.

      Type declaration

      • events: {
            maxLen: number;
        }

        Options for the events stream.

        • maxLen: number

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

          -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueSchedulerListener.html b/interfaces/v1.QueueSchedulerListener.html index 150b503b46..77c7c953f1 100644 --- a/interfaces/v1.QueueSchedulerListener.html +++ b/interfaces/v1.QueueSchedulerListener.html @@ -1,4 +1,4 @@ -QueueSchedulerListener | bullmq - v5.12.6

      Interface QueueSchedulerListener

      interface QueueSchedulerListener {
          error: ((error) => void);
          failed: ((jobId, failedReason, prev) => void);
          ioredis:close: (() => void);
          stalled: ((jobId, prev) => void);
      }

      Hierarchy (view full)

      Properties

      error +QueueSchedulerListener | bullmq - v5.12.7

      Interface QueueSchedulerListener

      interface QueueSchedulerListener {
          error: ((error) => void);
          failed: ((jobId, failedReason, prev) => void);
          ioredis:close: (() => void);
          stalled: ((jobId, prev) => void);
      }

      Hierarchy (view full)

      Properties

      error failed ioredis:close stalled @@ -10,4 +10,4 @@

      This event is triggered when ioredis is closed.

      Returns void

      stalled

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

      Type declaration

        • (jobId, prev): void

        • Listen to 'stalled' event.

          This event is triggered when a job gets stalled.

          -

          Parameters

          • jobId: string
          • prev: string

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • jobId: string
      • prev: string

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.QueueSchedulerOptions.html b/interfaces/v1.QueueSchedulerOptions.html index 6a6787ca71..bcba60bbbd 100644 --- a/interfaces/v1.QueueSchedulerOptions.html +++ b/interfaces/v1.QueueSchedulerOptions.html @@ -1,4 +1,4 @@ -QueueSchedulerOptions | bullmq - v5.12.6

      Interface QueueSchedulerOptions

      Options for customizing the behaviour of the scheduler.

      +QueueSchedulerOptions | bullmq - v5.12.7

      Interface QueueSchedulerOptions

      Options for customizing the behaviour of the scheduler.

      See

      Optional prefix

      prefix?: string

      Prefix for all queue keys.

      Optional sharedConnection

      sharedConnection?: boolean

      Specify if the connection is shared.

      Optional stalledInterval

      stalledInterval?: number

      Number of milliseconds between stallness checks.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.RateLimiterOptions.html b/interfaces/v1.RateLimiterOptions.html index ea402c3760..0bce1b7ddf 100644 --- a/interfaces/v1.RateLimiterOptions.html +++ b/interfaces/v1.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.12.6

      Interface RateLimiterOptions

      interface RateLimiterOptions {
          duration: number;
          groupKey?: string;
          max: number;
          workerDelay?: boolean;
      }

      Properties

      duration +RateLimiterOptions | bullmq - v5.12.7

      Interface RateLimiterOptions

      interface RateLimiterOptions {
          duration: number;
          groupKey?: string;
          max: number;
          workerDelay?: boolean;
      }

      Properties

      duration groupKey? max workerDelay? @@ -17,4 +17,4 @@ groupKeys unless you have a big amount of workers since you may be delaying workers that could pick jobs in groups that have not been rate limited.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.RepeatBaseOptions.html b/interfaces/v1.RepeatBaseOptions.html index b9a447e2c7..fbaddc686b 100644 --- a/interfaces/v1.RepeatBaseOptions.html +++ b/interfaces/v1.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.6

      Interface RepeatBaseOptions

      Options for the Repeat class.

      +RepeatBaseOptions | bullmq - v5.12.7

      Interface RepeatBaseOptions

      Options for the Repeat class.

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

      Hierarchy (view full)

      Properties

      blockingConnection? connection? prefix? @@ -8,4 +8,4 @@

      Optional connection

      connection?: ConnectionOptions

      Options for connecting to a Redis instance.

      Optional prefix

      prefix?: string

      Prefix for all queue keys.

      Optional settings

      settings?: AdvancedRepeatOptions

      Optional sharedConnection

      sharedConnection?: boolean

      Specify if the connection is shared.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.RepeatOptions.html b/interfaces/v1.RepeatOptions.html index 7af4ea3526..3a9791a5a9 100644 --- a/interfaces/v1.RepeatOptions.html +++ b/interfaces/v1.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.6

      Interface RepeatOptions

      Settings for repeatable jobs

      +RepeatOptions | bullmq - v5.12.7

      Interface RepeatOptions

      Settings for repeatable jobs

      See

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

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

      Hierarchy

      • Omit<ParserOptions, "iterator">
        • RepeatOptions

      Properties

      count? cron? @@ -18,4 +18,4 @@ ( work only with every settings)

      Optional jobId

      jobId?: string

      Optional limit

      limit?: number

      Number of times the job should repeat at max.

      Optional offset

      offset?: number

      Optional pattern

      pattern?: string

      A repeat pattern

      -

      Optional prevMillis

      prevMillis?: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Optional prevMillis

      prevMillis?: number

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.SandboxedJob.html b/interfaces/v1.SandboxedJob.html index b7540b2be2..c2e49e6dfa 100644 --- a/interfaces/v1.SandboxedJob.html +++ b/interfaces/v1.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.6

      Interface SandboxedJob<T, R>

      See

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

      +SandboxedJob | bullmq - v5.12.7

      Interface SandboxedJob<T, R>

      See

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

      interface SandboxedJob<T, R> {
          attemptsMade: number;
          data: T;
          failedReason: string;
          finishedOn?: number;
          id: string;
          log: ((row) => void);
          name: string;
          opts: JobsOptions;
          parent?: ParentKeys;
          parentKey?: string;
          processedOn?: number;
          progress: (() => number | object) | ((value) => Promise<void>);
          repeatJobKey?: string;
          returnValue: R;
          returnvalue: string;
          stacktrace: string;
          timestamp: number;
          update: ((data) => Promise<void>);
          updateProgress: ((value) => Promise<void>);
      }

      Type Parameters

      • T = any
      • R = any

      Hierarchy

      • Omit<JobJson, "data" | "opts" | "progress" | "returnValue">
        • SandboxedJob

      Properties

      attemptsMade data failedReason @@ -18,4 +18,4 @@ timestamp update updateProgress -

      Properties

      attemptsMade

      attemptsMade: number

      data

      data: T

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: number

      id

      id: string

      log

      log: ((row) => void)

      Type declaration

        • (row): void

        • Parameters

          • row: any

          Returns void

      name

      name: string

      opts

      opts: JobsOptions

      Optional parent

      parent?: ParentKeys

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: number

      progress

      progress: (() => number | object) | ((value) => Promise<void>)

      Type declaration

        • (): number | object

        • Returns number | object

      Type declaration

        • (value): Promise<void>

        • Parameters

          • value: number | object

          Returns Promise<void>

      Optional repeatJobKey

      repeatJobKey?: string

      returnValue

      returnValue: R

      returnvalue

      returnvalue: string

      stacktrace

      stacktrace: string

      timestamp

      timestamp: number

      update

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

      Type declaration

        • (data): Promise<void>

        • Parameters

          • data: any

          Returns Promise<void>

      updateProgress

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

      Type declaration

        • (value): Promise<void>

        • Parameters

          • value: number | object

          Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      attemptsMade

      attemptsMade: number

      data

      data: T

      failedReason

      failedReason: string

      Optional finishedOn

      finishedOn?: number

      id

      id: string

      log

      log: ((row) => void)

      Type declaration

        • (row): void

        • Parameters

          • row: any

          Returns void

      name

      name: string

      opts

      opts: JobsOptions

      Optional parent

      parent?: ParentKeys

      Optional parentKey

      parentKey?: string

      Optional processedOn

      processedOn?: number

      progress

      progress: (() => number | object) | ((value) => Promise<void>)

      Type declaration

        • (): number | object

        • Returns number | object

      Type declaration

        • (value): Promise<void>

        • Parameters

          • value: number | object

          Returns Promise<void>

      Optional repeatJobKey

      repeatJobKey?: string

      returnValue

      returnValue: R

      returnvalue

      returnvalue: string

      stacktrace

      stacktrace: string

      timestamp

      timestamp: number

      update

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

      Type declaration

        • (data): Promise<void>

        • Parameters

          • data: any

          Returns Promise<void>

      updateProgress

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

      Type declaration

        • (value): Promise<void>

        • Parameters

          • value: number | object

          Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.ScriptMetadata.html b/interfaces/v1.ScriptMetadata.html index 9bfd512390..3e42d7e3e8 100644 --- a/interfaces/v1.ScriptMetadata.html +++ b/interfaces/v1.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.6

      Interface ScriptMetadata

      Script metadata

      +ScriptMetadata | bullmq - v5.12.7

      Interface ScriptMetadata

      Script metadata

      interface ScriptMetadata {
          content: string;
          includes: ScriptMetadata[];
          name: string;
          numberOfKeys?: number;
          path: string;
          token: string;
      }

      Properties

      content includes name @@ -11,4 +11,4 @@

      Optional numberOfKeys

      numberOfKeys?: number

      path

      path: string

      The path to the script. For includes, this is the normalized path, whereas it may not be normalized for the top-level parent

      token

      token: string

      A hash of the normalized path for easy replacement in the parent

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.Strategies.html b/interfaces/v1.Strategies.html index 6f0906c634..463a64d3f9 100644 --- a/interfaces/v1.Strategies.html +++ b/interfaces/v1.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.12.6

      Interface Strategies

      interface Strategies {
          [index: string]: BackoffFunction;
      }

      Indexable

      [index: string]: BackoffFunction

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +Strategies | bullmq - v5.12.7

      Interface Strategies

      interface Strategies {
          [index: string]: BackoffFunction;
      }

      Indexable

      [index: string]: BackoffFunction

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.WorkerListener.html b/interfaces/v1.WorkerListener.html index 3bb8e46e7b..83d534c34b 100644 --- a/interfaces/v1.WorkerListener.html +++ b/interfaces/v1.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.6

      Interface WorkerListener<DataType, ResultType, NameType>

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

      Type Parameters

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

      Hierarchy (view full)

      Properties

      active +WorkerListener | bullmq - v5.12.7

      Interface WorkerListener<DataType, ResultType, NameType>

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

      Type Parameters

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

      Hierarchy (view full)

      Properties

      active closed closing completed @@ -36,4 +36,4 @@ world.

      Parameters

      • job: Job<DataType, ResultType, NameType>
      • progress: number | object

      Returns void

      resumed

      resumed: (() => void)

      Type declaration

        • (): void

        • Listen to 'resumed' event.

          This event is triggered when the queue is resumed.

          -

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v1.WorkerOptions.html b/interfaces/v1.WorkerOptions.html index 8bc9006654..0eb27ddd5b 100644 --- a/interfaces/v1.WorkerOptions.html +++ b/interfaces/v1.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.6

      Interface WorkerOptions

      Base Queue options

      +WorkerOptions | bullmq - v5.12.7

      Interface WorkerOptions

      Base Queue options

      interface WorkerOptions {
          autorun?: boolean;
          blockingConnection?: boolean;
          concurrency?: number;
          connection?: ConnectionOptions;
          drainDelay?: number;
          limiter?: RateLimiterOptions;
          lockDuration?: number;
          lockRenewTime?: number;
          metrics?: MetricsOptions;
          prefix?: string;
          runRetryDelay?: number;
          settings?: AdvancedOptions;
          sharedConnection?: boolean;
          skipDelayCheck?: boolean;
      }

      Hierarchy (view full)

      Properties

      autorun? blockingConnection? concurrency? @@ -25,4 +25,4 @@

      See

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

      Optional prefix

      prefix?: string

      Prefix for all queue keys.

      Optional runRetryDelay

      runRetryDelay?: number

      Optional settings

      settings?: AdvancedOptions

      Optional sharedConnection

      sharedConnection?: boolean

      Specify if the connection is shared.

      -

      Optional skipDelayCheck

      skipDelayCheck?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Optional skipDelayCheck

      skipDelayCheck?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v2.AddChildrenOpts.html b/interfaces/v2.AddChildrenOpts.html index e58a4575cf..4f2f161b6b 100644 --- a/interfaces/v2.AddChildrenOpts.html +++ b/interfaces/v2.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.6

      Interface AddChildrenOpts

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

      Properties

      multi +AddChildrenOpts | bullmq - v5.12.7

      Interface AddChildrenOpts

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

      Properties

      multi nodes parent queuesOpts? -

      Properties

      multi

      multi: ChainableCommander

      nodes

      nodes: FlowJob[]

      parent

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

      Type declaration

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

      Optional queuesOpts

      queuesOpts?: FlowQueuesOpts

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      multi

      multi: ChainableCommander

      nodes

      nodes: FlowJob[]

      parent

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

      Type declaration

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

      Optional queuesOpts

      queuesOpts?: FlowQueuesOpts

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v2.AddNodeOpts.html b/interfaces/v2.AddNodeOpts.html index 4077cbe8e8..fa4d57bc47 100644 --- a/interfaces/v2.AddNodeOpts.html +++ b/interfaces/v2.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.6

      Interface AddNodeOpts

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

      Properties

      multi +AddNodeOpts | bullmq - v5.12.7

      Interface AddNodeOpts

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

      Properties

      multi node parent? queuesOpts?

      Properties

      multi

      multi: ChainableCommander

      node

      node: FlowJob

      Optional parent

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

      Type declaration

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

      Optional queuesOpts

      queuesOpts?: FlowQueuesOpts

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

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/v2.AdvancedOptions.html b/interfaces/v2.AdvancedOptions.html index 8c16f91d04..be557f4522 100644 --- a/interfaces/v2.AdvancedOptions.html +++ b/interfaces/v2.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.6

      Interface AdvancedOptions

      interface AdvancedOptions {
          backoffStrategies?: {};
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      backoffStrategies? +AdvancedOptions | bullmq - v5.12.7

      Interface AdvancedOptions

      interface AdvancedOptions {
          backoffStrategies?: {};
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      backoffStrategies? repeatStrategy?

      Properties

      Optional backoffStrategies

      backoffStrategies?: {}

      A set of custom backoff strategies keyed by name.

      Type declaration

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A set of custom cron strategies keyed by name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.AdvancedRepeatOptions.html b/interfaces/v2.AdvancedRepeatOptions.html index 77547c7fe0..a429be6a3e 100644 --- a/interfaces/v2.AdvancedRepeatOptions.html +++ b/interfaces/v2.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.6

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.7

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy?

        Properties

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A set of custom cron strategies keyed by name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.BackoffOptions.html b/interfaces/v2.BackoffOptions.html index 7e8e8a6c0b..60efc56cf7 100644 --- a/interfaces/v2.BackoffOptions.html +++ b/interfaces/v2.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.6

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.7

        Interface BackoffOptions

        Settings for backing off failed jobs.

        See

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

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

        Properties

        delay? type

        Properties

        Optional delay

        delay?: number

        Delay in milliseconds.

        type

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

        Name of the backoff strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.BaseJobOptions.html b/interfaces/v2.BaseJobOptions.html index fe0bd0fbae..d2bcd70df4 100644 --- a/interfaces/v2.BaseJobOptions.html +++ b/interfaces/v2.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.6

        Interface BaseJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? +BaseJobOptions | bullmq - v5.12.7

        Interface BaseJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? jobId? @@ -49,4 +49,4 @@

        Optional stackTraceLimit

        stackTraceLimit?: number

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

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ChildMessage.html b/interfaces/v2.ChildMessage.html index 4cb0fecb8e..58c777fe1a 100644 --- a/interfaces/v2.ChildMessage.html +++ b/interfaces/v2.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.6

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Error;
            value?: any;
        }

        Properties

        cmd +ChildMessage | bullmq - v5.12.7

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Error;
            value?: any;
        }

        Properties

        cmd err? value? -

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Error

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Error

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ChildProcessExt.html b/interfaces/v2.ChildProcessExt.html index 86fd509488..216b046e9b 100644 --- a/interfaces/v2.ChildProcessExt.html +++ b/interfaces/v2.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.12.6

        Interface ChildProcessExt

        interface ChildProcessExt {
            processFile?: string;
        }

        Hierarchy

        • ChildProcess
          • ChildProcessExt

        Properties

        processFile? -

        Properties

        Optional processFile

        processFile?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +ChildProcessExt | bullmq - v5.12.7

        Interface ChildProcessExt

        interface ChildProcessExt {
            processFile?: string;
        }

        Hierarchy

        • ChildProcess
          • ChildProcessExt

        Properties

        processFile? +

        Properties

        Optional processFile

        processFile?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.Command.html b/interfaces/v2.Command.html index 669024069f..719aab6d60 100644 --- a/interfaces/v2.Command.html +++ b/interfaces/v2.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.6

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.7

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name options -

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.DefaultJobOptions.html b/interfaces/v2.DefaultJobOptions.html index cf088ef8a5..b983d83bdb 100644 --- a/interfaces/v2.DefaultJobOptions.html +++ b/interfaces/v2.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.6

        Interface DefaultJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? +DefaultJobOptions | bullmq - v5.12.7

        Interface DefaultJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? lifo? @@ -36,4 +36,4 @@

        Optional stackTraceLimit

        stackTraceLimit?: number

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

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.DependenciesOpts.html b/interfaces/v2.DependenciesOpts.html index a19042fef2..0391fa2608 100644 --- a/interfaces/v2.DependenciesOpts.html +++ b/interfaces/v2.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.6

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.7

        Interface DependenciesOpts

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

        Properties

        processed? unprocessed? -

        Properties

        Optional processed

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

        Type declaration

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

        Optional unprocessed

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional processed

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

        Type declaration

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

        Optional unprocessed

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.FlowOpts.html b/interfaces/v2.FlowOpts.html index 58fc5555c3..d683b7b6cc 100644 --- a/interfaces/v2.FlowOpts.html +++ b/interfaces/v2.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.6

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.7

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions

        Properties

        queuesOptions

        queuesOptions: FlowQueuesOpts

        Map of options for Queue classes.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.FlowProducerListener.html b/interfaces/v2.FlowProducerListener.html index 7bb473940c..81b0b33215 100644 --- a/interfaces/v2.FlowProducerListener.html +++ b/interfaces/v2.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.6

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.7

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error ioredis:close

        Properties

        error

        error: ((failedReason) => void)

        Type declaration

          • (failedReason): void

          • Listen to 'error' event.

            This event is triggered when an error is throw.

            Parameters

            • failedReason: Error

            Returns void

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.GetNextJobOptions.html b/interfaces/v2.GetNextJobOptions.html index 09ae373c93..d781fa42ca 100644 --- a/interfaces/v2.GetNextJobOptions.html +++ b/interfaces/v2.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.6

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? -

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

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

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? +

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.IConnection.html b/interfaces/v2.IConnection.html index 36cde38f21..ff5cf2628d 100644 --- a/interfaces/v2.IConnection.html +++ b/interfaces/v2.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.6

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.7

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client

        Methods

        waitUntilReady -

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.IoredisListener.html b/interfaces/v2.IoredisListener.html index 25ae5cb615..2bf0cb0e1d 100644 --- a/interfaces/v2.IoredisListener.html +++ b/interfaces/v2.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.6

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.7

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close

        Properties

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.JobJson.html b/interfaces/v2.JobJson.html index 1f8a61d298..7e78247f5c 100644 --- a/interfaces/v2.JobJson.html +++ b/interfaces/v2.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.6

        Interface JobJson

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

        Properties

        attemptsMade +JobJson | bullmq - v5.12.7

        Interface JobJson

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

        Properties

        attemptsMade data failedReason finishedOn? @@ -13,4 +13,4 @@ returnvalue stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.JobJsonRaw.html b/interfaces/v2.JobJsonRaw.html index 3bb38aa702..8d5497abc2 100644 --- a/interfaces/v2.JobJsonRaw.html +++ b/interfaces/v2.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.6

        Interface JobJsonRaw

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

        Properties

        attemptsMade +JobJsonRaw | bullmq - v5.12.7

        Interface JobJsonRaw

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

        Properties

        attemptsMade data delay failedReason @@ -14,4 +14,4 @@ rjk? stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.JobNode.html b/interfaces/v2.JobNode.html index 8cdcbc5858..67c0d3aeb8 100644 --- a/interfaces/v2.JobNode.html +++ b/interfaces/v2.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.6

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.7

        Interface JobNode

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

        Properties

        children? job -

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.KeepJobs.html b/interfaces/v2.KeepJobs.html index e74f614361..ac300380ca 100644 --- a/interfaces/v2.KeepJobs.html +++ b/interfaces/v2.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.6

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.7

        Interface KeepJobs

        KeepJobs

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

        @@ -6,4 +6,4 @@ count?

        Properties

        Optional age

        age?: number

        Maximum age in seconds for job to be kept.

        Optional count

        count?: number

        Maximum count of jobs to be kept.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.Metrics.html b/interfaces/v2.Metrics.html index 0e674d763b..f6b0bf9cc1 100644 --- a/interfaces/v2.Metrics.html +++ b/interfaces/v2.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.6

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.7

        Interface Metrics

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

        Properties

        count data meta -

        Properties

        count

        count: number

        data

        data: number[]

        meta

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        count

        count: number

        data

        data: number[]

        meta

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.MetricsOptions.html b/interfaces/v2.MetricsOptions.html index d0d8924cba..4235ea0fba 100644 --- a/interfaces/v2.MetricsOptions.html +++ b/interfaces/v2.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.6

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.7

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints?

        Properties

        Optional maxDataPoints

        maxDataPoints?: number

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

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.MoveToWaitingChildrenOpts.html b/interfaces/v2.MoveToWaitingChildrenOpts.html index 4f8979747c..901e9eaf87 100644 --- a/interfaces/v2.MoveToWaitingChildrenOpts.html +++ b/interfaces/v2.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.6

        Interface MoveToWaitingChildrenOpts

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

        Properties

        child? -

        Properties

        Optional child

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

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

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

        Interface MoveToWaitingChildrenOpts

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

        Properties

        child? +

        Properties

        Optional child

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

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.NodeOpts.html b/interfaces/v2.NodeOpts.html index 3a0567933f..4e1a1668f9 100644 --- a/interfaces/v2.NodeOpts.html +++ b/interfaces/v2.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.6

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.7

        Interface NodeOpts

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

        Properties

        depth? id maxChildren? prefix? @@ -8,4 +8,4 @@

        Optional maxChildren

        maxChildren?: number

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

        Optional prefix

        prefix?: string

        Prefix included in job key.

        queueName

        queueName: string

        Root job queue name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ObliterateOpts.html b/interfaces/v2.ObliterateOpts.html index 37f0a02105..d8cfc88697 100644 --- a/interfaces/v2.ObliterateOpts.html +++ b/interfaces/v2.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.6

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.7

        Interface ObliterateOpts

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

        Properties

        count? force?

        Properties

        Optional count

        count?: number

        Use count with the maximum number of deleted keys per iteration

        Default Value

        1000

        Optional force

        force?: boolean

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

        Default Value

        false

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.Parent.html b/interfaces/v2.Parent.html index 3e5dd7fed6..e14c3522ce 100644 --- a/interfaces/v2.Parent.html +++ b/interfaces/v2.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.6

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.7

        Interface Parent<T>

        Describes the parent for a Job.

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

        Type Parameters

        • T

        Properties

        data? name opts? prefix? queue? -

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ParentKeys.html b/interfaces/v2.ParentKeys.html index aea1c7524b..88c32e2dac 100644 --- a/interfaces/v2.ParentKeys.html +++ b/interfaces/v2.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.6

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.7

        Interface ParentKeys

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

        Properties

        id queueKey -

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ParentMessage.html b/interfaces/v2.ParentMessage.html index d71866cae4..4c4451fb3d 100644 --- a/interfaces/v2.ParentMessage.html +++ b/interfaces/v2.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.6

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.7

        Interface ParentMessage

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

        Properties

        cmd err? job? value? -

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.QueueBaseOptions.html b/interfaces/v2.QueueBaseOptions.html index a5275fa3ac..1b8aa9c56c 100644 --- a/interfaces/v2.QueueBaseOptions.html +++ b/interfaces/v2.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.6

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.7

        Interface QueueBaseOptions

        Base Queue options

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

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -7,4 +7,4 @@

        Optional connection

        connection?: ConnectionOptions

        Options for connecting to a Redis instance.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.QueueEventsListener.html b/interfaces/v2.QueueEventsListener.html index 29c026d3d0..6c36bcc66f 100644 --- a/interfaces/v2.QueueEventsListener.html +++ b/interfaces/v2.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.6

        Interface QueueEventsListener

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

        Hierarchy (view full)

        Properties

        active +QueueEventsListener | bullmq - v5.12.7

        Interface QueueEventsListener

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

        Hierarchy (view full)

        Properties

        active added cleaned completed @@ -57,4 +57,4 @@

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

        Parameters

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

        Returns void

        waiting-children

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

        Type declaration

          • (args, id): void

          • Listen to 'waiting-children' event.

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

            -

            Parameters

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

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

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

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.QueueEventsOptions.html b/interfaces/v2.QueueEventsOptions.html index 5c9202f1f9..87b267fea5 100644 --- a/interfaces/v2.QueueEventsOptions.html +++ b/interfaces/v2.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.6

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.7

        Interface QueueEventsOptions

        Options for QueueEvents

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

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? blockingTimeout? @@ -15,4 +15,4 @@ produced event.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.QueueListener.html b/interfaces/v2.QueueListener.html index ae7d1fda6f..393247f482 100644 --- a/interfaces/v2.QueueListener.html +++ b/interfaces/v2.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.6

        Interface QueueListener<DataType, ResultType, NameType>

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

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned +QueueListener | bullmq - v5.12.7

        Interface QueueListener<DataType, ResultType, NameType>

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

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned error ioredis:close paused @@ -22,4 +22,4 @@

        This event is triggered when the queue is resumed.

        Returns void

        waiting

        waiting: ((job) => void)

        Type declaration

          • (job): void

          • Listen to 'waiting' event.

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

            -

            Parameters

            • job: Job<DataType, ResultType, NameType>

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • job: Job<DataType, ResultType, NameType>

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.QueueOptions.html b/interfaces/v2.QueueOptions.html index 7fcf770b11..70e28c5f8a 100644 --- a/interfaces/v2.QueueOptions.html +++ b/interfaces/v2.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.6

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.7

        Interface QueueOptions

        Options for the Queue class.

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

        Hierarchy (view full)

        Properties

        blockingConnection? connection? defaultJobOptions? @@ -17,4 +17,4 @@

        Optional streams

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

        Options for the streams used internally in BullMQ.

        Type declaration

        • events: {
              maxLen: number;
          }

          Options for the events stream.

          • maxLen: number

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

            -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.RateLimiterOptions.html b/interfaces/v2.RateLimiterOptions.html index 57c5cbc778..07094eff16 100644 --- a/interfaces/v2.RateLimiterOptions.html +++ b/interfaces/v2.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.12.6

        Interface RateLimiterOptions

        interface RateLimiterOptions {
            duration: number;
            groupKey?: string;
            max: number;
            workerDelay?: boolean;
        }

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.7

        Interface RateLimiterOptions

        interface RateLimiterOptions {
            duration: number;
            groupKey?: string;
            max: number;
            workerDelay?: boolean;
        }

        Properties

        duration groupKey? max workerDelay? @@ -17,4 +17,4 @@ groupKeys unless you have a big amount of workers since you may be delaying workers that could pick jobs in groups that have not been rate limited.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.RawCommand.html b/interfaces/v2.RawCommand.html index b788b31ac5..3b054a0fc6 100644 --- a/interfaces/v2.RawCommand.html +++ b/interfaces/v2.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.6

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.12.7

        Interface RawCommand

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

        Properties

        content keys name -

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.RepeatBaseOptions.html b/interfaces/v2.RepeatBaseOptions.html index a0f83c3b63..5fbc74da16 100644 --- a/interfaces/v2.RepeatBaseOptions.html +++ b/interfaces/v2.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.6

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.7

        Interface RepeatBaseOptions

        Options for the Repeat class.

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

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -8,4 +8,4 @@

        Optional connection

        connection?: ConnectionOptions

        Options for connecting to a Redis instance.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional settings

        settings?: AdvancedRepeatOptions

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.RepeatOptions.html b/interfaces/v2.RepeatOptions.html index 801fc3ddd4..4ab3661625 100644 --- a/interfaces/v2.RepeatOptions.html +++ b/interfaces/v2.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.6

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.7

        Interface RepeatOptions

        Settings for repeatable jobs

        See

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

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

        Hierarchy

        • Omit<ParserOptions, "iterator">
          • RepeatOptions

        Properties

        count? cron? @@ -18,4 +18,4 @@ ( work only with every settings)

        Optional jobId

        jobId?: string

        Optional limit

        limit?: number

        Number of times the job should repeat at max.

        Optional offset

        offset?: number

        Optional pattern

        pattern?: string

        A repeat pattern

        -

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.SandboxedJob.html b/interfaces/v2.SandboxedJob.html index 44c6df2795..c0561d0266 100644 --- a/interfaces/v2.SandboxedJob.html +++ b/interfaces/v2.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.6

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.12.7

        Interface SandboxedJob<T, R>

        See

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

        interface SandboxedJob<T, R> {
            attemptsMade: number;
            data: T;
            failedReason: string;
            finishedOn?: number;
            id: string;
            log: ((row) => void);
            name: string;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            repeatJobKey?: string;
            returnValue: R;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
            update: ((data) => Promise<void>);
            updateProgress: ((value) => Promise<void>);
        }

        Type Parameters

        • T = any
        • R = any

        Hierarchy

        • Omit<JobJson, "data" | "opts" | "progress" | "returnValue">
          • SandboxedJob

        Properties

        attemptsMade data failedReason @@ -17,4 +17,4 @@ timestamp update updateProgress -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        update

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

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

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

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        update

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

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

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

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.ScriptMetadata.html b/interfaces/v2.ScriptMetadata.html index 485b1dffcd..9fca4db9cd 100644 --- a/interfaces/v2.ScriptMetadata.html +++ b/interfaces/v2.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.6

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.7

        Interface ScriptMetadata

        Script metadata

        interface ScriptMetadata {
            content: string;
            includes: ScriptMetadata[];
            name: string;
            numberOfKeys?: number;
            path: string;
            token: string;
        }

        Properties

        content includes name @@ -11,4 +11,4 @@

        Optional numberOfKeys

        numberOfKeys?: number

        path

        path: string

        The path to the script. For includes, this is the normalized path, whereas it may not be normalized for the top-level parent

        token

        token: string

        A hash of the normalized path for easy replacement in the parent

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.Strategies.html b/interfaces/v2.Strategies.html index 0cf6439761..bd9c42a495 100644 --- a/interfaces/v2.Strategies.html +++ b/interfaces/v2.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.12.6

        Interface Strategies

        interface Strategies {
            [index: string]: BackoffFunction;
        }

        Indexable

        [index: string]: BackoffFunction

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Strategies | bullmq - v5.12.7

        Interface Strategies

        interface Strategies {
            [index: string]: BackoffFunction;
        }

        Indexable

        [index: string]: BackoffFunction

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.WorkerListener.html b/interfaces/v2.WorkerListener.html index ad10de86b5..8bbd7a965d 100644 --- a/interfaces/v2.WorkerListener.html +++ b/interfaces/v2.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.6

        Interface WorkerListener<DataType, ResultType, NameType>

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

        Type Parameters

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

        Hierarchy (view full)

        Properties

        active +WorkerListener | bullmq - v5.12.7

        Interface WorkerListener<DataType, ResultType, NameType>

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

        Type Parameters

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

        Hierarchy (view full)

        Properties

        active closed closing completed @@ -40,4 +40,4 @@

        Returns void

        stalled

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

        Type declaration

          • (jobId, prev): void

          • Listen to 'stalled' event.

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

            -

            Parameters

            • jobId: string
            • prev: string

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • jobId: string
        • prev: string

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v2.WorkerOptions.html b/interfaces/v2.WorkerOptions.html index 481276e476..13151ee9fb 100644 --- a/interfaces/v2.WorkerOptions.html +++ b/interfaces/v2.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.6

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.7

        Interface WorkerOptions

        Base Queue options

        interface WorkerOptions {
            autorun?: boolean;
            blockingConnection?: boolean;
            concurrency?: number;
            connection?: ConnectionOptions;
            drainDelay?: number;
            limiter?: RateLimiterOptions;
            lockDuration?: number;
            lockRenewTime?: number;
            maxStalledCount?: number;
            metrics?: MetricsOptions;
            prefix?: string;
            runRetryDelay?: number;
            settings?: AdvancedOptions;
            sharedConnection?: boolean;
            skipDelayCheck?: boolean;
            stalledInterval?: number;
        }

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? concurrency? @@ -31,4 +31,4 @@

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional runRetryDelay

        runRetryDelay?: number

        Optional settings

        settings?: AdvancedOptions

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        Optional skipDelayCheck

        skipDelayCheck?: boolean

        Optional stalledInterval

        stalledInterval?: number

        Number of milliseconds between stallness checks.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.AddChildrenOpts.html b/interfaces/v3.AddChildrenOpts.html index e67204bd6f..6ee0058f83 100644 --- a/interfaces/v3.AddChildrenOpts.html +++ b/interfaces/v3.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.6

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.7

        Interface AddChildrenOpts

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

        Properties

        multi nodes parent queuesOpts? -

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

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

        Type declaration

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

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

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

        Type declaration

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

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.AddNodeOpts.html b/interfaces/v3.AddNodeOpts.html index cdbc76fbce..2b38155206 100644 --- a/interfaces/v3.AddNodeOpts.html +++ b/interfaces/v3.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.6

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.12.7

        Interface AddNodeOpts

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

        Properties

        multi node parent? queuesOpts?

        Properties

        multi

        multi: ChainableCommander

        node

        node: FlowJob

        Optional parent

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

        Type declaration

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

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

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

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.AdvancedOptions.html b/interfaces/v3.AdvancedOptions.html index 28746d291f..f371977ff8 100644 --- a/interfaces/v3.AdvancedOptions.html +++ b/interfaces/v3.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.6

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.7

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? repeatStrategy?

        Properties

        Optional backoffStrategy

        backoffStrategy?: BackoffStrategy

        A custom backoff strategy.

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.AdvancedRepeatOptions.html b/interfaces/v3.AdvancedRepeatOptions.html index 3236f054ba..dda54bd124 100644 --- a/interfaces/v3.AdvancedRepeatOptions.html +++ b/interfaces/v3.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.6

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.7

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy?

        Properties

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.BackoffOptions.html b/interfaces/v3.BackoffOptions.html index 86d04f0962..3b5e538986 100644 --- a/interfaces/v3.BackoffOptions.html +++ b/interfaces/v3.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.6

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.7

        Interface BackoffOptions

        Settings for backing off failed jobs.

        See

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

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

        Properties

        delay? type

        Properties

        Optional delay

        delay?: number

        Delay in milliseconds.

        type

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

        Name of the backoff strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.BaseJobOptions.html b/interfaces/v3.BaseJobOptions.html index d43fdd05f3..bf55d4f36f 100644 --- a/interfaces/v3.BaseJobOptions.html +++ b/interfaces/v3.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.6

        Interface BaseJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? +BaseJobOptions | bullmq - v5.12.7

        Interface BaseJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? jobId? @@ -51,4 +51,4 @@

        Optional stackTraceLimit

        stackTraceLimit?: number

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

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.BaseOptions.html b/interfaces/v3.BaseOptions.html index 3ea97dadae..e862206469 100644 --- a/interfaces/v3.BaseOptions.html +++ b/interfaces/v3.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.6

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? -

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

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

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? +

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.BuiltInStrategies.html b/interfaces/v3.BuiltInStrategies.html index 4ba87bae7c..46e9192c31 100644 --- a/interfaces/v3.BuiltInStrategies.html +++ b/interfaces/v3.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.6

        Interface BuiltInStrategies

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

        Indexable

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

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

        Interface BuiltInStrategies

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

        Indexable

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

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.ChildMessage.html b/interfaces/v3.ChildMessage.html index 8acc0b7b5f..001960db1d 100644 --- a/interfaces/v3.ChildMessage.html +++ b/interfaces/v3.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.6

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.12.7

        Interface ChildMessage

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

        Properties

        cmd err? value? -

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.Command.html b/interfaces/v3.Command.html index c5b8c64741..ba1e953eb9 100644 --- a/interfaces/v3.Command.html +++ b/interfaces/v3.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.6

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.7

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name options -

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.DefaultJobOptions.html b/interfaces/v3.DefaultJobOptions.html index 9686170a71..c152981899 100644 --- a/interfaces/v3.DefaultJobOptions.html +++ b/interfaces/v3.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.6

        Interface DefaultJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? +DefaultJobOptions | bullmq - v5.12.7

        Interface DefaultJobOptions

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

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? keepLogs? @@ -36,4 +36,4 @@

        Optional stackTraceLimit

        stackTraceLimit?: number

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

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.DependenciesOpts.html b/interfaces/v3.DependenciesOpts.html index 3470b6fb19..ac4e49ecd9 100644 --- a/interfaces/v3.DependenciesOpts.html +++ b/interfaces/v3.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.6

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.7

        Interface DependenciesOpts

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

        Properties

        processed? unprocessed? -

        Properties

        Optional processed

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

        Type declaration

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

        Optional unprocessed

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional processed

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

        Type declaration

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

        Optional unprocessed

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.FlowJobBase.html b/interfaces/v3.FlowJobBase.html index a1d1c451b9..44a1d00897 100644 --- a/interfaces/v3.FlowJobBase.html +++ b/interfaces/v3.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.6

        Interface FlowJobBase<T>

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

        Type Parameters

        • T

        Properties

        children? +FlowJobBase | bullmq - v5.12.7

        Interface FlowJobBase<T>

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

        Type Parameters

        • T

        Properties

        children? data? name opts? prefix? queueName -

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.FlowOpts.html b/interfaces/v3.FlowOpts.html index 746658b781..0562aac1c1 100644 --- a/interfaces/v3.FlowOpts.html +++ b/interfaces/v3.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.6

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.7

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions

        Properties

        queuesOptions

        queuesOptions: FlowQueuesOpts

        Map of options for Queue classes.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.FlowProducerListener.html b/interfaces/v3.FlowProducerListener.html index 6e9efccef1..a55ea6550c 100644 --- a/interfaces/v3.FlowProducerListener.html +++ b/interfaces/v3.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.6

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.7

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error ioredis:close

        Properties

        error

        error: ((failedReason) => void)

        Type declaration

          • (failedReason): void

          • Listen to 'error' event.

            This event is triggered when an error is throw.

            Parameters

            • failedReason: Error

            Returns void

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.GetNextJobOptions.html b/interfaces/v3.GetNextJobOptions.html index a16695aaec..68ebe172bd 100644 --- a/interfaces/v3.GetNextJobOptions.html +++ b/interfaces/v3.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.6

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? -

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

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

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? +

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.IConnection.html b/interfaces/v3.IConnection.html index cf822cc5c2..258a835fb2 100644 --- a/interfaces/v3.IConnection.html +++ b/interfaces/v3.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.6

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.7

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client

        Methods

        waitUntilReady -

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.IoredisListener.html b/interfaces/v3.IoredisListener.html index 02a9c1f13d..22be1e75f1 100644 --- a/interfaces/v3.IoredisListener.html +++ b/interfaces/v3.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.6

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.7

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close

        Properties

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.JobJson.html b/interfaces/v3.JobJson.html index e1ff4ad159..ca41de7db3 100644 --- a/interfaces/v3.JobJson.html +++ b/interfaces/v3.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.6

        Interface JobJson

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

        Properties

        attemptsMade +JobJson | bullmq - v5.12.7

        Interface JobJson

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

        Properties

        attemptsMade data failedReason finishedOn? @@ -13,4 +13,4 @@ returnvalue stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.JobJsonRaw.html b/interfaces/v3.JobJsonRaw.html index b532ce0f11..6e6b30927a 100644 --- a/interfaces/v3.JobJsonRaw.html +++ b/interfaces/v3.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.6

        Interface JobJsonRaw

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

        Properties

        attemptsMade +JobJsonRaw | bullmq - v5.12.7

        Interface JobJsonRaw

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

        Properties

        attemptsMade data delay failedReason @@ -14,4 +14,4 @@ rjk? stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.JobNode.html b/interfaces/v3.JobNode.html index 84623c0686..248a5a4c8b 100644 --- a/interfaces/v3.JobNode.html +++ b/interfaces/v3.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.6

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.7

        Interface JobNode

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

        Properties

        children? job -

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.KeepJobs.html b/interfaces/v3.KeepJobs.html index de37e64461..e6f3e6e078 100644 --- a/interfaces/v3.KeepJobs.html +++ b/interfaces/v3.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.6

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.7

        Interface KeepJobs

        KeepJobs

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

        @@ -6,4 +6,4 @@ count?

        Properties

        Optional age

        age?: number

        Maximum age in seconds for job to be kept.

        Optional count

        count?: number

        Maximum count of jobs to be kept.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.Metrics.html b/interfaces/v3.Metrics.html index 9a945e8f1c..c5c9c39d2b 100644 --- a/interfaces/v3.Metrics.html +++ b/interfaces/v3.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.6

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.7

        Interface Metrics

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

        Properties

        count data meta -

        Properties

        count

        count: number

        data

        data: number[]

        meta

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        count

        count: number

        data

        data: number[]

        meta

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

        Type declaration

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

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.MetricsOptions.html b/interfaces/v3.MetricsOptions.html index 34d6cd85e3..a493507a5d 100644 --- a/interfaces/v3.MetricsOptions.html +++ b/interfaces/v3.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.6

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.7

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints?

        Properties

        Optional maxDataPoints

        maxDataPoints?: number

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

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.MinimalJob.html b/interfaces/v3.MinimalJob.html index ae83ae8193..88c2309968 100644 --- a/interfaces/v3.MinimalJob.html +++ b/interfaces/v3.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.12.6

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.12.7

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

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

        Type Parameters

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

        Implemented by

        Properties

        attemptsMade data delay @@ -54,4 +54,4 @@

        Parameters

        • data: DataType

          the data that will replace the current jobs data.

        Returns Promise<void>

        updateProgress

        • updateProgress(progress): Promise<void>

        • Updates a job's progress

          Parameters

          • progress: number | object

            number or object to be saved as progress.

            -

          Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.MoveToWaitingChildrenOpts.html b/interfaces/v3.MoveToWaitingChildrenOpts.html index c8c41c2560..f6fda569ad 100644 --- a/interfaces/v3.MoveToWaitingChildrenOpts.html +++ b/interfaces/v3.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.6

        Interface MoveToWaitingChildrenOpts

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

        Properties

        child? -

        Properties

        Optional child

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

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

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

        Interface MoveToWaitingChildrenOpts

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

        Properties

        child? +

        Properties

        Optional child

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

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.NodeOpts.html b/interfaces/v3.NodeOpts.html index 953f7d1e4d..2e6160cd02 100644 --- a/interfaces/v3.NodeOpts.html +++ b/interfaces/v3.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.6

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.7

        Interface NodeOpts

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

        Properties

        depth? id maxChildren? prefix? @@ -8,4 +8,4 @@

        Optional maxChildren

        maxChildren?: number

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

        Optional prefix

        prefix?: string

        Prefix included in job key.

        queueName

        queueName: string

        Root job queue name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.ObliterateOpts.html b/interfaces/v3.ObliterateOpts.html index c3158b1960..f68eb5640f 100644 --- a/interfaces/v3.ObliterateOpts.html +++ b/interfaces/v3.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.6

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.7

        Interface ObliterateOpts

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

        Properties

        count? force?

        Properties

        Optional count

        count?: number

        Use count with the maximum number of deleted keys per iteration

        Default Value

        1000

        Optional force

        force?: boolean

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

        Default Value

        false

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.Parent.html b/interfaces/v3.Parent.html index 0f5a6483f4..410cafa8e5 100644 --- a/interfaces/v3.Parent.html +++ b/interfaces/v3.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.6

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.7

        Interface Parent<T>

        Describes the parent for a Job.

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

        Type Parameters

        • T

        Properties

        data? name opts? prefix? queue? -

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.ParentKeys.html b/interfaces/v3.ParentKeys.html index d8f5aba1fd..b5c616087e 100644 --- a/interfaces/v3.ParentKeys.html +++ b/interfaces/v3.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.6

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.7

        Interface ParentKeys

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

        Properties

        id queueKey -

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.ParentMessage.html b/interfaces/v3.ParentMessage.html index f251f28b85..8cc4668649 100644 --- a/interfaces/v3.ParentMessage.html +++ b/interfaces/v3.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.6

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.7

        Interface ParentMessage

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

        Properties

        cmd err? job? value? -

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.QueueBaseOptions.html b/interfaces/v3.QueueBaseOptions.html index a3c5bfb309..89ed467708 100644 --- a/interfaces/v3.QueueBaseOptions.html +++ b/interfaces/v3.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.6

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.7

        Interface QueueBaseOptions

        Base Queue options

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

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -7,4 +7,4 @@

        Optional connection

        connection?: ConnectionOptions

        Options for connecting to a Redis instance.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.QueueEventsListener.html b/interfaces/v3.QueueEventsListener.html index 0cdee275dd..9eb0ad2739 100644 --- a/interfaces/v3.QueueEventsListener.html +++ b/interfaces/v3.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.6

        Interface QueueEventsListener

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

        Hierarchy (view full)

        Properties

        active +QueueEventsListener | bullmq - v5.12.7

        Interface QueueEventsListener

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

        Hierarchy (view full)

        Properties

        active added cleaned completed @@ -60,4 +60,4 @@

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

        Parameters

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

        Returns void

        waiting-children

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

        Type declaration

          • (args, id): void

          • Listen to 'waiting-children' event.

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

            -

            Parameters

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

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

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

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.QueueEventsOptions.html b/interfaces/v3.QueueEventsOptions.html index 7d1673e4a7..17f603e73e 100644 --- a/interfaces/v3.QueueEventsOptions.html +++ b/interfaces/v3.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.6

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.7

        Interface QueueEventsOptions

        Options for QueueEvents

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

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? blockingTimeout? @@ -15,4 +15,4 @@ produced event.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.QueueListener.html b/interfaces/v3.QueueListener.html index 8103bdb89f..4b41b7f200 100644 --- a/interfaces/v3.QueueListener.html +++ b/interfaces/v3.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.6

        Interface QueueListener<DataType, ResultType, NameType>

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

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned +QueueListener | bullmq - v5.12.7

        Interface QueueListener<DataType, ResultType, NameType>

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

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned error ioredis:close paused @@ -22,4 +22,4 @@

        This event is triggered when the queue is resumed.

        Returns void

        waiting

        waiting: ((job) => void)

        Type declaration

          • (job): void

          • Listen to 'waiting' event.

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

            -

            Parameters

            • job: Job<DataType, ResultType, NameType>

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • job: Job<DataType, ResultType, NameType>

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.QueueOptions.html b/interfaces/v3.QueueOptions.html index e17860c7c1..439205fbc7 100644 --- a/interfaces/v3.QueueOptions.html +++ b/interfaces/v3.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.6

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.7

        Interface QueueOptions

        Options for the Queue class.

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

        Hierarchy (view full)

        Properties

        blockingConnection? connection? defaultJobOptions? @@ -13,4 +13,4 @@

        Optional streams

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

        Options for the streams used internally in BullMQ.

        Type declaration

        • events: {
              maxLen: number;
          }

          Options for the events stream.

          • maxLen: number

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

            -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.RateLimiterOptions.html b/interfaces/v3.RateLimiterOptions.html index ac7fa4e850..f3b0793bfd 100644 --- a/interfaces/v3.RateLimiterOptions.html +++ b/interfaces/v3.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.6

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.7

        Interface RateLimiterOptions

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

        Properties

        duration max

        Properties

        duration

        duration: number

        Time in milliseconds. During this time, a maximum of max jobs will be processed.

        max

        max: number

        Max number of jobs to process in the time period specified in duration.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.RawCommand.html b/interfaces/v3.RawCommand.html index fafd4a19ed..dc2d9bc1bb 100644 --- a/interfaces/v3.RawCommand.html +++ b/interfaces/v3.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.6

        Interface RawCommand

        interface RawCommand {
            content: string;
            keys: number;
            name: string;
        }

        Properties

        content +RawCommand | bullmq - v5.12.7

        Interface RawCommand

        interface RawCommand {
            content: string;
            keys: number;
            name: string;
        }

        Properties

        content keys name -

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.RepeatBaseOptions.html b/interfaces/v3.RepeatBaseOptions.html index 68a1c00c62..0afb24cffa 100644 --- a/interfaces/v3.RepeatBaseOptions.html +++ b/interfaces/v3.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.6

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.7

        Interface RepeatBaseOptions

        Options for the Repeat class.

        interface RepeatBaseOptions {
            blockingConnection?: boolean;
            connection?: ConnectionOptions;
            prefix?: string;
            settings?: AdvancedRepeatOptions;
            sharedConnection?: boolean;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -8,4 +8,4 @@

        Optional connection

        connection?: ConnectionOptions

        Options for connecting to a Redis instance.

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        Optional settings

        settings?: AdvancedRepeatOptions

        Optional sharedConnection

        sharedConnection?: boolean

        Specify if the connection is shared.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.RepeatOptions.html b/interfaces/v3.RepeatOptions.html index 822fe7ca8c..507c200e1a 100644 --- a/interfaces/v3.RepeatOptions.html +++ b/interfaces/v3.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.6

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.7

        Interface RepeatOptions

        Settings for repeatable jobs

        See

        https://docs.bullmq.io/guide/jobs/repeatable

        interface RepeatOptions {
            count?: number;
            every?: number;
            immediately?: boolean;
            jobId?: string;
            limit?: number;
            offset?: number;
            pattern?: string;
            prevMillis?: number;
        }

        Hierarchy

        • Omit<ParserOptions, "iterator">
          • RepeatOptions

        Properties

        count? every? @@ -15,4 +15,4 @@ ( work only with every settings)

        Optional jobId

        jobId?: string

        Optional limit

        limit?: number

        Number of times the job should repeat at max.

        Optional offset

        offset?: number

        Optional pattern

        pattern?: string

        A repeat pattern

        -

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.SandboxedJob.html b/interfaces/v3.SandboxedJob.html index aeba95951d..fe65facd51 100644 --- a/interfaces/v3.SandboxedJob.html +++ b/interfaces/v3.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.6

        Interface SandboxedJob<T, R>

        See

        https://docs.bullmq.io/guide/workers/sandboxed-processors

        +SandboxedJob | bullmq - v5.12.7

        Interface SandboxedJob<T, R>

        See

        https://docs.bullmq.io/guide/workers/sandboxed-processors

        interface SandboxedJob<T, R> {
            attemptsMade: number;
            data: T;
            failedReason: string;
            finishedOn?: number;
            id: string;
            log: ((row) => void);
            name: string;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            repeatJobKey?: string;
            returnValue: R;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
            update: ((data) => Promise<void>);
            updateProgress: ((value) => Promise<void>);
        }

        Type Parameters

        • T = any
        • R = any

        Hierarchy

        • Omit<JobJson, "data" | "opts" | "progress" | "returnValue">
          • SandboxedJob

        Properties

        attemptsMade data failedReason @@ -17,4 +17,4 @@ timestamp update updateProgress -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        update

        update: ((data) => Promise<void>)

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

        updateProgress: ((value) => Promise<void>)

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        update

        update: ((data) => Promise<void>)

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

        updateProgress: ((value) => Promise<void>)

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.ScriptMetadata.html b/interfaces/v3.ScriptMetadata.html index cba344302c..20cefd5d51 100644 --- a/interfaces/v3.ScriptMetadata.html +++ b/interfaces/v3.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.6

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.7

        Interface ScriptMetadata

        Script metadata

        interface ScriptMetadata {
            content: string;
            includes: ScriptMetadata[];
            name: string;
            numberOfKeys?: number;
            path: string;
            token: string;
        }

        Properties

        content includes name @@ -11,4 +11,4 @@

        Optional numberOfKeys

        numberOfKeys?: number

        path

        path: string

        The path to the script. For includes, this is the normalized path, whereas it may not be normalized for the top-level parent

        token

        token: string

        A hash of the normalized path for easy replacement in the parent

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.WorkerListener.html b/interfaces/v3.WorkerListener.html index 626d696518..196bed1972 100644 --- a/interfaces/v3.WorkerListener.html +++ b/interfaces/v3.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.6

        Interface WorkerListener<DataType, ResultType, NameType>

        interface WorkerListener<DataType, ResultType, NameType> {
            active: ((job, prev) => void);
            closed: (() => void);
            closing: ((msg) => void);
            completed: ((job, result, prev) => void);
            drained: (() => void);
            error: ((failedReason) => void);
            failed: ((job, error, prev) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            ready: (() => void);
            resumed: (() => void);
            stalled: ((jobId, prev) => void);
        }

        Type Parameters

        • DataType = any
        • ResultType = any
        • NameType extends string = string

        Hierarchy (view full)

        Properties

        active +WorkerListener | bullmq - v5.12.7

        Interface WorkerListener<DataType, ResultType, NameType>

        interface WorkerListener<DataType, ResultType, NameType> {
            active: ((job, prev) => void);
            closed: (() => void);
            closing: ((msg) => void);
            completed: ((job, result, prev) => void);
            drained: (() => void);
            error: ((failedReason) => void);
            failed: ((job, error, prev) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            ready: (() => void);
            resumed: (() => void);
            stalled: ((jobId, prev) => void);
        }

        Type Parameters

        • DataType = any
        • ResultType = any
        • NameType extends string = string

        Hierarchy (view full)

        Properties

        active closed closing completed @@ -45,4 +45,4 @@

        Returns void

        stalled

        stalled: ((jobId, prev) => void)

        Type declaration

          • (jobId, prev): void

          • Listen to 'stalled' event.

            This event is triggered when a job has stalled and has been moved back to the wait list.

            -

            Parameters

            • jobId: string
            • prev: string

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • jobId: string
        • prev: string

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v3.WorkerOptions.html b/interfaces/v3.WorkerOptions.html index ccadf63807..7c21605903 100644 --- a/interfaces/v3.WorkerOptions.html +++ b/interfaces/v3.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.6

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.7

        Interface WorkerOptions

        Base Queue options

        interface WorkerOptions {
            autorun?: boolean;
            blockingConnection?: boolean;
            concurrency?: number;
            connection?: ConnectionOptions;
            drainDelay?: number;
            limiter?: RateLimiterOptions;
            lockDuration?: number;
            lockRenewTime?: number;
            maxStalledCount?: number;
            metrics?: MetricsOptions;
            prefix?: string;
            removeOnComplete?: KeepJobs;
            removeOnFail?: KeepJobs;
            runRetryDelay?: number;
            settings?: AdvancedOptions;
            sharedConnection?: boolean;
            skipLockRenewal?: boolean;
            skipStalledCheck?: boolean;
            stalledInterval?: number;
            useWorkerThreads?: boolean;
        }

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? concurrency? @@ -80,4 +80,4 @@

        See

        https: a file for the processor argument.

        Default

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.AddChildrenOpts.html b/interfaces/v4.AddChildrenOpts.html index f74a67da18..60402d049e 100644 --- a/interfaces/v4.AddChildrenOpts.html +++ b/interfaces/v4.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.6

        Interface AddChildrenOpts

        interface AddChildrenOpts {
            multi: ChainableCommander;
            nodes: FlowJob[];
            parent: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.7

        Interface AddChildrenOpts

        interface AddChildrenOpts {
            multi: ChainableCommander;
            nodes: FlowJob[];
            parent: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi nodes parent queuesOpts? -

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.AddNodeOpts.html b/interfaces/v4.AddNodeOpts.html index 3581b1a237..7ea6b3caf2 100644 --- a/interfaces/v4.AddNodeOpts.html +++ b/interfaces/v4.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.6

        Interface AddNodeOpts

        interface AddNodeOpts {
            multi: ChainableCommander;
            node: FlowJob;
            parent?: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi +AddNodeOpts | bullmq - v5.12.7

        Interface AddNodeOpts

        interface AddNodeOpts {
            multi: ChainableCommander;
            node: FlowJob;
            parent?: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi node parent? queuesOpts?

        Properties

        multi

        multi: ChainableCommander

        node

        node: FlowJob

        Optional parent

        parent?: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Queues options that will be applied in each node depending on queue name presence.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.AdvancedOptions.html b/interfaces/v4.AdvancedOptions.html index 32af355789..238cfabd8e 100644 --- a/interfaces/v4.AdvancedOptions.html +++ b/interfaces/v4.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.12.6

        Interface AdvancedOptions

        interface AdvancedOptions {
            backoffStrategy?: BackoffStrategy;
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.7

        Interface AdvancedOptions

        interface AdvancedOptions {
            backoffStrategy?: BackoffStrategy;
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        backoffStrategy? repeatKeyHashAlgorithm? repeatStrategy?

        Properties

        Optional backoffStrategy

        backoffStrategy?: BackoffStrategy

        A custom backoff strategy.

        Optional repeatKeyHashAlgorithm

        repeatKeyHashAlgorithm?: string

        A hash algorithm to be used when trying to create the job redis key. Default - md5

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.AdvancedRepeatOptions.html b/interfaces/v4.AdvancedRepeatOptions.html index e8390a6780..651153d47e 100644 --- a/interfaces/v4.AdvancedRepeatOptions.html +++ b/interfaces/v4.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.12.6

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.12.7

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? repeatStrategy?

        Properties

        Optional repeatKeyHashAlgorithm

        repeatKeyHashAlgorithm?: string

        A hash algorithm to be used when trying to create the job redis key. Default - md5

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.BackoffOptions.html b/interfaces/v4.BackoffOptions.html index 80b4b154bf..ed4f12bd4c 100644 --- a/interfaces/v4.BackoffOptions.html +++ b/interfaces/v4.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.6

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.7

        Interface BackoffOptions

        Settings for backing off failed jobs.

        See

        https://docs.bullmq.io/guide/retrying-failing-jobs

        interface BackoffOptions {
            delay?: number;
            type: "fixed" | "exponential" | string & {};
        }

        Properties

        delay? type

        Properties

        Optional delay

        delay?: number

        Delay in milliseconds.

        type

        type: "fixed" | "exponential" | string & {}

        Name of the backoff strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.BaseJobOptions.html b/interfaces/v4.BaseJobOptions.html index 9748a0343e..4bdf2d29da 100644 --- a/interfaces/v4.BaseJobOptions.html +++ b/interfaces/v4.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.6

        Interface BaseJobOptions

        interface BaseJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            jobId?: string;
            keepLogs?: number;
            lifo?: boolean;
            parent?: {
                id: string;
                queue: string;
            };
            prevMillis?: number;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            repeat?: RepeatOptions;
            repeatJobKey?: string;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? +BaseJobOptions | bullmq - v5.12.7

        Interface BaseJobOptions

        interface BaseJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            jobId?: string;
            keepLogs?: number;
            lifo?: boolean;
            parent?: {
                id: string;
                queue: string;
            };
            prevMillis?: number;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            repeat?: RepeatOptions;
            repeatJobKey?: string;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? jobId? @@ -54,4 +54,4 @@

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.BaseOptions.html b/interfaces/v4.BaseOptions.html index 948882f785..1e10aeba1d 100644 --- a/interfaces/v4.BaseOptions.html +++ b/interfaces/v4.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.6

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? -

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +BaseOptions | bullmq - v5.12.7

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? +

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.BuiltInStrategies.html b/interfaces/v4.BuiltInStrategies.html index c2729d08ce..7c8c2bfd9a 100644 --- a/interfaces/v4.BuiltInStrategies.html +++ b/interfaces/v4.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.6

        Interface BuiltInStrategies

        interface BuiltInStrategies {
            [index: string]: ((delay) => BackoffStrategy);
        }

        Indexable

        [index: string]: ((delay) => BackoffStrategy)

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +BuiltInStrategies | bullmq - v5.12.7

        Interface BuiltInStrategies

        interface BuiltInStrategies {
            [index: string]: ((delay) => BackoffStrategy);
        }

        Indexable

        [index: string]: ((delay) => BackoffStrategy)

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.ChildMessage.html b/interfaces/v4.ChildMessage.html index e7bd29902e..11166bd8bb 100644 --- a/interfaces/v4.ChildMessage.html +++ b/interfaces/v4.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.6

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Record<string, any>;
            value?: any;
        }

        Properties

        cmd +ChildMessage | bullmq - v5.12.7

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Record<string, any>;
            value?: any;
        }

        Properties

        cmd err? value? -

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.Command.html b/interfaces/v4.Command.html index 6cdec7cc01..663d5b0e5d 100644 --- a/interfaces/v4.Command.html +++ b/interfaces/v4.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.6

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.7

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name options -

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        name

        name: string

        options

        options: {
            lua: string;
            numberOfKeys: number;
        }

        Type declaration

        • lua: string
        • numberOfKeys: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.DefaultJobOptions.html b/interfaces/v4.DefaultJobOptions.html index 4928af7178..bbacf4ac37 100644 --- a/interfaces/v4.DefaultJobOptions.html +++ b/interfaces/v4.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.6

        Interface DefaultJobOptions

        interface DefaultJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            keepLogs?: number;
            lifo?: boolean;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? +DefaultJobOptions | bullmq - v5.12.7

        Interface DefaultJobOptions

        interface DefaultJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            keepLogs?: number;
            lifo?: boolean;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? keepLogs? @@ -39,4 +39,4 @@

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.DependenciesOpts.html b/interfaces/v4.DependenciesOpts.html index 64536c5cc0..9278f3bb57 100644 --- a/interfaces/v4.DependenciesOpts.html +++ b/interfaces/v4.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.6

        Interface DependenciesOpts

        interface DependenciesOpts {
            processed?: {
                count?: number;
                cursor?: number;
            };
            unprocessed?: {
                count?: number;
                cursor?: number;
            };
        }

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.7

        Interface DependenciesOpts

        interface DependenciesOpts {
            processed?: {
                count?: number;
                cursor?: number;
            };
            unprocessed?: {
                count?: number;
                cursor?: number;
            };
        }

        Properties

        processed? unprocessed? -

        Properties

        Optional processed

        processed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Optional unprocessed

        unprocessed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional processed

        processed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Optional unprocessed

        unprocessed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.FlowJobBase.html b/interfaces/v4.FlowJobBase.html index 5bd4b57f24..e3ab3ccf14 100644 --- a/interfaces/v4.FlowJobBase.html +++ b/interfaces/v4.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.6

        Interface FlowJobBase<T>

        interface FlowJobBase<T> {
            children?: FlowChildJob[];
            data?: any;
            name: string;
            opts?: Omit<T, "repeat">;
            prefix?: string;
            queueName: string;
        }

        Type Parameters

        • T

        Properties

        children? +FlowJobBase | bullmq - v5.12.7

        Interface FlowJobBase<T>

        interface FlowJobBase<T> {
            children?: FlowChildJob[];
            data?: any;
            name: string;
            opts?: Omit<T, "repeat">;
            prefix?: string;
            queueName: string;
        }

        Type Parameters

        • T

        Properties

        children? data? name opts? prefix? queueName -

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.FlowOpts.html b/interfaces/v4.FlowOpts.html index 927ba42109..9c89c4d316 100644 --- a/interfaces/v4.FlowOpts.html +++ b/interfaces/v4.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.6

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.7

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions

        Properties

        queuesOptions

        queuesOptions: FlowQueuesOpts

        Map of options for Queue classes.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.FlowProducerListener.html b/interfaces/v4.FlowProducerListener.html index a0bdbb602e..565adc1405 100644 --- a/interfaces/v4.FlowProducerListener.html +++ b/interfaces/v4.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.6

        Interface FlowProducerListener

        interface FlowProducerListener {
            error: ((failedReason) => void);
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.7

        Interface FlowProducerListener

        interface FlowProducerListener {
            error: ((failedReason) => void);
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        error ioredis:close

        Properties

        error

        error: ((failedReason) => void)

        Type declaration

          • (failedReason): void

          • Listen to 'error' event.

            This event is triggered when an error is throw.

            Parameters

            • failedReason: Error

            Returns void

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.GetNextJobOptions.html b/interfaces/v4.GetNextJobOptions.html index c81e177990..e16ff80463 100644 --- a/interfaces/v4.GetNextJobOptions.html +++ b/interfaces/v4.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.6

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? -

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +GetNextJobOptions | bullmq - v5.12.7

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? +

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.IConnection.html b/interfaces/v4.IConnection.html index b748608080..27c1dda0c9 100644 --- a/interfaces/v4.IConnection.html +++ b/interfaces/v4.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.6

        Interface IConnection

        interface IConnection {
            client: Promise<RedisClient>;
            waitUntilReady(): Promise<boolean>;
        }

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.7

        Interface IConnection

        interface IConnection {
            client: Promise<RedisClient>;
            waitUntilReady(): Promise<boolean>;
        }

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client

        Methods

        waitUntilReady -

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.IoredisListener.html b/interfaces/v4.IoredisListener.html index 0e5b6acc96..728cdddadb 100644 --- a/interfaces/v4.IoredisListener.html +++ b/interfaces/v4.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.6

        Interface IoredisListener

        interface IoredisListener {
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.7

        Interface IoredisListener

        interface IoredisListener {
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        ioredis:close

        Properties

        ioredis:close

        ioredis:close: (() => void)

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.JobJson.html b/interfaces/v4.JobJson.html index b7cb55c75d..8009b2efc2 100644 --- a/interfaces/v4.JobJson.html +++ b/interfaces/v4.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.6

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            data: string;
            failedReason: string;
            finishedOn?: number;
            id: string;
            name: string;
            opts: RedisJobOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
        }

        Properties

        attemptsMade +JobJson | bullmq - v5.12.7

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            data: string;
            failedReason: string;
            finishedOn?: number;
            id: string;
            name: string;
            opts: RedisJobOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
        }

        Properties

        attemptsMade data failedReason finishedOn? @@ -13,4 +13,4 @@ returnvalue stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.JobJsonRaw.html b/interfaces/v4.JobJsonRaw.html index ca6cd2ba5f..c0dc3a3c27 100644 --- a/interfaces/v4.JobJsonRaw.html +++ b/interfaces/v4.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.6

        Interface JobJsonRaw

        interface JobJsonRaw {
            attemptsMade: string;
            data: string;
            delay: string;
            failedReason: string;
            finishedOn?: string;
            id: string;
            name: string;
            opts: string;
            parent?: string;
            parentKey?: string;
            processedOn?: string;
            progress: string;
            returnvalue: string;
            rjk?: string;
            stacktrace: string[];
            timestamp: string;
        }

        Properties

        attemptsMade +JobJsonRaw | bullmq - v5.12.7

        Interface JobJsonRaw

        interface JobJsonRaw {
            attemptsMade: string;
            data: string;
            delay: string;
            failedReason: string;
            finishedOn?: string;
            id: string;
            name: string;
            opts: string;
            parent?: string;
            parentKey?: string;
            processedOn?: string;
            progress: string;
            returnvalue: string;
            rjk?: string;
            stacktrace: string[];
            timestamp: string;
        }

        Properties

        attemptsMade data delay failedReason @@ -14,4 +14,4 @@ rjk? stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: string

        data

        data: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.JobNode.html b/interfaces/v4.JobNode.html index 9bcb663f08..232a7ac1cf 100644 --- a/interfaces/v4.JobNode.html +++ b/interfaces/v4.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.6

        Interface JobNode

        interface JobNode {
            children?: JobNode[];
            job: Job<any, any, string>;
        }

        Properties

        children? +JobNode | bullmq - v5.12.7

        Interface JobNode

        interface JobNode {
            children?: JobNode[];
            job: Job<any, any, string>;
        }

        Properties

        children? job -

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.KeepJobs.html b/interfaces/v4.KeepJobs.html index b78f525925..5ee323b5a9 100644 --- a/interfaces/v4.KeepJobs.html +++ b/interfaces/v4.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.6

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.7

        Interface KeepJobs

        KeepJobs

        Specify which jobs to keep after finishing. If both age and count are specified, then the jobs kept will be the ones that satisfies both properties.

        @@ -6,4 +6,4 @@ count?

        Properties

        Optional age

        age?: number

        Maximum age in seconds for job to be kept.

        Optional count

        count?: number

        Maximum count of jobs to be kept.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.Metrics.html b/interfaces/v4.Metrics.html index 309ece9082..dc28f338e9 100644 --- a/interfaces/v4.Metrics.html +++ b/interfaces/v4.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.6

        Interface Metrics

        interface Metrics {
            count: number;
            data: number[];
            meta: {
                count: number;
                prevCount: number;
                prevTS: number;
            };
        }

        Properties

        count +Metrics | bullmq - v5.12.7

        Interface Metrics

        interface Metrics {
            count: number;
            data: number[];
            meta: {
                count: number;
                prevCount: number;
                prevTS: number;
            };
        }

        Properties

        count data meta -

        Properties

        count

        count: number

        data

        data: number[]

        meta

        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        }

        Type declaration

        • count: number
        • prevCount: number
        • prevTS: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        count

        count: number

        data

        data: number[]

        meta

        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        }

        Type declaration

        • count: number
        • prevCount: number
        • prevTS: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.MetricsOptions.html b/interfaces/v4.MetricsOptions.html index 647ebaed98..7398ff6240 100644 --- a/interfaces/v4.MetricsOptions.html +++ b/interfaces/v4.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.6

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.7

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints?

        Properties

        Optional maxDataPoints

        maxDataPoints?: number

        Enable gathering metrics for finished jobs. Output refers to all finished jobs, completed or failed.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.MinimalJob.html b/interfaces/v4.MinimalJob.html index 9e59b362ad..d4918d2c21 100644 --- a/interfaces/v4.MinimalJob.html +++ b/interfaces/v4.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.12.6

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.12.7

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        interface MinimalJob<DataType, ReturnType, NameType> {
            attemptsMade: number;
            data: DataType;
            delay: number;
            failedReason: string;
            finishedOn?: number;
            id?: string;
            name: NameType;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: ReturnType;
            stacktrace: string[];
            timestamp: number;
            get prefix(): string;
            get queueName(): string;
            get queueQualifiedName(): string;
            asJSON(): JobJson;
            asJSONSandbox(): JobJsonSandbox;
            log(logRow): Promise<number>;
            updateData(data): Promise<void>;
            updateProgress(progress): Promise<void>;
        }

        Type Parameters

        • DataType = any
        • ReturnType = any
        • NameType extends string = string

        Implemented by

        Properties

        attemptsMade data delay @@ -59,4 +59,4 @@

        Parameters

        • data: DataType

          the data that will replace the current jobs data.

        Returns Promise<void>

        updateProgress

        • updateProgress(progress): Promise<void>

        • Updates a job's progress

          Parameters

          • progress: number | object

            number or object to be saved as progress.

            -

          Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.MoveToWaitingChildrenOpts.html b/interfaces/v4.MoveToWaitingChildrenOpts.html index 8a22897a2c..09691b8947 100644 --- a/interfaces/v4.MoveToWaitingChildrenOpts.html +++ b/interfaces/v4.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.6

        Interface MoveToWaitingChildrenOpts

        interface MoveToWaitingChildrenOpts {
            child?: {
                id: string;
                queue: string;
            };
        }

        Properties

        child? -

        Properties

        Optional child

        child?: {
            id: string;
            queue: string;
        }

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +MoveToWaitingChildrenOpts | bullmq - v5.12.7

        Interface MoveToWaitingChildrenOpts

        interface MoveToWaitingChildrenOpts {
            child?: {
                id: string;
                queue: string;
            };
        }

        Properties

        child? +

        Properties

        Optional child

        child?: {
            id: string;
            queue: string;
        }

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.NodeOpts.html b/interfaces/v4.NodeOpts.html index 437557b277..2310652c58 100644 --- a/interfaces/v4.NodeOpts.html +++ b/interfaces/v4.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.6

        Interface NodeOpts

        interface NodeOpts {
            depth?: number;
            id: string;
            maxChildren?: number;
            prefix?: string;
            queueName: string;
        }

        Properties

        depth? +NodeOpts | bullmq - v5.12.7

        Interface NodeOpts

        interface NodeOpts {
            depth?: number;
            id: string;
            maxChildren?: number;
            prefix?: string;
            queueName: string;
        }

        Properties

        depth? id maxChildren? prefix? @@ -8,4 +8,4 @@

        Optional maxChildren

        maxChildren?: number

        Maximum quantity of children per type (processed, unprocessed).

        Optional prefix

        prefix?: string

        Prefix included in job key.

        queueName

        queueName: string

        Root job queue name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.ObliterateOpts.html b/interfaces/v4.ObliterateOpts.html index 45618761f5..7e0b7787a0 100644 --- a/interfaces/v4.ObliterateOpts.html +++ b/interfaces/v4.ObliterateOpts.html @@ -1,4 +1,4 @@ -ObliterateOpts | bullmq - v5.12.6

        Interface ObliterateOpts

        interface ObliterateOpts {
            count?: number;
            force?: boolean;
        }

        Properties

        count? +ObliterateOpts | bullmq - v5.12.7

        Interface ObliterateOpts

        interface ObliterateOpts {
            count?: number;
            force?: boolean;
        }

        Properties

        count? force?

        Properties

        Optional count

        count?: number

        Use count with the maximum number of deleted keys per iteration

        Default Value

        1000
@@ -6,4 +6,4 @@

        Optional force

        force?: boolean

        Use force = true to force obliteration even with active jobs in the queue

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.Parent.html b/interfaces/v4.Parent.html index 3c8a6a50bc..d8e7ab8994 100644 --- a/interfaces/v4.Parent.html +++ b/interfaces/v4.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.6

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.7

        Interface Parent<T>

        Describes the parent for a Job.

        interface Parent<T> {
            data?: T;
            name: string;
            opts?: JobsOptions;
            prefix?: string;
            queue?: string;
        }

        Type Parameters

        • T

        Properties

        data? name opts? prefix? queue? -

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.ParentKeys.html b/interfaces/v4.ParentKeys.html index 8835aae39d..5791d6fd6e 100644 --- a/interfaces/v4.ParentKeys.html +++ b/interfaces/v4.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.6

        Interface ParentKeys

        interface ParentKeys {
            id: string;
            queueKey: string;
        }

        Properties

        id +ParentKeys | bullmq - v5.12.7

        Interface ParentKeys

        interface ParentKeys {
            id: string;
            queueKey: string;
        }

        Properties

        id queueKey -

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.ParentMessage.html b/interfaces/v4.ParentMessage.html index 7922e5f648..1c59cd1db8 100644 --- a/interfaces/v4.ParentMessage.html +++ b/interfaces/v4.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.6

        Interface ParentMessage

        interface ParentMessage {
            cmd: ChildCommand;
            err?: Error;
            job?: JobJson;
            value?: any;
        }

        Properties

        cmd +ParentMessage | bullmq - v5.12.7

        Interface ParentMessage

        interface ParentMessage {
            cmd: ChildCommand;
            err?: Error;
            job?: JobJson;
            value?: any;
        }

        Properties

        cmd err? job? value? -

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.QueueBaseOptions.html b/interfaces/v4.QueueBaseOptions.html index b3b14cfa5c..683d276a10 100644 --- a/interfaces/v4.QueueBaseOptions.html +++ b/interfaces/v4.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.6

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.7

        Interface QueueBaseOptions

        Base Queue options

        interface QueueBaseOptions {
            blockingConnection?: boolean;
            connection?: ConnectionOptions;
            prefix?: string;
            skipVersionCheck?: boolean;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -9,4 +9,4 @@

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Avoid version validation to be greater or equal than v5.0.0.

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.QueueEventsListener.html b/interfaces/v4.QueueEventsListener.html index d5e07f7d38..4c355ca6e8 100644 --- a/interfaces/v4.QueueEventsListener.html +++ b/interfaces/v4.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.6

        Interface QueueEventsListener

        interface QueueEventsListener {
            active: ((args, id) => void);
            added: ((args, id) => void);
            cleaned: ((args, id) => void);
            completed: ((args, id) => void);
            delayed: ((args, id) => void);
            drained: ((id) => void);
            duplicated: ((args, id) => void);
            error: ((args) => void);
            failed: ((args, id) => void);
            ioredis:close: (() => void);
            paused: ((args, id) => void);
            progress: ((args, id) => void);
            removed: ((args, id) => void);
            resumed: ((args, id) => void);
            retries-exhausted: ((args, id) => void);
            stalled: ((args, id) => void);
            waiting: ((args, id) => void);
            waiting-children: ((args, id) => void);
        }

        Hierarchy (view full)

        Properties

        active +QueueEventsListener | bullmq - v5.12.7

        Interface QueueEventsListener

        interface QueueEventsListener {
            active: ((args, id) => void);
            added: ((args, id) => void);
            cleaned: ((args, id) => void);
            completed: ((args, id) => void);
            delayed: ((args, id) => void);
            drained: ((id) => void);
            duplicated: ((args, id) => void);
            error: ((args) => void);
            failed: ((args, id) => void);
            ioredis:close: (() => void);
            paused: ((args, id) => void);
            progress: ((args, id) => void);
            removed: ((args, id) => void);
            resumed: ((args, id) => void);
            retries-exhausted: ((args, id) => void);
            stalled: ((args, id) => void);
            waiting: ((args, id) => void);
            waiting-children: ((args, id) => void);
        }

        Hierarchy (view full)

        Properties

        active added cleaned completed @@ -60,4 +60,4 @@

        This event is triggered when a job enters the 'waiting' state.

        Parameters

        • args: {
              jobId: string;
              prev?: string;
          }
          • jobId: string
          • Optional prev?: string
        • id: string

        Returns void

        waiting-children

        waiting-children: ((args, id) => void)

        Type declaration

          • (args, id): void

          • Listen to 'waiting-children' event.

            This event is triggered when a job enters the 'waiting-children' state.

            -

            Parameters

            • args: {
                  jobId: string;
              }
              • jobId: string
            • id: string

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • args: {
              jobId: string;
          }
          • jobId: string
        • id: string

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.QueueEventsOptions.html b/interfaces/v4.QueueEventsOptions.html index d693df682c..e85be67209 100644 --- a/interfaces/v4.QueueEventsOptions.html +++ b/interfaces/v4.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.6

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.7

        Interface QueueEventsOptions

        Options for QueueEvents

        interface QueueEventsOptions {
            autorun?: boolean;
            blockingConnection?: boolean;
            blockingTimeout?: number;
            connection?: ConnectionOptions;
            lastEventId?: string;
            prefix?: string;
            skipVersionCheck?: boolean;
        }

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? blockingTimeout? @@ -17,4 +17,4 @@

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Avoid version validation to be greater or equal than v5.0.0.

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.QueueListener.html b/interfaces/v4.QueueListener.html index 0a7f24a347..1778009c53 100644 --- a/interfaces/v4.QueueListener.html +++ b/interfaces/v4.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.6

        Interface QueueListener<DataType, ResultType, NameType>

        interface QueueListener<DataType, ResultType, NameType> {
            cleaned: ((jobs, type) => void);
            error: ((err) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            removed: ((job) => void);
            resumed: (() => void);
            waiting: ((job) => void);
        }

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned +QueueListener | bullmq - v5.12.7

        Interface QueueListener<DataType, ResultType, NameType>

        interface QueueListener<DataType, ResultType, NameType> {
            cleaned: ((jobs, type) => void);
            error: ((err) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            removed: ((job) => void);
            resumed: (() => void);
            waiting: ((job) => void);
        }

        Type Parameters

        • DataType
        • ResultType
        • NameType extends string

        Hierarchy (view full)

        Properties

        cleaned error ioredis:close paused @@ -22,4 +22,4 @@

        This event is triggered when the queue is resumed.

        Returns void

        waiting

        waiting: ((job) => void)

        Type declaration

          • (job): void

          • Listen to 'waiting' event.

            This event is triggered when the queue creates a new job.

            -

            Parameters

            • job: Job<DataType, ResultType, NameType>

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • job: Job<DataType, ResultType, NameType>

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.QueueOptions.html b/interfaces/v4.QueueOptions.html index eb2448c31f..9e49da0f5c 100644 --- a/interfaces/v4.QueueOptions.html +++ b/interfaces/v4.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.6

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.7

        Interface QueueOptions

        Options for the Queue class.

        interface QueueOptions {
            blockingConnection?: boolean;
            connection?: ConnectionOptions;
            defaultJobOptions?: DefaultJobOptions;
            prefix?: string;
            settings?: AdvancedRepeatOptions;
            skipVersionCheck?: boolean;
            streams?: {
                events: {
                    maxLen: number;
                };
            };
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection? defaultJobOptions? @@ -15,4 +15,4 @@

        Optional streams

        streams?: {
            events: {
                maxLen: number;
            };
        }

        Options for the streams used internally in BullMQ.

        Type declaration

        • events: {
              maxLen: number;
          }

          Options for the events stream.

          • maxLen: number

            Max approximated length for streams. Default is 10 000 events.

            -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.RateLimiterOptions.html b/interfaces/v4.RateLimiterOptions.html index 7a0ccced72..3d12be282a 100644 --- a/interfaces/v4.RateLimiterOptions.html +++ b/interfaces/v4.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.6

        Interface RateLimiterOptions

        interface RateLimiterOptions {
            duration: number;
            max: number;
        }

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.7

        Interface RateLimiterOptions

        interface RateLimiterOptions {
            duration: number;
            max: number;
        }

        Properties

        duration max

        Properties

        duration

        duration: number

        Time in milliseconds. During this time, a maximum of max jobs will be processed.

        max

        max: number

        Max number of jobs to process in the time period specified in duration.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.RawCommand.html b/interfaces/v4.RawCommand.html index 17f92fc8a2..760960ef44 100644 --- a/interfaces/v4.RawCommand.html +++ b/interfaces/v4.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.6

        Interface RawCommand

        interface RawCommand {
            content: string;
            keys: number;
            name: string;
        }

        Properties

        content +RawCommand | bullmq - v5.12.7

        Interface RawCommand

        interface RawCommand {
            content: string;
            keys: number;
            name: string;
        }

        Properties

        content keys name -

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        content

        content: string

        keys

        keys: number

        name

        name: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.RepeatBaseOptions.html b/interfaces/v4.RepeatBaseOptions.html index 58578f4c70..08d7e514d9 100644 --- a/interfaces/v4.RepeatBaseOptions.html +++ b/interfaces/v4.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.6

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.7

        Interface RepeatBaseOptions

        Options for the Repeat class.

        interface RepeatBaseOptions {
            blockingConnection?: boolean;
            connection?: ConnectionOptions;
            prefix?: string;
            settings?: AdvancedRepeatOptions;
            skipVersionCheck?: boolean;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection? prefix? @@ -10,4 +10,4 @@

        Optional settings

        settings?: AdvancedRepeatOptions

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Avoid version validation to be greater or equal than v5.0.0.

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.RepeatOptions.html b/interfaces/v4.RepeatOptions.html index fe5c3e1082..1971886b4b 100644 --- a/interfaces/v4.RepeatOptions.html +++ b/interfaces/v4.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.6

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.7

        Interface RepeatOptions

        Settings for repeatable jobs

        See

        https://docs.bullmq.io/guide/jobs/repeatable

        interface RepeatOptions {
            count?: number;
            every?: number;
            immediately?: boolean;
            jobId?: string;
            limit?: number;
            offset?: number;
            pattern?: string;
            prevMillis?: number;
        }

        Hierarchy

        • Omit<ParserOptions, "iterator">
          • RepeatOptions

        Properties

        count? every? @@ -15,4 +15,4 @@ ( work only with every settings)

        Optional jobId

        jobId?: string

        Optional limit

        limit?: number

        Number of times the job should repeat at max.

        Optional offset

        offset?: number

        Optional pattern

        pattern?: string

        A repeat pattern

        -

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional prevMillis

        prevMillis?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.SandboxedJob.html b/interfaces/v4.SandboxedJob.html index 86d0d21fa8..1046660ee7 100644 --- a/interfaces/v4.SandboxedJob.html +++ b/interfaces/v4.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.6

        Interface SandboxedJob<T, R>

        See

        https://docs.bullmq.io/guide/workers/sandboxed-processors

        +SandboxedJob | bullmq - v5.12.7

        Interface SandboxedJob<T, R>

        See

        https://docs.bullmq.io/guide/workers/sandboxed-processors

        interface SandboxedJob<T, R> {
            attemptsMade: number;
            data: T;
            failedReason: string;
            finishedOn?: number;
            id: string;
            log: ((row) => void);
            moveToDelayed: ((timestamp, token?) => Promise<void>);
            name: string;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnValue: R;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
            updateData: ((data) => Promise<void>);
            updateProgress: ((value) => Promise<void>);
        }

        Type Parameters

        • T = any
        • R = any

        Hierarchy

        • Omit<JobJson, "data" | "opts" | "returnValue">
          • SandboxedJob

        Properties

        attemptsMade data failedReason @@ -19,4 +19,4 @@ timestamp updateData updateProgress -

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        moveToDelayed

        moveToDelayed: ((timestamp, token?) => Promise<void>)

        Type declaration

          • (timestamp, token?): Promise<void>

          • Parameters

            • timestamp: number
            • Optional token: string

            Returns Promise<void>

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        updateData

        updateData: ((data) => Promise<void>)

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

        updateProgress: ((value) => Promise<void>)

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        data

        data: T

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        log

        log: ((row) => void)

        Type declaration

          • (row): void

          • Parameters

            • row: any

            Returns void

        moveToDelayed

        moveToDelayed: ((timestamp, token?) => Promise<void>)

        Type declaration

          • (timestamp, token?): Promise<void>

          • Parameters

            • timestamp: number
            • Optional token: string

            Returns Promise<void>

        name

        name: string

        opts

        opts: JobsOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnValue

        returnValue: R

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        updateData

        updateData: ((data) => Promise<void>)

        Type declaration

          • (data): Promise<void>

          • Parameters

            • data: any

            Returns Promise<void>

        updateProgress

        updateProgress: ((value) => Promise<void>)

        Type declaration

          • (value): Promise<void>

          • Parameters

            • value: number | object

            Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.ScriptMetadata.html b/interfaces/v4.ScriptMetadata.html index 8a55b8a189..0750671a9e 100644 --- a/interfaces/v4.ScriptMetadata.html +++ b/interfaces/v4.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.6

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.7

        Interface ScriptMetadata

        Script metadata

        interface ScriptMetadata {
            content: string;
            includes: ScriptMetadata[];
            name: string;
            numberOfKeys?: number;
            path: string;
            token: string;
        }

        Properties

        content includes name @@ -11,4 +11,4 @@

        Optional numberOfKeys

        numberOfKeys?: number

        path

        path: string

        The path to the script. For includes, this is the normalized path, whereas it may not be normalized for the top-level parent

        token

        token: string

        A hash of the normalized path for easy replacement in the parent

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.WorkerListener.html b/interfaces/v4.WorkerListener.html index a6621bdd72..97e2484b7c 100644 --- a/interfaces/v4.WorkerListener.html +++ b/interfaces/v4.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.6

        Interface WorkerListener<DataType, ResultType, NameType>

        interface WorkerListener<DataType, ResultType, NameType> {
            active: ((job, prev) => void);
            closed: (() => void);
            closing: ((msg) => void);
            completed: ((job, result, prev) => void);
            drained: (() => void);
            error: ((failedReason) => void);
            failed: ((job, error, prev) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            ready: (() => void);
            resumed: (() => void);
            stalled: ((jobId, prev) => void);
        }

        Type Parameters

        • DataType = any
        • ResultType = any
        • NameType extends string = string

        Hierarchy (view full)

        Properties

        active +WorkerListener | bullmq - v5.12.7

        Interface WorkerListener<DataType, ResultType, NameType>

        interface WorkerListener<DataType, ResultType, NameType> {
            active: ((job, prev) => void);
            closed: (() => void);
            closing: ((msg) => void);
            completed: ((job, result, prev) => void);
            drained: (() => void);
            error: ((failedReason) => void);
            failed: ((job, error, prev) => void);
            ioredis:close: (() => void);
            paused: (() => void);
            progress: ((job, progress) => void);
            ready: (() => void);
            resumed: (() => void);
            stalled: ((jobId, prev) => void);
        }

        Type Parameters

        • DataType = any
        • ResultType = any
        • NameType extends string = string

        Hierarchy (view full)

        Properties

        active closed closing completed @@ -45,4 +45,4 @@

        Returns void

        stalled

        stalled: ((jobId, prev) => void)

        Type declaration

          • (jobId, prev): void

          • Listen to 'stalled' event.

            This event is triggered when a job has stalled and has been moved back to the wait list.

            -

            Parameters

            • jobId: string
            • prev: string

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • jobId: string
        • prev: string

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v4.WorkerOptions.html b/interfaces/v4.WorkerOptions.html index aff3b8fee4..78ea16df62 100644 --- a/interfaces/v4.WorkerOptions.html +++ b/interfaces/v4.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.6

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.7

        Interface WorkerOptions

        Base Queue options

        interface WorkerOptions {
            autorun?: boolean;
            blockingConnection?: boolean;
            concurrency?: number;
            connection?: ConnectionOptions;
            drainDelay?: number;
            limiter?: RateLimiterOptions;
            lockDuration?: number;
            lockRenewTime?: number;
            maxStalledCount?: number;
            metrics?: MetricsOptions;
            prefix?: string;
            removeOnComplete?: KeepJobs;
            removeOnFail?: KeepJobs;
            runRetryDelay?: number;
            settings?: AdvancedOptions;
            skipLockRenewal?: boolean;
            skipStalledCheck?: boolean;
            skipVersionCheck?: boolean;
            stalledInterval?: number;
            useWorkerThreads?: boolean;
        }

        Hierarchy (view full)

        Properties

        autorun? blockingConnection? concurrency? @@ -82,4 +82,4 @@

        See

        https: a file for the processor argument.

        Default

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.AddChildrenOpts.html b/interfaces/v5.AddChildrenOpts.html index 2493e1da6b..fcdcd67152 100644 --- a/interfaces/v5.AddChildrenOpts.html +++ b/interfaces/v5.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.6

        Interface AddChildrenOpts

        interface AddChildrenOpts {
            multi: ChainableCommander;
            nodes: FlowJob[];
            parent: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.7

        Interface AddChildrenOpts

        interface AddChildrenOpts {
            multi: ChainableCommander;
            nodes: FlowJob[];
            parent: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi nodes parent queuesOpts? -

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        multi

        multi: ChainableCommander

        nodes

        nodes: FlowJob[]

        parent

        parent: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.AddNodeOpts.html b/interfaces/v5.AddNodeOpts.html index 0854db0b95..6629421eaa 100644 --- a/interfaces/v5.AddNodeOpts.html +++ b/interfaces/v5.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.6

        Interface AddNodeOpts

        interface AddNodeOpts {
            multi: ChainableCommander;
            node: FlowJob;
            parent?: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi +AddNodeOpts | bullmq - v5.12.7

        Interface AddNodeOpts

        interface AddNodeOpts {
            multi: ChainableCommander;
            node: FlowJob;
            parent?: {
                parentDependenciesKey: string;
                parentOpts: {
                    id: string;
                    queue: string;
                };
            };
            queuesOpts?: FlowQueuesOpts;
        }

        Properties

        multi node parent? queuesOpts? -

        Properties

        multi

        multi: ChainableCommander

        node

        node: FlowJob

        Optional parent

        parent?: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Queues options that will be applied in each node depending on queue name presence.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        multi

        multi: ChainableCommander

        node

        node: FlowJob

        Optional parent

        parent?: {
            parentDependenciesKey: string;
            parentOpts: {
                id: string;
                queue: string;
            };
        }

        Type declaration

        • parentDependenciesKey: string
        • parentOpts: {
              id: string;
              queue: string;
          }
          • id: string
          • queue: string

        Optional queuesOpts

        queuesOpts?: FlowQueuesOpts

        Queues options that will be applied in each node depending on queue name presence.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.AdvancedOptions.html b/interfaces/v5.AdvancedOptions.html index 50eccfe9e3..ea2f0bb172 100644 --- a/interfaces/v5.AdvancedOptions.html +++ b/interfaces/v5.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.12.6

        Interface AdvancedOptions

        interface AdvancedOptions {
            backoffStrategy?: BackoffStrategy;
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.7

        Interface AdvancedOptions

        interface AdvancedOptions {
            backoffStrategy?: BackoffStrategy;
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        backoffStrategy? repeatKeyHashAlgorithm? repeatStrategy?

        Properties

        Optional backoffStrategy

        backoffStrategy?: BackoffStrategy

        A custom backoff strategy.

        -

        Optional repeatKeyHashAlgorithm

        repeatKeyHashAlgorithm?: string

        A hash algorithm to be used when trying to create the job redis key. +

        Optional repeatKeyHashAlgorithm

        repeatKeyHashAlgorithm?: string

        A hash algorithm to be used when trying to create the job redis key. Default - md5

        -

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.AdvancedRepeatOptions.html b/interfaces/v5.AdvancedRepeatOptions.html index 5752fadf36..4ded15e150 100644 --- a/interfaces/v5.AdvancedRepeatOptions.html +++ b/interfaces/v5.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.12.6

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.12.7

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatKeyHashAlgorithm?: string;
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? repeatStrategy?

        Properties

        Optional repeatKeyHashAlgorithm

        repeatKeyHashAlgorithm?: string

        A hash algorithm to be used when trying to create the job redis key. Default - md5

        -

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional repeatStrategy

        repeatStrategy?: RepeatStrategy

        A custom cron strategy.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.BackoffOptions.html b/interfaces/v5.BackoffOptions.html index 11b49e7c6a..07339738df 100644 --- a/interfaces/v5.BackoffOptions.html +++ b/interfaces/v5.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.6

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.7

        Interface BackoffOptions

        Settings for backing off failed jobs.

        See

        https://docs.bullmq.io/guide/retrying-failing-jobs

        -
        interface BackoffOptions {
            delay?: number;
            type: "fixed" | "exponential" | string & {};
        }

        Properties

        delay? +
        interface BackoffOptions {
            delay?: number;
            type: "fixed" | "exponential" | string & {};
        }

        Properties

        delay? type

        Properties

        Optional delay

        delay?: number

        Delay in milliseconds.

        -

        type

        type: "fixed" | "exponential" | string & {}

        Name of the backoff strategy.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        type

        type: "fixed" | "exponential" | string & {}

        Name of the backoff strategy.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.BaseJobOptions.html b/interfaces/v5.BaseJobOptions.html index bffb003f9e..805a265405 100644 --- a/interfaces/v5.BaseJobOptions.html +++ b/interfaces/v5.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.6

        Interface BaseJobOptions

        interface BaseJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            jobId?: string;
            keepLogs?: number;
            lifo?: boolean;
            parent?: {
                id: string;
                queue: string;
            };
            prevMillis?: number;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            repeat?: RepeatOptions;
            repeatJobKey?: string;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? +BaseJobOptions | bullmq - v5.12.7

        Interface BaseJobOptions

        interface BaseJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            jobId?: string;
            keepLogs?: number;
            lifo?: boolean;
            parent?: {
                id: string;
                queue: string;
            };
            prevMillis?: number;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            repeat?: RepeatOptions;
            repeatJobKey?: string;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? jobId? @@ -17,41 +17,41 @@

        Properties

        Optional attempts

        attempts?: number

        The total number of attempts to try the job until it completes.

        Default Value

        0
        -

        Optional backoff

        backoff?: number | BackoffOptions

        Backoff setting for automatic retries if the job fails

        -

        Optional delay

        delay?: number

        An amount of milliseconds to wait until this job can be processed. +

        Optional backoff

        backoff?: number | BackoffOptions

        Backoff setting for automatic retries if the job fails

        +

        Optional delay

        delay?: number

        An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

        Default Value

        0
        -

        Optional jobId

        jobId?: string

        Override the job ID - by default, the job ID is a unique +

        Optional jobId

        jobId?: string

        Override the job ID - by default, the job ID is a unique integer, but you can use this setting to override it. If you use this option, it is up to you to ensure the jobId is unique. If you attempt to add a job with an id that already exists, it will not be added.

        -

        Optional keepLogs

        keepLogs?: number

        Maximum amount of log entries that will be preserved

        -

        Optional lifo

        lifo?: boolean

        If true, adds the job to the right of the queue instead of the left (default false)

        +

        Optional keepLogs

        keepLogs?: number

        Maximum amount of log entries that will be preserved

        +

        Optional lifo

        lifo?: boolean

        If true, adds the job to the right of the queue instead of the left (default false)

        See

        https://docs.bullmq.io/guide/jobs/lifo

        -

        Optional parent

        parent?: {
            id: string;
            queue: string;
        }

        Type declaration

        Optional parent

        parent?: {
            id: string;
            queue: string;
        }

        Type declaration

        Optional prevMillis

        prevMillis?: number

        Internal property used by repeatable jobs.

        -

        Optional priority

        priority?: number

        Ranges from 1 (highest priority) to 2 097 152 (lowest priority). Note that +

        Optional prevMillis

        prevMillis?: number

        Internal property used by repeatable jobs.

        +

        Optional priority

        priority?: number

        Ranges from 1 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

        -

        Optional removeOnComplete

        removeOnComplete?: number | boolean | KeepJobs

        If true, removes the job when it successfully completes +

        Optional removeOnComplete

        removeOnComplete?: number | boolean | KeepJobs

        If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.

        -

        Optional removeOnFail

        removeOnFail?: number | boolean | KeepJobs

        If true, removes the job when it fails after all attempts. +

        Optional removeOnFail

        removeOnFail?: number | boolean | KeepJobs

        If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.

        -

        Optional repeat

        repeat?: RepeatOptions

        Repeat this job, for example based on a cron schedule.

        -

        Optional repeatJobKey

        repeatJobKey?: string

        Internal property used by repeatable jobs to save base repeat job key.

        -

        Optional sizeLimit

        sizeLimit?: number

        Limits the size in bytes of the job's data payload (as a JSON serialized string).

        -

        Optional stackTraceLimit

        stackTraceLimit?: number

        Limits the amount of stack trace lines that will be recorded in the stacktrace.

        -

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        +

        Optional repeat

        repeat?: RepeatOptions

        Repeat this job, for example based on a cron schedule.

        +

        Optional repeatJobKey

        repeatJobKey?: string

        Internal property used by repeatable jobs to save base repeat job key.

        +

        Optional sizeLimit

        sizeLimit?: number

        Limits the size in bytes of the job's data payload (as a JSON serialized string).

        +

        Optional stackTraceLimit

        stackTraceLimit?: number

        Limits the amount of stack trace lines that will be recorded in the stacktrace.

        +

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.BaseOptions.html b/interfaces/v5.BaseOptions.html index fc40b76ff3..5750fd6cb7 100644 --- a/interfaces/v5.BaseOptions.html +++ b/interfaces/v5.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.6

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? -

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +BaseOptions | bullmq - v5.12.7

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
        }

        Properties

        skipVersionCheck? +

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.BuiltInStrategies.html b/interfaces/v5.BuiltInStrategies.html index 79af6ba8ad..2e184c6c90 100644 --- a/interfaces/v5.BuiltInStrategies.html +++ b/interfaces/v5.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.6

        Interface BuiltInStrategies

        interface BuiltInStrategies {
            [index: string]: ((delay) => BackoffStrategy);
        }

        Indexable

        [index: string]: ((delay) => BackoffStrategy)

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +BuiltInStrategies | bullmq - v5.12.7

        Interface BuiltInStrategies

        interface BuiltInStrategies {
            [index: string]: ((delay) => BackoffStrategy);
        }

        Indexable

        [index: string]: ((delay) => BackoffStrategy)

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.ChildMessage.html b/interfaces/v5.ChildMessage.html index 1b129accd6..ecde0ea119 100644 --- a/interfaces/v5.ChildMessage.html +++ b/interfaces/v5.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.6

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Record<string, any>;
            value?: any;
        }

        Properties

        cmd +ChildMessage | bullmq - v5.12.7

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Record<string, any>;
            value?: any;
        }

        Properties

        cmd err? value? -

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ParentCommand

        Optional err

        err?: Record<string, any>

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.DebounceOptions.html b/interfaces/v5.DebounceOptions.html index 7796c0b247..841fdc06c8 100644 --- a/interfaces/v5.DebounceOptions.html +++ b/interfaces/v5.DebounceOptions.html @@ -1,6 +1,6 @@ -DebounceOptions | bullmq - v5.12.6

        Interface DebounceOptions

        Debounce options

        -
        interface DebounceOptions {
            id: string;
            ttl?: number;
        }

        Properties

        id +DebounceOptions | bullmq - v5.12.7

        Interface DebounceOptions

        Debounce options

        +
        interface DebounceOptions {
            id: string;
            ttl?: number;
        }

        Properties

        id ttl?

        Properties

        id

        id: string

        Identifier

        -

        Optional ttl

        ttl?: number

        ttl in milliseconds

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional ttl

        ttl?: number

        ttl in milliseconds

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.DefaultJobOptions.html b/interfaces/v5.DefaultJobOptions.html index 5f99dd2fc5..27c53b3e0c 100644 --- a/interfaces/v5.DefaultJobOptions.html +++ b/interfaces/v5.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.6

        Interface DefaultJobOptions

        interface DefaultJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            keepLogs?: number;
            lifo?: boolean;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? +DefaultJobOptions | bullmq - v5.12.7

        Interface DefaultJobOptions

        interface DefaultJobOptions {
            attempts?: number;
            backoff?: number | BackoffOptions;
            delay?: number;
            keepLogs?: number;
            lifo?: boolean;
            priority?: number;
            removeOnComplete?: number | boolean | KeepJobs;
            removeOnFail?: number | boolean | KeepJobs;
            sizeLimit?: number;
            stackTraceLimit?: number;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? keepLogs? @@ -12,31 +12,31 @@

        Properties

        Optional attempts

        attempts?: number

        The total number of attempts to try the job until it completes.

        Default Value

        0
        -

        Optional backoff

        backoff?: number | BackoffOptions

        Backoff setting for automatic retries if the job fails

        -

        Optional delay

        delay?: number

        An amount of milliseconds to wait until this job can be processed. +

        Optional backoff

        backoff?: number | BackoffOptions

        Backoff setting for automatic retries if the job fails

        +

        Optional delay

        delay?: number

        An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

        Default Value

        0
        -

        Optional keepLogs

        keepLogs?: number

        Maximum amount of log entries that will be preserved

        -

        Optional lifo

        lifo?: boolean

        If true, adds the job to the right of the queue instead of the left (default false)

        +

        Optional keepLogs

        keepLogs?: number

        Maximum amount of log entries that will be preserved

        +

        Optional lifo

        lifo?: boolean

        If true, adds the job to the right of the queue instead of the left (default false)

        See

        https://docs.bullmq.io/guide/jobs/lifo

        -

        Optional priority

        priority?: number

        Ranges from 1 (highest priority) to 2 097 152 (lowest priority). Note that +

        Optional priority

        priority?: number

        Ranges from 1 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

        -

        Optional removeOnComplete

        removeOnComplete?: number | boolean | KeepJobs

        If true, removes the job when it successfully completes +

        Optional removeOnComplete

        removeOnComplete?: number | boolean | KeepJobs

        If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.

        -

        Optional removeOnFail

        removeOnFail?: number | boolean | KeepJobs

        If true, removes the job when it fails after all attempts. +

        Optional removeOnFail

        removeOnFail?: number | boolean | KeepJobs

        If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.

        -

        Optional sizeLimit

        sizeLimit?: number

        Limits the size in bytes of the job's data payload (as a JSON serialized string).

        -

        Optional stackTraceLimit

        stackTraceLimit?: number

        Limits the amount of stack trace lines that will be recorded in the stacktrace.

        -

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        +

        Optional sizeLimit

        sizeLimit?: number

        Limits the size in bytes of the job's data payload (as a JSON serialized string).

        +

        Optional stackTraceLimit

        stackTraceLimit?: number

        Limits the amount of stack trace lines that will be recorded in the stacktrace.

        +

        Optional timestamp

        timestamp?: number

        Timestamp when the job was created.

        Default Value

        Date.now()
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.DependenciesOpts.html b/interfaces/v5.DependenciesOpts.html index b58a31dc80..1f1d44771d 100644 --- a/interfaces/v5.DependenciesOpts.html +++ b/interfaces/v5.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.6

        Interface DependenciesOpts

        interface DependenciesOpts {
            processed?: {
                count?: number;
                cursor?: number;
            };
            unprocessed?: {
                count?: number;
                cursor?: number;
            };
        }

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.7

        Interface DependenciesOpts

        interface DependenciesOpts {
            processed?: {
                count?: number;
                cursor?: number;
            };
            unprocessed?: {
                count?: number;
                cursor?: number;
            };
        }

        Properties

        processed? unprocessed? -

        Properties

        Optional processed

        processed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Optional unprocessed

        unprocessed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional processed

        processed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Optional unprocessed

        unprocessed?: {
            count?: number;
            cursor?: number;
        }

        Type declaration

        • Optional count?: number
        • Optional cursor?: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.FlowJobBase.html b/interfaces/v5.FlowJobBase.html index 30daf57753..a457bc4c7a 100644 --- a/interfaces/v5.FlowJobBase.html +++ b/interfaces/v5.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.6

        Interface FlowJobBase<T>

        interface FlowJobBase<T> {
            children?: FlowChildJob[];
            data?: any;
            name: string;
            opts?: Omit<T, "repeat">;
            prefix?: string;
            queueName: string;
        }

        Type Parameters

        • T

        Properties

        children? +FlowJobBase | bullmq - v5.12.7

        Interface FlowJobBase<T>

        interface FlowJobBase<T> {
            children?: FlowChildJob[];
            data?: any;
            name: string;
            opts?: Omit<T, "repeat">;
            prefix?: string;
            queueName: string;
        }

        Type Parameters

        • T

        Properties

        children? data? name opts? prefix? queueName -

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: FlowChildJob[]

        Optional data

        data?: any

        name

        name: string

        Optional opts

        opts?: Omit<T, "repeat">

        Optional prefix

        prefix?: string

        queueName

        queueName: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.FlowOpts.html b/interfaces/v5.FlowOpts.html index c29862cde4..0bc1ff0480 100644 --- a/interfaces/v5.FlowOpts.html +++ b/interfaces/v5.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.6

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.7

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions

        Properties

        queuesOptions

        queuesOptions: FlowQueuesOpts

        Map of options for Queue classes.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.FlowProducerListener.html b/interfaces/v5.FlowProducerListener.html index d68992c7b6..efbea7582d 100644 --- a/interfaces/v5.FlowProducerListener.html +++ b/interfaces/v5.FlowProducerListener.html @@ -1,11 +1,11 @@ -FlowProducerListener | bullmq - v5.12.6

        Interface FlowProducerListener

        interface FlowProducerListener {
            error: ((failedReason) => void);
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.7

        Interface FlowProducerListener

        interface FlowProducerListener {
            error: ((failedReason) => void);
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        error ioredis:close

        Properties

        error

        error: ((failedReason) => void)

        Listen to 'error' event.

        This event is triggered when an error is throw.

        Type declaration

          • (failedReason): void

          • Listen to 'error' event.

            This event is triggered when an error is throw.

            -

            Parameters

            • failedReason: Error

            Returns void

        ioredis:close

        ioredis:close: (() => void)

        Listen to 'ioredis:close' event.

        +

        Parameters

        • failedReason: Error

        Returns void

        ioredis:close

        ioredis:close: (() => void)

        Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.GetNextJobOptions.html b/interfaces/v5.GetNextJobOptions.html index 3c1a7aa6fd..27cd965c1c 100644 --- a/interfaces/v5.GetNextJobOptions.html +++ b/interfaces/v5.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.6

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? -

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +GetNextJobOptions | bullmq - v5.12.7

        Interface GetNextJobOptions

        interface GetNextJobOptions {
            block?: boolean;
        }

        Properties

        block? +

        Properties

        Optional block

        block?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.IConnection.html b/interfaces/v5.IConnection.html index dc81c8a4f1..c1a936843d 100644 --- a/interfaces/v5.IConnection.html +++ b/interfaces/v5.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.6

        Interface IConnection

        interface IConnection {
            client: Promise<RedisClient>;
            waitUntilReady(): Promise<boolean>;
        }

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.7

        Interface IConnection

        interface IConnection {
            client: Promise<RedisClient>;
            waitUntilReady(): Promise<boolean>;
        }

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client

        Methods

        waitUntilReady -

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        client

        client: Promise<RedisClient>

        Methods

        waitUntilReady

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.IoredisListener.html b/interfaces/v5.IoredisListener.html index fd6982d0da..8a5b887740 100644 --- a/interfaces/v5.IoredisListener.html +++ b/interfaces/v5.IoredisListener.html @@ -1,6 +1,6 @@ -IoredisListener | bullmq - v5.12.6

        Interface IoredisListener

        interface IoredisListener {
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.7

        Interface IoredisListener

        interface IoredisListener {
            ioredis:close: (() => void);
        }

        Hierarchy (view full)

        Properties

        ioredis:close

        Properties

        ioredis:close

        ioredis:close: (() => void)

        Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.JobJson.html b/interfaces/v5.JobJson.html index ed2a7ce51f..21145101c9 100644 --- a/interfaces/v5.JobJson.html +++ b/interfaces/v5.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.6

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            attemptsStarted: number;
            data: string;
            debounceId?: string;
            failedReason: string;
            finishedOn?: number;
            id: string;
            name: string;
            opts: RedisJobOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedBy?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
        }

        Properties

        attemptsMade +JobJson | bullmq - v5.12.7

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            attemptsStarted: number;
            data: string;
            debounceId?: string;
            failedReason: string;
            finishedOn?: number;
            id: string;
            name: string;
            opts: RedisJobOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedBy?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: string;
            stacktrace: string;
            timestamp: number;
        }

        Properties

        attemptsMade attemptsStarted data debounceId? @@ -16,4 +16,4 @@ returnvalue stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: number

        attemptsStarted

        attemptsStarted: number

        data

        data: string

        Optional debounceId

        debounceId?: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedBy

        processedBy?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        attemptsMade

        attemptsMade: number

        attemptsStarted

        attemptsStarted: number

        data

        data: string

        Optional debounceId

        debounceId?: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: number

        id

        id: string

        name

        name: string

        opts

        opts: RedisJobOptions

        Optional parent

        parent?: ParentKeys

        Optional parentKey

        parentKey?: string

        Optional processedBy

        processedBy?: string

        Optional processedOn

        processedOn?: number

        progress

        progress: number | object

        Optional repeatJobKey

        repeatJobKey?: string

        returnvalue

        returnvalue: string

        stacktrace

        stacktrace: string

        timestamp

        timestamp: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.JobJsonRaw.html b/interfaces/v5.JobJsonRaw.html index 964f564fbc..a6081c5214 100644 --- a/interfaces/v5.JobJsonRaw.html +++ b/interfaces/v5.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.6

        Interface JobJsonRaw

        interface JobJsonRaw {
            atm?: string;
            ats?: string;
            attemptsMade?: string;
            data: string;
            deid?: string;
            delay: string;
            failedReason: string;
            finishedOn?: string;
            id: string;
            name: string;
            opts: string;
            parent?: string;
            parentKey?: string;
            pb?: string;
            processedOn?: string;
            progress: string;
            returnvalue: string;
            rjk?: string;
            stacktrace: string[];
            timestamp: string;
        }

        Properties

        atm? +JobJsonRaw | bullmq - v5.12.7

        Interface JobJsonRaw

        interface JobJsonRaw {
            atm?: string;
            ats?: string;
            attemptsMade?: string;
            data: string;
            deid?: string;
            delay: string;
            failedReason: string;
            finishedOn?: string;
            id: string;
            name: string;
            opts: string;
            parent?: string;
            parentKey?: string;
            pb?: string;
            processedOn?: string;
            progress: string;
            returnvalue: string;
            rjk?: string;
            stacktrace: string[];
            timestamp: string;
        }

        Properties

        atm? ats? attemptsMade? data @@ -18,4 +18,4 @@ rjk? stacktrace timestamp -

        Properties

        Optional atm

        atm?: string

        Optional ats

        ats?: string

        Optional attemptsMade

        attemptsMade?: string

        data

        data: string

        Optional deid

        deid?: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional pb

        pb?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional atm

        atm?: string

        Optional ats

        ats?: string

        Optional attemptsMade

        attemptsMade?: string

        data

        data: string

        Optional deid

        deid?: string

        delay

        delay: string

        failedReason

        failedReason: string

        Optional finishedOn

        finishedOn?: string

        id

        id: string

        name

        name: string

        opts

        opts: string

        Optional parent

        parent?: string

        Optional parentKey

        parentKey?: string

        Optional pb

        pb?: string

        Optional processedOn

        processedOn?: string

        progress

        progress: string

        returnvalue

        returnvalue: string

        Optional rjk

        rjk?: string

        stacktrace

        stacktrace: string[]

        timestamp

        timestamp: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.JobNode.html b/interfaces/v5.JobNode.html index 150b445330..885416b40f 100644 --- a/interfaces/v5.JobNode.html +++ b/interfaces/v5.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.6

        Interface JobNode

        interface JobNode {
            children?: JobNode[];
            job: Job<any, any, string>;
        }

        Properties

        children? +JobNode | bullmq - v5.12.7

        Interface JobNode

        interface JobNode {
            children?: JobNode[];
            job: Job<any, any, string>;
        }

        Properties

        children? job -

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional children

        children?: JobNode[]

        job

        job: Job<any, any, string>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.KeepJobs.html b/interfaces/v5.KeepJobs.html index 8929da6983..9e8b487b46 100644 --- a/interfaces/v5.KeepJobs.html +++ b/interfaces/v5.KeepJobs.html @@ -1,9 +1,9 @@ -KeepJobs | bullmq - v5.12.6

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.7

        Interface KeepJobs

        KeepJobs

        Specify which jobs to keep after finishing. If both age and count are specified, then the jobs kept will be the ones that satisfies both properties.

        -
        interface KeepJobs {
            age?: number;
            count?: number;
        }

        Properties

        age? +
        interface KeepJobs {
            age?: number;
            count?: number;
        }

        Properties

        age? count?

        Properties

        Optional age

        age?: number

        Maximum age in seconds for job to be kept.

        -

        Optional count

        count?: number

        Maximum count of jobs to be kept.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional count

        count?: number

        Maximum count of jobs to be kept.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.Metrics.html b/interfaces/v5.Metrics.html index d41cdc595f..8e8cd88f8f 100644 --- a/interfaces/v5.Metrics.html +++ b/interfaces/v5.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.6

        Interface Metrics

        interface Metrics {
            count: number;
            data: number[];
            meta: {
                count: number;
                prevCount: number;
                prevTS: number;
            };
        }

        Properties

        count +Metrics | bullmq - v5.12.7

        Interface Metrics

        interface Metrics {
            count: number;
            data: number[];
            meta: {
                count: number;
                prevCount: number;
                prevTS: number;
            };
        }

        Properties

        count data meta -

        Properties

        count

        count: number

        data

        data: number[]

        meta

        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        }

        Type declaration

        • count: number
        • prevCount: number
        • prevTS: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        count

        count: number

        data

        data: number[]

        meta

        meta: {
            count: number;
            prevCount: number;
            prevTS: number;
        }

        Type declaration

        • count: number
        • prevCount: number
        • prevTS: number

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.MetricsOptions.html b/interfaces/v5.MetricsOptions.html index 32b4e2aae2..245215c4d9 100644 --- a/interfaces/v5.MetricsOptions.html +++ b/interfaces/v5.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.6

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.7

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints?

        Properties

        Optional maxDataPoints

        maxDataPoints?: number

        Enable gathering metrics for finished jobs. Output refers to all finished jobs, completed or failed.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.MinimalJob.html b/interfaces/v5.MinimalJob.html index 1416b797e2..12342c86f1 100644 --- a/interfaces/v5.MinimalJob.html +++ b/interfaces/v5.MinimalJob.html @@ -1,5 +1,5 @@ -MinimalJob | bullmq - v5.12.6

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        -
        interface MinimalJob<DataType, ReturnType, NameType> {
            attemptsMade: number;
            data: DataType;
            delay: number;
            failedReason: string;
            finishedOn?: number;
            id?: string;
            name: NameType;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: ReturnType;
            stacktrace: string[];
            timestamp: number;
            get prefix(): string;
            get queueName(): string;
            get queueQualifiedName(): string;
            asJSON(): JobJson;
            asJSONSandbox(): JobJsonSandbox;
            log(logRow): Promise<number>;
            updateData(data): Promise<void>;
            updateProgress(progress): Promise<void>;
        }

        Type Parameters

        • DataType = any
        • ReturnType = any
        • NameType extends string = string

        Implemented by

        Properties

        attemptsMade +MinimalJob | bullmq - v5.12.7

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +
        interface MinimalJob<DataType, ReturnType, NameType> {
            attemptsMade: number;
            data: DataType;
            delay: number;
            failedReason: string;
            finishedOn?: number;
            id?: string;
            name: NameType;
            opts: JobsOptions;
            parent?: ParentKeys;
            parentKey?: string;
            processedOn?: number;
            progress: number | object;
            repeatJobKey?: string;
            returnvalue: ReturnType;
            stacktrace: string[];
            timestamp: number;
            get prefix(): string;
            get queueName(): string;
            get queueQualifiedName(): string;
            asJSON(): JobJson;
            asJSONSandbox(): JobJsonSandbox;
            log(logRow): Promise<number>;
            updateData(data): Promise<void>;
            updateProgress(progress): Promise<void>;
        }

        Type Parameters

        • DataType = any
        • ReturnType = any
        • NameType extends string = string

        Implemented by

        Properties

        attemptsMade data delay failedReason @@ -26,37 +26,37 @@

        Properties

        attemptsMade

        attemptsMade: number

        Number of attempts after the job has failed.

        Default Value

        0
        -

        data

        data: DataType

        The payload for this job.

        -

        delay

        delay: number

        An amount of milliseconds to wait until this job can be processed.

        +

        data

        data: DataType

        The payload for this job.

        +

        delay

        delay: number

        An amount of milliseconds to wait until this job can be processed.

        Default Value

        0
        -

        failedReason

        failedReason: string

        Reason for failing.

        -

        Optional finishedOn

        finishedOn?: number

        Timestamp for when the job finished (completed or failed).

        -

        Optional id

        id?: string

        name

        name: NameType

        The name of the Job

        -

        opts

        opts: JobsOptions

        The options object for this job.

        -

        Optional parent

        parent?: ParentKeys

        Object that contains parentId (id) and parent queueKey.

        -

        Optional parentKey

        parentKey?: string

        Fully qualified key (including the queue prefix) pointing to the parent of this job.

        -

        Optional processedOn

        processedOn?: number

        Timestamp for when the job was processed.

        -

        progress

        progress: number | object

        The progress a job has performed so far.

        +

        failedReason

        failedReason: string

        Reason for failing.

        +

        Optional finishedOn

        finishedOn?: number

        Timestamp for when the job finished (completed or failed).

        +

        Optional id

        id?: string

        name

        name: NameType

        The name of the Job

        +

        opts

        opts: JobsOptions

        The options object for this job.

        +

        Optional parent

        parent?: ParentKeys

        Object that contains parentId (id) and parent queueKey.

        +

        Optional parentKey

        parentKey?: string

        Fully qualified key (including the queue prefix) pointing to the parent of this job.

        +

        Optional processedOn

        processedOn?: number

        Timestamp for when the job was processed.

        +

        progress

        progress: number | object

        The progress a job has performed so far.

        Default Value

        0
        -

        Optional repeatJobKey

        repeatJobKey?: string

        Base repeat job key.

        -

        returnvalue

        returnvalue: ReturnType

        The value returned by the processor when processing this job.

        +

        Optional repeatJobKey

        repeatJobKey?: string

        Base repeat job key.

        +

        returnvalue

        returnvalue: ReturnType

        The value returned by the processor when processing this job.

        Default Value

        null
        -

        stacktrace

        stacktrace: string[]

        Stacktrace for the error (for failed jobs).

        +

        stacktrace

        stacktrace: string[]

        Stacktrace for the error (for failed jobs).

        Default Value

        null
        -

        timestamp

        timestamp: number

        Timestamp when the job was created (unless overridden with job options).

        -

        Accessors

        prefix

        queueName

        queueQualifiedName

        • get queueQualifiedName(): string

        • Returns string

          it includes the prefix, the namespace separator :, and queue name.

          +

        timestamp

        timestamp: number

        Timestamp when the job was created (unless overridden with job options).

        +

        Accessors

        prefix

        queueName

        queueQualifiedName

        Methods

        asJSON

        asJSONSandbox

        log

        Methods

        asJSON

        asJSONSandbox

        log

        • log(logRow): Promise<number>

        • Logs one row of log data.

          Parameters

          • logRow: string

            string with log data to be logged.

            -

          Returns Promise<number>

        updateData

        • updateData(data): Promise<void>

        • Updates a job's data

          +

        Returns Promise<number>

        updateData

        • updateData(data): Promise<void>

        • Updates a job's data

          Parameters

          • data: DataType

            the data that will replace the current jobs data.

            -

          Returns Promise<void>

        updateProgress

        • updateProgress(progress): Promise<void>

        • Updates a job's progress

          +

        Returns Promise<void>

        updateProgress

        • updateProgress(progress): Promise<void>

        • Updates a job's progress

          Parameters

          • progress: number | object

            number or object to be saved as progress.

            -

          Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Returns Promise<void>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.MoveToDelayedOpts.html b/interfaces/v5.MoveToDelayedOpts.html index 7bb9913c41..5cf674b548 100644 --- a/interfaces/v5.MoveToDelayedOpts.html +++ b/interfaces/v5.MoveToDelayedOpts.html @@ -1,2 +1,2 @@ -MoveToDelayedOpts | bullmq - v5.12.6

        Interface MoveToDelayedOpts

        interface MoveToDelayedOpts {
            skipAttempt?: boolean;
        }

        Properties

        skipAttempt? -

        Properties

        Optional skipAttempt

        skipAttempt?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +MoveToDelayedOpts | bullmq - v5.12.7

        Interface MoveToDelayedOpts

        interface MoveToDelayedOpts {
            skipAttempt?: boolean;
        }

        Properties

        skipAttempt? +

        Properties

        Optional skipAttempt

        skipAttempt?: boolean

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.MoveToWaitingChildrenOpts.html b/interfaces/v5.MoveToWaitingChildrenOpts.html index 08d8f24b91..395280848a 100644 --- a/interfaces/v5.MoveToWaitingChildrenOpts.html +++ b/interfaces/v5.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.6

        Interface MoveToWaitingChildrenOpts

        interface MoveToWaitingChildrenOpts {
            child?: {
                id: string;
                queue: string;
            };
        }

        Properties

        child? -

        Properties

        Optional child

        child?: {
            id: string;
            queue: string;
        }

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +MoveToWaitingChildrenOpts | bullmq - v5.12.7

        Interface MoveToWaitingChildrenOpts

        interface MoveToWaitingChildrenOpts {
            child?: {
                id: string;
                queue: string;
            };
        }

        Properties

        child? +

        Properties

        Optional child

        child?: {
            id: string;
            queue: string;
        }

        Type declaration

        • id: string
        • queue: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.NodeOpts.html b/interfaces/v5.NodeOpts.html index 35ce2448d7..5d4aa3bc22 100644 --- a/interfaces/v5.NodeOpts.html +++ b/interfaces/v5.NodeOpts.html @@ -1,11 +1,11 @@ -NodeOpts | bullmq - v5.12.6

        Interface NodeOpts

        interface NodeOpts {
            depth?: number;
            id: string;
            maxChildren?: number;
            prefix?: string;
            queueName: string;
        }

        Properties

        depth? +NodeOpts | bullmq - v5.12.7

        Interface NodeOpts

        interface NodeOpts {
            depth?: number;
            id: string;
            maxChildren?: number;
            prefix?: string;
            queueName: string;
        }

        Properties

        depth? id maxChildren? prefix? queueName

        Properties

        Optional depth

        depth?: number

        Maximum depth or levels to visit in the tree.

        -

        id

        id: string

        Root job id.

        -

        Optional maxChildren

        maxChildren?: number

        Maximum quantity of children per type (processed, unprocessed).

        -

        Optional prefix

        prefix?: string

        Prefix included in job key.

        -

        queueName

        queueName: string

        Root job queue name.

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        id

        id: string

        Root job id.

        +

        Optional maxChildren

        maxChildren?: number

        Maximum quantity of children per type (processed, unprocessed).

        +

        Optional prefix

        prefix?: string

        Prefix included in job key.

        +

        queueName

        queueName: string

        Root job queue name.

        +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.ObliterateOpts.html b/interfaces/v5.ObliterateOpts.html index ba826a5d2e..df03f95896 100644 --- a/interfaces/v5.ObliterateOpts.html +++ b/interfaces/v5.ObliterateOpts.html @@ -1,9 +1,9 @@ -ObliterateOpts | bullmq - v5.12.6

        Interface ObliterateOpts

        interface ObliterateOpts {
            count?: number;
            force?: boolean;
        }

        Properties

        count? +ObliterateOpts | bullmq - v5.12.7

        Interface ObliterateOpts

        interface ObliterateOpts {
            count?: number;
            force?: boolean;
        }

        Properties

        count? force?

        Properties

        Optional count

        count?: number

        Use count with the maximum number of deleted keys per iteration

        Default Value

        1000
        -

        Optional force

        force?: boolean

        Use force = true to force obliteration even with active jobs in the queue

        +

        Optional force

        force?: boolean

        Use force = true to force obliteration even with active jobs in the queue

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.Parent.html b/interfaces/v5.Parent.html index d514047f13..344ab876fa 100644 --- a/interfaces/v5.Parent.html +++ b/interfaces/v5.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.6

        Interface Parent<T>

        Describes the parent for a Job.

        -
        interface Parent<T> {
            data?: T;
            name: string;
            opts?: JobsOptions;
            prefix?: string;
            queue?: string;
        }

        Type Parameters

        • T

        Properties

        data? +Parent | bullmq - v5.12.7

        Interface Parent<T>

        Describes the parent for a Job.

        +
        interface Parent<T> {
            data?: T;
            name: string;
            opts?: JobsOptions;
            prefix?: string;
            queue?: string;
        }

        Type Parameters

        • T

        Properties

        data? name opts? prefix? queue? -

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional data

        data?: T

        name

        name: string

        Optional opts

        opts?: JobsOptions

        Optional prefix

        prefix?: string

        Optional queue

        queue?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.ParentKeys.html b/interfaces/v5.ParentKeys.html index 3c5c68564f..4368ffd8b8 100644 --- a/interfaces/v5.ParentKeys.html +++ b/interfaces/v5.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.6

        Interface ParentKeys

        interface ParentKeys {
            id: string;
            queueKey: string;
        }

        Properties

        id +ParentKeys | bullmq - v5.12.7

        Interface ParentKeys

        interface ParentKeys {
            id: string;
            queueKey: string;
        }

        Properties

        id queueKey -

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        id

        id: string

        queueKey

        queueKey: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.ParentMessage.html b/interfaces/v5.ParentMessage.html index b61de9fed1..cd8701b8e3 100644 --- a/interfaces/v5.ParentMessage.html +++ b/interfaces/v5.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.6

        Interface ParentMessage

        interface ParentMessage {
            cmd: ChildCommand;
            err?: Error;
            job?: JobJson;
            value?: any;
        }

        Properties

        cmd +ParentMessage | bullmq - v5.12.7

        Interface ParentMessage

        interface ParentMessage {
            cmd: ChildCommand;
            err?: Error;
            job?: JobJson;
            value?: any;
        }

        Properties

        cmd err? job? value? -

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        cmd

        cmd: ChildCommand

        Optional err

        err?: Error

        Optional job

        job?: JobJson

        Optional value

        value?: any

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.QueueBaseOptions.html b/interfaces/v5.QueueBaseOptions.html index b042ecee89..7b573f2191 100644 --- a/interfaces/v5.QueueBaseOptions.html +++ b/interfaces/v5.QueueBaseOptions.html @@ -1,12 +1,12 @@ -QueueBaseOptions | bullmq - v5.12.6

        Interface QueueBaseOptions

        Base Queue options

        -
        interface QueueBaseOptions {
            blockingConnection?: boolean;
            connection: ConnectionOptions;
            prefix?: string;
            skipVersionCheck?: boolean;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? +QueueBaseOptions | bullmq - v5.12.7

        Interface QueueBaseOptions

        Base Queue options

        +
        interface QueueBaseOptions {
            blockingConnection?: boolean;
            connection: ConnectionOptions;
            prefix?: string;
            skipVersionCheck?: boolean;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection prefix? skipVersionCheck?

        Properties

        Optional blockingConnection

        blockingConnection?: boolean

        Denotes commands should retry indefinitely.

        -

        connection

        connection: ConnectionOptions

        Options for connecting to a Redis instance.

        -

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        -

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Avoid version validation to be greater or equal than v5.0.0.

        +

        connection

        connection: ConnectionOptions

        Options for connecting to a Redis instance.

        +

        Optional prefix

        prefix?: string

        Prefix for all queue keys.

        +

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Avoid version validation to be greater or equal than v5.0.0.

        Default Value

        false
        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.QueueEventsListener.html b/interfaces/v5.QueueEventsListener.html index e6d4b432be..842faaf95e 100644 --- a/interfaces/v5.QueueEventsListener.html +++ b/interfaces/v5.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.6

        Interface QueueEventsListener

        interface QueueEventsListener {
            active: ((args, id) => void);
            added: ((args, id) => void);
            cleaned: ((args, id) => void);
            completed: ((args, id) => void);
            debounced: ((args, id) => void);
            delayed: ((args, id) => void);
            drained: ((id) => void);
            duplicated: ((args, id) => void);
            error: ((args) => void);
            failed: ((args, id) => void);
            ioredis:close: (() => void);
            paused: ((args, id) => void);
            progress: ((args, id) => void);
            removed: ((args, id) => void);
            resumed: ((args, id) => void);
            retries-exhausted: ((args, id) => void);
            stalled: ((args, id) => void);
            waiting: ((args, id) => void);
            waiting-children: ((args, id) => void);
        }

        Hierarchy (view full)

        Properties

        active +QueueEventsListener | bullmq - v5.12.7

        Interface QueueEventsListener

        interface QueueEventsListener {
            active: ((args, id) => void);
            added: ((args, id) => void);
            cleaned: ((args, id) => void);
            completed: ((args, id) => void);
            debounced: ((args, id) => void);
            delayed: ((args, id) => void);
            drained: ((id) => void);
            duplicated: ((args, id) => void);
            error: ((args) => void);
            failed: ((args, id) => void);
            ioredis:close: (() => void);
            paused: ((args, id) => void);
            progress: ((args, id) => void);
            removed: ((args, id) => void);
            resumed: ((args, id) => void);
            retries-exhausted: ((args, id) => void);
            stalled: ((args, id) => void);
            waiting: ((args, id) => void);
            waiting-children: ((args, id) => void);
        }

        Hierarchy (view full)

        Properties

        active added cleaned completed @@ -21,27 +21,27 @@

        This event is triggered when a job enters the 'active' state.

        Type declaration

          • (args, id): void

          • Listen to 'active' event.

            This event is triggered when a job enters the 'active' state.

            -

            Parameters

            • args: {
                  jobId: string;
                  prev?: string;
              }
              • jobId: string
              • Optional prev?: string
            • id: string

            Returns void

        added

        added: ((args, id) => void)

        Listen to 'added' event.

        +

        Parameters

        • args: {
              jobId: string;
              prev?: string;
          }
          • jobId: string
          • Optional prev?: string
        • id: string

        Returns void

        added

        added: ((args, id) => void)

        Listen to 'added' event.

        This event is triggered when a job is created.

        Type declaration

          • (args, id): void

          • Listen to 'added' event.

            This event is triggered when a job is created.

            -

            Parameters

            • args: {
                  jobId: string;
                  name: string;
              }
              • jobId: string
              • name: string
            • id: string

            Returns void

        cleaned

        cleaned: ((args, id) => void)

        Listen to 'cleaned' event.

        +

        Parameters

        • args: {
              jobId: string;
              name: string;
          }
          • jobId: string
          • name: string
        • id: string

        Returns void

        cleaned

        cleaned: ((args, id) => void)

        Listen to 'cleaned' event.

        This event is triggered when a cleaned method is triggered.

        Type declaration

          • (args, id): void

          • Listen to 'cleaned' event.

            This event is triggered when a cleaned method is triggered.

            -

            Parameters

            • args: {
                  count: string;
              }
              • count: string
            • id: string

            Returns void

        completed

        completed: ((args, id) => void)

        Listen to 'completed' event.

        +

        Parameters

        • args: {
              count: string;
          }
          • count: string
        • id: string

        Returns void

        completed

        completed: ((args, id) => void)

        Listen to 'completed' event.

        This event is triggered when a job has successfully completed.

        Type declaration

          • (args, id): void

          • Listen to 'completed' event.

            This event is triggered when a job has successfully completed.

            -

            Parameters

            • args: {
                  jobId: string;
                  prev?: string;
                  returnvalue: string;
              }
              • jobId: string
              • Optional prev?: string
              • returnvalue: string
            • id: string

            Returns void

        debounced

        debounced: ((args, id) => void)

        Listen to 'debounced' event.

        +

        Parameters

        • args: {
              jobId: string;
              prev?: string;
              returnvalue: string;
          }
          • jobId: string
          • Optional prev?: string
          • returnvalue: string
        • id: string

        Returns void

        debounced

        debounced: ((args, id) => void)

        Listen to 'debounced' event.

        This event is triggered when a job is debounced because debounceId still existed.

        Type declaration

          • (args, id): void

          • Listen to 'debounced' event.

            This event is triggered when a job is debounced because debounceId still existed.

            -

            Parameters

            • args: {
                  debounceId: string;
                  jobId: string;
              }
              • debounceId: string
              • jobId: string
            • id: string

            Returns void

        delayed

        delayed: ((args, id) => void)

        Listen to 'delayed' event.

        +

        Parameters

        • args: {
              debounceId: string;
              jobId: string;
          }
          • debounceId: string
          • jobId: string
        • id: string

        Returns void

        delayed

        delayed: ((args, id) => void)

        Listen to 'delayed' event.

        This event is triggered when a job is delayed.

        Type declaration

          • (args, id): void

          • Listen to 'delayed' event.

            This event is triggered when a job is delayed.

            -

            Parameters

            • args: {
                  delay: number;
                  jobId: string;
              }
              • delay: number
              • jobId: string
            • id: string

            Returns void

        drained

        drained: ((id) => void)

        Listen to 'drained' event.

        +

        Parameters

        • args: {
              delay: number;
              jobId: string;
          }
          • delay: number
          • jobId: string
        • id: string

        Returns void

        drained

        drained: ((id) => void)

        Listen to 'drained' event.

        This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

        @@ -49,27 +49,27 @@

        This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

        -

        Parameters

        • id: string

        Returns void

        duplicated

        duplicated: ((args, id) => void)

        Listen to 'duplicated' event.

        +

        Parameters

        • id: string

        Returns void

        duplicated

        duplicated: ((args, id) => void)

        Listen to 'duplicated' event.

        This event is triggered when a job is not created because it already exist.

        Type declaration

          • (args, id): void

          • Listen to 'duplicated' event.

            This event is triggered when a job is not created because it already exist.

            -

            Parameters

            • args: {
                  jobId: string;
              }
              • jobId: string
            • id: string

            Returns void

        error

        error: ((args) => void)

        Listen to 'error' event.

        +

        Parameters

        • args: {
              jobId: string;
          }
          • jobId: string
        • id: string

        Returns void

        error

        error: ((args) => void)

        Listen to 'error' event.

        This event is triggered when an exception is thrown.

        Type declaration

          • (args): void

          • Listen to 'error' event.

            This event is triggered when an exception is thrown.

            -

            Parameters

            • args: Error

            Returns void

        failed

        failed: ((args, id) => void)

        Listen to 'failed' event.

        +

        Parameters

        • args: Error

        Returns void

        failed

        failed: ((args, id) => void)

        Listen to 'failed' event.

        This event is triggered when a job has thrown an exception.

        Type declaration

          • (args, id): void

          • Listen to 'failed' event.

            This event is triggered when a job has thrown an exception.

            -

            Parameters

            • args: {
                  failedReason: string;
                  jobId: string;
                  prev?: string;
              }
              • failedReason: string
              • jobId: string
              • Optional prev?: string
            • id: string

            Returns void

        ioredis:close

        ioredis:close: (() => void)

        Listen to 'ioredis:close' event.

        +

        Parameters

        • args: {
              failedReason: string;
              jobId: string;
              prev?: string;
          }
          • failedReason: string
          • jobId: string
          • Optional prev?: string
        • id: string

        Returns void

        ioredis:close

        ioredis:close: (() => void)

        Listen to 'ioredis:close' event.

        This event is triggered when ioredis is closed.

        Type declaration

          • (): void

          • Listen to 'ioredis:close' event.

            This event is triggered when ioredis is closed.

            -

            Returns void

        paused

        paused: ((args, id) => void)

        Listen to 'paused' event.

        +

        Returns void

        paused

        paused: ((args, id) => void)

        Listen to 'paused' event.

        This event is triggered when a queue is paused.

        Type declaration

          • (args, id): void

          • Listen to 'paused' event.

            This event is triggered when a queue is paused.

            -

            Parameters

            • args: {}
              • id: string

              Returns void

          progress

          progress: ((args, id) => void)

          Listen to 'progress' event.

          +

          Parameters

          • args: {}
            • id: string

            Returns void

            progress

            progress: ((args, id) => void)

            Listen to 'progress' event.

            This event is triggered when a job updates it progress, i.e. the Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the @@ -79,21 +79,21 @@ Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world.

            -

            Parameters

            • args: {
                  data: number | object;
                  jobId: string;
              }
              • data: number | object
              • jobId: string
            • id: string

            Returns void

            removed

            removed: ((args, id) => void)

            Listen to 'removed' event.

            +

            Parameters

            • args: {
                  data: number | object;
                  jobId: string;
              }
              • data: number | object
              • jobId: string
            • id: string

            Returns void

            removed

            removed: ((args, id) => void)

            Listen to 'removed' event.

            This event is triggered when a job has been manually removed from the queue.

            Type declaration

              • (args, id): void

              • Listen to 'removed' event.

                This event is triggered when a job has been manually removed from the queue.

                -

                Parameters

                • args: {
                      jobId: string;
                      prev: string;
                  }
                  • jobId: string
                  • prev: string
                • id: string

                Returns void

            resumed

            resumed: ((args, id) => void)

            Listen to 'resumed' event.

            +

            Parameters

            • args: {
                  jobId: string;
                  prev: string;
              }
              • jobId: string
              • prev: string
            • id: string

            Returns void

            resumed

            resumed: ((args, id) => void)

            Listen to 'resumed' event.

            This event is triggered when a queue is resumed.

            Type declaration

              • (args, id): void

              • Listen to 'resumed' event.

                This event is triggered when a queue is resumed.

                -

                Parameters

                • args: {}
                  • id: string

                  Returns void

              retries-exhausted

              retries-exhausted: ((args, id) => void)

              Listen to 'retries-exhausted' event.

              +

              Parameters

              • args: {}
                • id: string

                Returns void

                retries-exhausted

                retries-exhausted: ((args, id) => void)

                Listen to 'retries-exhausted' event.

                This event is triggered when a job has retried the maximum attempts.

                Type declaration

                  • (args, id): void

                  • Listen to 'retries-exhausted' event.

                    This event is triggered when a job has retried the maximum attempts.

                    -

                    Parameters

                    • args: {
                          attemptsMade: string;
                          jobId: string;
                      }
                      • attemptsMade: string
                      • jobId: string
                    • id: string

                    Returns void

                stalled

                stalled: ((args, id) => void)

                Listen to 'stalled' event.

                +

                Parameters

                • args: {
                      attemptsMade: string;
                      jobId: string;
                  }
                  • attemptsMade: string
                  • jobId: string
                • id: string

                Returns void

                stalled

                stalled: ((args, id) => void)

                Listen to 'stalled' event.

                This event is triggered when a job has been moved from 'active' back to 'waiting'/'failed' due to the processor not being able to renew the lock on the said job.

                @@ -101,12 +101,12 @@

                This event is triggered when a job has been moved from 'active' back to 'waiting'/'failed' due to the processor not being able to renew the lock on the said job.

                -

                Parameters

                • args: {
                      jobId: string;
                  }
                  • jobId: string
                • id: string

                Returns void

                waiting

                waiting: ((args, id) => void)

                Listen to 'waiting' event.

                +

                Parameters

                • args: {
                      jobId: string;
                  }
                  • jobId: string
                • id: string

                Returns void

                waiting

                waiting: ((args, id) => void)

                Listen to 'waiting' event.

                This event is triggered when a job enters the 'waiting' state.

                Type declaration

                  • (args, id): void

                  • Listen to 'waiting' event.

                    This event is triggered when a job enters the 'waiting' state.

                    -

                    Parameters

                    • args: {
                          jobId: string;
                          prev?: string;
                      }
                      • jobId: string
                      • Optional prev?: string
                    • id: string

                    Returns void

                waiting-children

                waiting-children: ((args, id) => void)

                Listen to 'waiting-children' event.

                +

                Parameters

                • args: {
                      jobId: string;
                      prev?: string;
                  }
                  • jobId: string
                  • Optional prev?: string
                • id: string

                Returns void

                waiting-children

                waiting-children: ((args, id) => void)

                Listen to 'waiting-children' event.

                This event is triggered when a job enters the 'waiting-children' state.

                Type declaration

                  • (args, id): void

                  • Listen to 'waiting-children' event.

                    This event is triggered when a job enters the 'waiting-children' state.

                    -

                    Parameters

                    • args: {
                          jobId: string;
                      }
                      • jobId: string
                    • id: string

                    Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Parameters

                • args: {
                      jobId: string;
                  }
                  • jobId: string
                • id: string

                Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.QueueEventsOptions.html b/interfaces/v5.QueueEventsOptions.html index 9f666e8be4..cc9cdedd18 100644 --- a/interfaces/v5.QueueEventsOptions.html +++ b/interfaces/v5.QueueEventsOptions.html @@ -1,5 +1,5 @@ -QueueEventsOptions | bullmq - v5.12.6

                Interface QueueEventsOptions

                Options for QueueEvents

                -
                interface QueueEventsOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    blockingTimeout?: number;
                    connection: ConnectionOptions;
                    lastEventId?: string;
                    prefix?: string;
                    skipVersionCheck?: boolean;
                }

                Hierarchy (view full)

                Properties

                autorun? +QueueEventsOptions | bullmq - v5.12.7

                Interface QueueEventsOptions

                Options for QueueEvents

                +
                interface QueueEventsOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    blockingTimeout?: number;
                    connection: ConnectionOptions;
                    lastEventId?: string;
                    prefix?: string;
                    skipVersionCheck?: boolean;
                }

                Hierarchy (view full)

                Properties

                autorun? blockingConnection? blockingTimeout? connection @@ -7,14 +7,14 @@ prefix? skipVersionCheck?

                Properties

                Optional autorun

                autorun?: boolean

                Condition to start listening to events at instance creation.

                -

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Optional blockingTimeout

                blockingTimeout?: number

                Timeout for the blocking XREAD call to the events stream.

                -

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                -

                Optional lastEventId

                lastEventId?: string

                Last event Id. If provided it is possible to continue +

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                +

                Optional blockingTimeout

                blockingTimeout?: number

                Timeout for the blocking XREAD call to the events stream.

                +

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                +

                Optional lastEventId

                lastEventId?: string

                Last event Id. If provided it is possible to continue consuming events from a known Id instead of from the last produced event.

                -

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                -

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                +

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                +

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                Default Value

                false
                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.QueueListener.html b/interfaces/v5.QueueListener.html index ac4b489d56..54112db4d9 100644 --- a/interfaces/v5.QueueListener.html +++ b/interfaces/v5.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.6

                Interface QueueListener<DataType, ResultType, NameType>

                interface QueueListener<DataType, ResultType, NameType> {
                    cleaned: ((jobs, type) => void);
                    error: ((err) => void);
                    ioredis:close: (() => void);
                    paused: (() => void);
                    progress: ((job, progress) => void);
                    removed: ((job) => void);
                    resumed: (() => void);
                    waiting: ((job) => void);
                }

                Type Parameters

                • DataType
                • ResultType
                • NameType extends string

                Hierarchy (view full)

                Properties

                cleaned +QueueListener | bullmq - v5.12.7

                Interface QueueListener<DataType, ResultType, NameType>

                interface QueueListener<DataType, ResultType, NameType> {
                    cleaned: ((jobs, type) => void);
                    error: ((err) => void);
                    ioredis:close: (() => void);
                    paused: (() => void);
                    progress: ((job, progress) => void);
                    removed: ((job) => void);
                    resumed: (() => void);
                    waiting: ((job) => void);
                }

                Type Parameters

                • DataType
                • ResultType
                • NameType extends string

                Hierarchy (view full)

                Properties

                cleaned error ioredis:close paused @@ -10,32 +10,32 @@

                This event is triggered when the queue calls clean method.

                Type declaration

                  • (jobs, type): void

                  • Listen to 'cleaned' event.

                    This event is triggered when the queue calls clean method.

                    -

                    Parameters

                    • jobs: string[]
                    • type: string

                    Returns void

                error

                error: ((err) => void)

                Listen to 'error' event.

                +

                Parameters

                • jobs: string[]
                • type: string

                Returns void

                error

                error: ((err) => void)

                Listen to 'error' event.

                This event is triggered when an error is thrown.

                Type declaration

                  • (err): void

                  • Listen to 'error' event.

                    This event is triggered when an error is thrown.

                    -

                    Parameters

                    • err: Error

                    Returns void

                ioredis:close

                ioredis:close: (() => void)

                Listen to 'ioredis:close' event.

                +

                Parameters

                • err: Error

                Returns void

                ioredis:close

                ioredis:close: (() => void)

                Listen to 'ioredis:close' event.

                This event is triggered when ioredis is closed.

                Type declaration

                  • (): void

                  • Listen to 'ioredis:close' event.

                    This event is triggered when ioredis is closed.

                    -

                    Returns void

                paused

                paused: (() => void)

                Listen to 'paused' event.

                +

                Returns void

                paused

                paused: (() => void)

                Listen to 'paused' event.

                This event is triggered when the queue is paused.

                Type declaration

                  • (): void

                  • Listen to 'paused' event.

                    This event is triggered when the queue is paused.

                    -

                    Returns void

                progress

                progress: ((job, progress) => void)

                Listen to 'progress' event.

                +

                Returns void

                progress

                progress: ((job, progress) => void)

                Listen to 'progress' event.

                This event is triggered when the job updates its progress.

                Type declaration

                  • (job, progress): void

                  • Listen to 'progress' event.

                    This event is triggered when the job updates its progress.

                    -

                    Parameters

                    Returns void

                removed

                removed: ((job) => void)

                Listen to 'removed' event.

                +

                Parameters

                Returns void

                removed

                removed: ((job) => void)

                Listen to 'removed' event.

                This event is triggered when a job is removed.

                Type declaration

                  • (job): void

                  • Listen to 'removed' event.

                    This event is triggered when a job is removed.

                    -

                    Parameters

                    Returns void

                resumed

                resumed: (() => void)

                Listen to 'resumed' event.

                +

                Parameters

                Returns void

                resumed

                resumed: (() => void)

                Listen to 'resumed' event.

                This event is triggered when the queue is resumed.

                Type declaration

                  • (): void

                  • Listen to 'resumed' event.

                    This event is triggered when the queue is resumed.

                    -

                    Returns void

                waiting

                waiting: ((job) => void)

                Listen to 'waiting' event.

                +

                Returns void

                waiting

                waiting: ((job) => void)

                Listen to 'waiting' event.

                This event is triggered when the queue creates a new job.

                Type declaration

                  • (job): void

                  • Listen to 'waiting' event.

                    This event is triggered when the queue creates a new job.

                    -

                    Parameters

                    Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Parameters

                Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.QueueOptions.html b/interfaces/v5.QueueOptions.html index ee5ff719c2..64e4798537 100644 --- a/interfaces/v5.QueueOptions.html +++ b/interfaces/v5.QueueOptions.html @@ -1,5 +1,5 @@ -QueueOptions | bullmq - v5.12.6

                Interface QueueOptions

                Options for the Queue class.

                -
                interface QueueOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    defaultJobOptions?: DefaultJobOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                    streams?: {
                        events: {
                            maxLen: number;
                        };
                    };
                }

                Hierarchy (view full)

                Properties

                blockingConnection? +QueueOptions | bullmq - v5.12.7

                Interface QueueOptions

                Options for the Queue class.

                +
                interface QueueOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    defaultJobOptions?: DefaultJobOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                    streams?: {
                        events: {
                            maxLen: number;
                        };
                    };
                }

                Hierarchy (view full)

                Properties

                blockingConnection? connection defaultJobOptions? prefix? @@ -7,12 +7,12 @@ skipVersionCheck? streams?

                Properties

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                -

                Optional defaultJobOptions

                defaultJobOptions?: DefaultJobOptions

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                -

                Optional settings

                settings?: AdvancedRepeatOptions

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                +

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                +

                Optional defaultJobOptions

                defaultJobOptions?: DefaultJobOptions

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                +

                Optional settings

                settings?: AdvancedRepeatOptions

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                Default Value

                false
                -

                Optional streams

                streams?: {
                    events: {
                        maxLen: number;
                    };
                }

                Options for the streams used internally in BullMQ.

                +

                Optional streams

                streams?: {
                    events: {
                        maxLen: number;
                    };
                }

                Options for the streams used internally in BullMQ.

                Type declaration

                • events: {
                      maxLen: number;
                  }

                  Options for the events stream.

                  • maxLen: number

                    Max approximated length for streams. Default is 10 000 events.

                    -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.RateLimiterOptions.html b/interfaces/v5.RateLimiterOptions.html index 3046f5fc9f..bb9cc66792 100644 --- a/interfaces/v5.RateLimiterOptions.html +++ b/interfaces/v5.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.6

                Interface RateLimiterOptions

                interface RateLimiterOptions {
                    duration: number;
                    max: number;
                }

                Properties

                duration +RateLimiterOptions | bullmq - v5.12.7

                Interface RateLimiterOptions

                interface RateLimiterOptions {
                    duration: number;
                    max: number;
                }

                Properties

                duration max

                Properties

                duration

                duration: number

                Time in milliseconds. During this time, a maximum of max jobs will be processed.

                -

                max

                max: number

                Max number of jobs to process in the time period +

                max

                max: number

                Max number of jobs to process in the time period specified in duration.

                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.RawCommand.html b/interfaces/v5.RawCommand.html index 428c64d709..4ede92b4e8 100644 --- a/interfaces/v5.RawCommand.html +++ b/interfaces/v5.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.6

                Interface RawCommand

                interface RawCommand {
                    content: string;
                    keys: number;
                    name: string;
                }

                Properties

                content +RawCommand | bullmq - v5.12.7

                Interface RawCommand

                interface RawCommand {
                    content: string;
                    keys: number;
                    name: string;
                }

                Properties

                content keys name -

                Properties

                content

                content: string

                keys

                keys: number

                name

                name: string

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Properties

                content

                content: string

                keys

                keys: number

                name

                name: string

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.RepeatBaseOptions.html b/interfaces/v5.RepeatBaseOptions.html index 60a83cf056..c545aebf3f 100644 --- a/interfaces/v5.RepeatBaseOptions.html +++ b/interfaces/v5.RepeatBaseOptions.html @@ -1,13 +1,13 @@ -RepeatBaseOptions | bullmq - v5.12.6

                Interface RepeatBaseOptions

                Options for the Repeat class.

                -
                interface RepeatBaseOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? +RepeatBaseOptions | bullmq - v5.12.7

                Interface RepeatBaseOptions

                Options for the Repeat class.

                +
                interface RepeatBaseOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? connection prefix? settings? skipVersionCheck?

                Properties

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                -

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                -

                Optional settings

                settings?: AdvancedRepeatOptions

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                +

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                +

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                +

                Optional settings

                settings?: AdvancedRepeatOptions

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                Default Value

                false
                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.RepeatOptions.html b/interfaces/v5.RepeatOptions.html index de513bcbff..356d2a5474 100644 --- a/interfaces/v5.RepeatOptions.html +++ b/interfaces/v5.RepeatOptions.html @@ -1,6 +1,6 @@ -RepeatOptions | bullmq - v5.12.6

                Interface RepeatOptions

                Settings for repeatable jobs

                +RepeatOptions | bullmq - v5.12.7

                Interface RepeatOptions

                Settings for repeatable jobs

                See

                https://docs.bullmq.io/guide/jobs/repeatable

                -
                interface RepeatOptions {
                    count?: number;
                    every?: number;
                    immediately?: boolean;
                    jobId?: string;
                    key?: string;
                    limit?: number;
                    offset?: number;
                    pattern?: string;
                    prevMillis?: number;
                }

                Hierarchy

                • Omit<ParserOptions, "iterator">
                  • RepeatOptions

                Properties

                count? +
                interface RepeatOptions {
                    count?: number;
                    every?: number;
                    immediately?: boolean;
                    jobId?: string;
                    key?: string;
                    limit?: number;
                    offset?: number;
                    pattern?: string;
                    prevMillis?: number;
                }

                Hierarchy

                • Omit<ParserOptions, "iterator">
                  • RepeatOptions

                Properties

                count? every? immediately? jobId? @@ -10,14 +10,14 @@ pattern? prevMillis?

                Properties

                Optional count

                count?: number

                The start value for the repeat iteration count.

                -

                Optional every

                every?: number

                Repeat after this amount of milliseconds +

                Optional every

                every?: number

                Repeat after this amount of milliseconds (pattern setting cannot be used together with this setting.)

                -

                Optional immediately

                immediately?: boolean

                Repeated job should start right now +

                Optional immediately

                immediately?: boolean

                Repeated job should start right now ( work only with every settings)

                -

                Optional jobId

                jobId?: string

                Optional key

                key?: string

                Custom repeatable key. This is the key that holds the "metadata" +

                Optional jobId

                jobId?: string

                Optional key

                key?: string

                Custom repeatable key. This is the key that holds the "metadata" of a given repeatable job. This key is normally auto-generated but it is sometimes useful to specify a custom key for easier retrieval of repeatable jobs.

                -

                Optional limit

                limit?: number

                Number of times the job should repeat at max.

                -

                Optional offset

                offset?: number

                Optional pattern

                pattern?: string

                A repeat pattern

                -

                Optional prevMillis

                prevMillis?: number

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Optional limit

                limit?: number

                Number of times the job should repeat at max.

                +

                Optional offset

                offset?: number

                Optional pattern

                pattern?: string

                A repeat pattern

                +

                Optional prevMillis

                prevMillis?: number

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.SandboxedJob.html b/interfaces/v5.SandboxedJob.html index 412bd8293a..16c3034309 100644 --- a/interfaces/v5.SandboxedJob.html +++ b/interfaces/v5.SandboxedJob.html @@ -1,5 +1,5 @@ -SandboxedJob | bullmq - v5.12.6

                Interface SandboxedJob<T, R>

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -
                interface SandboxedJob<T, R> {
                    attemptsMade: number;
                    attemptsStarted: number;
                    data: T;
                    debounceId?: string;
                    failedReason: string;
                    finishedOn?: number;
                    id: string;
                    log: ((row) => void);
                    moveToDelayed: ((timestamp, token?) => Promise<void>);
                    name: string;
                    opts: JobsOptions;
                    parent?: ParentKeys;
                    parentKey?: string;
                    prefix: string;
                    processedBy?: string;
                    processedOn?: number;
                    progress: number | object;
                    queueName: string;
                    repeatJobKey?: string;
                    returnValue: R;
                    returnvalue: string;
                    stacktrace: string;
                    timestamp: number;
                    updateData: ((data) => Promise<void>);
                    updateProgress: ((value) => Promise<void>);
                }

                Type Parameters

                • T = any
                • R = any

                Hierarchy

                Properties

                attemptsMade +SandboxedJob | bullmq - v5.12.7

                Interface SandboxedJob<T, R>

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                +
                interface SandboxedJob<T, R> {
                    attemptsMade: number;
                    attemptsStarted: number;
                    data: T;
                    debounceId?: string;
                    failedReason: string;
                    finishedOn?: number;
                    id: string;
                    log: ((row) => void);
                    moveToDelayed: ((timestamp, token?) => Promise<void>);
                    name: string;
                    opts: JobsOptions;
                    parent?: ParentKeys;
                    parentKey?: string;
                    prefix: string;
                    processedBy?: string;
                    processedOn?: number;
                    progress: number | object;
                    queueName: string;
                    repeatJobKey?: string;
                    returnValue: R;
                    returnvalue: string;
                    stacktrace: string;
                    timestamp: number;
                    updateData: ((data) => Promise<void>);
                    updateProgress: ((value) => Promise<void>);
                }

                Type Parameters

                • T = any
                • R = any

                Hierarchy

                Properties

                attemptsMade attemptsStarted data debounceId? @@ -24,4 +24,4 @@ timestamp updateData updateProgress -

                Properties

                attemptsMade

                attemptsMade: number

                attemptsStarted

                attemptsStarted: number

                data

                data: T

                Optional debounceId

                debounceId?: string

                failedReason

                failedReason: string

                Optional finishedOn

                finishedOn?: number

                id

                id: string

                log

                log: ((row) => void)

                Type declaration

                  • (row): void

                  • Parameters

                    • row: any

                    Returns void

                moveToDelayed

                moveToDelayed: ((timestamp, token?) => Promise<void>)

                Type declaration

                  • (timestamp, token?): Promise<void>

                  • Parameters

                    • timestamp: number
                    • Optional token: string

                    Returns Promise<void>

                name

                name: string

                opts

                opts: JobsOptions

                Optional parent

                parent?: ParentKeys

                Optional parentKey

                parentKey?: string

                prefix

                prefix: string

                Optional processedBy

                processedBy?: string

                Optional processedOn

                processedOn?: number

                progress

                progress: number | object

                queueName

                queueName: string

                Optional repeatJobKey

                repeatJobKey?: string

                returnValue

                returnValue: R

                returnvalue

                returnvalue: string

                stacktrace

                stacktrace: string

                timestamp

                timestamp: number

                updateData

                updateData: ((data) => Promise<void>)

                Type declaration

                  • (data): Promise<void>

                  • Parameters

                    • data: any

                    Returns Promise<void>

                updateProgress

                updateProgress: ((value) => Promise<void>)

                Type declaration

                  • (value): Promise<void>

                  • Parameters

                    • value: number | object

                    Returns Promise<void>

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Properties

                attemptsMade

                attemptsMade: number

                attemptsStarted

                attemptsStarted: number

                data

                data: T

                Optional debounceId

                debounceId?: string

                failedReason

                failedReason: string

                Optional finishedOn

                finishedOn?: number

                id

                id: string

                log

                log: ((row) => void)

                Type declaration

                  • (row): void

                  • Parameters

                    • row: any

                    Returns void

                moveToDelayed

                moveToDelayed: ((timestamp, token?) => Promise<void>)

                Type declaration

                  • (timestamp, token?): Promise<void>

                  • Parameters

                    • timestamp: number
                    • Optional token: string

                    Returns Promise<void>

                name

                name: string

                opts

                opts: JobsOptions

                Optional parent

                parent?: ParentKeys

                Optional parentKey

                parentKey?: string

                prefix

                prefix: string

                Optional processedBy

                processedBy?: string

                Optional processedOn

                processedOn?: number

                progress

                progress: number | object

                queueName

                queueName: string

                Optional repeatJobKey

                repeatJobKey?: string

                returnValue

                returnValue: R

                returnvalue

                returnvalue: string

                stacktrace

                stacktrace: string

                timestamp

                timestamp: number

                updateData

                updateData: ((data) => Promise<void>)

                Type declaration

                  • (data): Promise<void>

                  • Parameters

                    • data: any

                    Returns Promise<void>

                updateProgress

                updateProgress: ((value) => Promise<void>)

                Type declaration

                  • (value): Promise<void>

                  • Parameters

                    • value: number | object

                    Returns Promise<void>

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.WorkerListener.html b/interfaces/v5.WorkerListener.html index 8a6f088f34..3382be8834 100644 --- a/interfaces/v5.WorkerListener.html +++ b/interfaces/v5.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.6

                Interface WorkerListener<DataType, ResultType, NameType>

                interface WorkerListener<DataType, ResultType, NameType> {
                    active: ((job, prev) => void);
                    closed: (() => void);
                    closing: ((msg) => void);
                    completed: ((job, result, prev) => void);
                    drained: (() => void);
                    error: ((failedReason) => void);
                    failed: ((job, error, prev) => void);
                    ioredis:close: (() => void);
                    paused: (() => void);
                    progress: ((job, progress) => void);
                    ready: (() => void);
                    resumed: (() => void);
                    stalled: ((jobId, prev) => void);
                }

                Type Parameters

                • DataType = any
                • ResultType = any
                • NameType extends string = string

                Hierarchy (view full)

                Properties

                active +WorkerListener | bullmq - v5.12.7

                Interface WorkerListener<DataType, ResultType, NameType>

                interface WorkerListener<DataType, ResultType, NameType> {
                    active: ((job, prev) => void);
                    closed: (() => void);
                    closing: ((msg) => void);
                    completed: ((job, result, prev) => void);
                    drained: (() => void);
                    error: ((failedReason) => void);
                    failed: ((job, error, prev) => void);
                    ioredis:close: (() => void);
                    paused: (() => void);
                    progress: ((job, progress) => void);
                    ready: (() => void);
                    resumed: (() => void);
                    stalled: ((jobId, prev) => void);
                }

                Type Parameters

                • DataType = any
                • ResultType = any
                • NameType extends string = string

                Hierarchy (view full)

                Properties

                active closed closing completed @@ -15,19 +15,19 @@

                This event is triggered when a job enters the 'active' state.

                Type declaration

                  • (job, prev): void

                  • Listen to 'active' event.

                    This event is triggered when a job enters the 'active' state.

                    -

                    Parameters

                    Returns void

                closed

                closed: (() => void)

                Listen to 'closing' event.

                +

                Parameters

                Returns void

                closed

                closed: (() => void)

                Listen to 'closing' event.

                This event is triggered when the worker is closed.

                Type declaration

                  • (): void

                  • Listen to 'closing' event.

                    This event is triggered when the worker is closed.

                    -

                    Returns void

                closing

                closing: ((msg) => void)

                Listen to 'closing' event.

                +

                Returns void

                closing

                closing: ((msg) => void)

                Listen to 'closing' event.

                This event is triggered when the worker is closing.

                Type declaration

                  • (msg): void

                  • Listen to 'closing' event.

                    This event is triggered when the worker is closing.

                    -

                    Parameters

                    • msg: string

                    Returns void

                completed

                completed: ((job, result, prev) => void)

                Listen to 'completed' event.

                +

                Parameters

                • msg: string

                Returns void

                completed

                completed: ((job, result, prev) => void)

                Listen to 'completed' event.

                This event is triggered when a job has successfully completed.

                Type declaration

                  • (job, result, prev): void

                  • Listen to 'completed' event.

                    This event is triggered when a job has successfully completed.

                    -

                    Parameters

                    Returns void

                drained

                drained: (() => void)

                Listen to 'drained' event.

                +

                Parameters

                Returns void

                drained

                drained: (() => void)

                Listen to 'drained' event.

                This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

                @@ -35,11 +35,11 @@

                This event is triggered when the queue has drained the waiting list. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.

                -

                Returns void

                error

                error: ((failedReason) => void)

                Listen to 'error' event.

                +

                Returns void

                error

                error: ((failedReason) => void)

                Listen to 'error' event.

                This event is triggered when an error is throw.

                Type declaration

                  • (failedReason): void

                  • Listen to 'error' event.

                    This event is triggered when an error is throw.

                    -

                    Parameters

                    • failedReason: Error

                    Returns void

                failed

                failed: ((job, error, prev) => void)

                Listen to 'failed' event.

                +

                Parameters

                • failedReason: Error

                Returns void

                failed

                failed: ((job, error, prev) => void)

                Listen to 'failed' event.

                This event is triggered when a job has thrown an exception. Note: job parameter could be received as undefined when an stalled job reaches the stalled limit and it is deleted by the removeOnFail option.

                @@ -47,15 +47,15 @@

                This event is triggered when a job has thrown an exception. Note: job parameter could be received as undefined when an stalled job reaches the stalled limit and it is deleted by the removeOnFail option.

                -

                Parameters

                Returns void

                ioredis:close

                ioredis:close: (() => void)

                Listen to 'ioredis:close' event.

                +

                Parameters

                Returns void

                ioredis:close

                ioredis:close: (() => void)

                Listen to 'ioredis:close' event.

                This event is triggered when ioredis is closed.

                Type declaration

                  • (): void

                  • Listen to 'ioredis:close' event.

                    This event is triggered when ioredis is closed.

                    -

                    Returns void

                paused

                paused: (() => void)

                Listen to 'paused' event.

                +

                Returns void

                paused

                paused: (() => void)

                Listen to 'paused' event.

                This event is triggered when the queue is paused.

                Type declaration

                  • (): void

                  • Listen to 'paused' event.

                    This event is triggered when the queue is paused.

                    -

                    Returns void

                progress

                progress: ((job, progress) => void)

                Listen to 'progress' event.

                +

                Returns void

                progress

                progress: ((job, progress) => void)

                Listen to 'progress' event.

                This event is triggered when a job updates it progress, i.e. the Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the @@ -65,18 +65,18 @@ Job##updateProgress() method is called. This is useful to notify progress or any other data from within a processor to the rest of the world.

                -

                Parameters

                Returns void

                ready

                ready: (() => void)

                Listen to 'ready' event.

                +

                Parameters

                Returns void

                ready

                ready: (() => void)

                Listen to 'ready' event.

                This event is triggered when blockingConnection is ready.

                Type declaration

                  • (): void

                  • Listen to 'ready' event.

                    This event is triggered when blockingConnection is ready.

                    -

                    Returns void

                resumed

                resumed: (() => void)

                Listen to 'resumed' event.

                +

                Returns void

                resumed

                resumed: (() => void)

                Listen to 'resumed' event.

                This event is triggered when the queue is resumed.

                Type declaration

                  • (): void

                  • Listen to 'resumed' event.

                    This event is triggered when the queue is resumed.

                    -

                    Returns void

                stalled

                stalled: ((jobId, prev) => void)

                Listen to 'stalled' event.

                +

                Returns void

                stalled

                stalled: ((jobId, prev) => void)

                Listen to 'stalled' event.

                This event is triggered when a job has stalled and has been moved back to the wait list.

                Type declaration

                  • (jobId, prev): void

                  • Listen to 'stalled' event.

                    This event is triggered when a job has stalled and has been moved back to the wait list.

                    -

                    Parameters

                    • jobId: string
                    • prev: string

                    Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Parameters

                • jobId: string
                • prev: string

                Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.WorkerOptions.html b/interfaces/v5.WorkerOptions.html index e88037b261..25fdbb241b 100644 --- a/interfaces/v5.WorkerOptions.html +++ b/interfaces/v5.WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | bullmq - v5.12.6

                Interface WorkerOptions

                Base Queue options

                -
                interface WorkerOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    concurrency?: number;
                    connection: ConnectionOptions;
                    drainDelay?: number;
                    limiter?: RateLimiterOptions;
                    lockDuration?: number;
                    lockRenewTime?: number;
                    maxStalledCount?: number;
                    metrics?: MetricsOptions;
                    name?: string;
                    prefix?: string;
                    removeOnComplete?: KeepJobs;
                    removeOnFail?: KeepJobs;
                    runRetryDelay?: number;
                    settings?: AdvancedOptions;
                    skipLockRenewal?: boolean;
                    skipStalledCheck?: boolean;
                    skipVersionCheck?: boolean;
                    stalledInterval?: number;
                    useWorkerThreads?: boolean;
                }

                Hierarchy (view full)

                Properties

                autorun? +WorkerOptions | bullmq - v5.12.7

                Interface WorkerOptions

                Base Queue options

                +
                interface WorkerOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    concurrency?: number;
                    connection: ConnectionOptions;
                    drainDelay?: number;
                    limiter?: RateLimiterOptions;
                    lockDuration?: number;
                    lockRenewTime?: number;
                    maxStalledCount?: number;
                    metrics?: MetricsOptions;
                    name?: string;
                    prefix?: string;
                    removeOnComplete?: KeepJobs;
                    removeOnFail?: KeepJobs;
                    runRetryDelay?: number;
                    settings?: AdvancedOptions;
                    skipLockRenewal?: boolean;
                    skipStalledCheck?: boolean;
                    skipVersionCheck?: boolean;
                    stalledInterval?: number;
                    useWorkerThreads?: boolean;
                }

                Hierarchy (view full)

                Properties

                autorun? blockingConnection? concurrency? connection @@ -23,67 +23,67 @@

                Properties

                Optional autorun

                autorun?: boolean

                Condition to start processor at instance creation.

                Default

                true
                -

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Optional concurrency

                concurrency?: number

                Amount of jobs that a single worker is allowed to work on +

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                +

                Optional concurrency

                concurrency?: number

                Amount of jobs that a single worker is allowed to work on in parallel.

                Default

                1

                See

                https://docs.bullmq.io/guide/workers/concurrency

                -

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                -

                Optional drainDelay

                drainDelay?: number

                Number of seconds to long poll for jobs when the queue is empty.

                +

                connection

                connection: ConnectionOptions

                Options for connecting to a Redis instance.

                +

                Optional drainDelay

                drainDelay?: number

                Number of seconds to long poll for jobs when the queue is empty.

                Default

                5
                -

                Optional limiter

                limiter?: RateLimiterOptions

                Enable rate limiter

                +

                Optional limiter

                limiter?: RateLimiterOptions

                Enable rate limiter

                See

                https://docs.bullmq.io/guide/rate-limiting

                -

                Optional lockDuration

                lockDuration?: number

                Duration of the lock for the job in milliseconds. The lock represents that +

                Optional lockDuration

                lockDuration?: number

                Duration of the lock for the job in milliseconds. The lock represents that a worker is processing the job. If the lock is lost, the job will be eventually be picked up by the stalled checker and move back to wait so that another worker can process it again.

                Default

                30000
                -

                Optional lockRenewTime

                lockRenewTime?: number

                The time in milliseconds before the lock is automatically renewed.

                +

                Optional lockRenewTime

                lockRenewTime?: number

                The time in milliseconds before the lock is automatically renewed.

                It is not recommended to modify this value, which is by default set to halv the lockDuration value, which is optimal for most use cases.

                -

                Optional maxStalledCount

                maxStalledCount?: number

                Amount of times a job can be recovered from a stalled state +

                Optional maxStalledCount

                maxStalledCount?: number

                Amount of times a job can be recovered from a stalled state to the wait state. If this is exceeded, the job is moved to failed.

                Default

                1
                -

                Optional metrics

                metrics?: MetricsOptions

                Enable collect metrics.

                +

                Optional metrics

                metrics?: MetricsOptions

                Enable collect metrics.

                See

                https://docs.bullmq.io/guide/metrics

                -

                Optional name

                name?: string

                Optional worker name. The name will be stored on every job +

                Optional name

                name?: string

                Optional worker name. The name will be stored on every job processed by this worker instance, and can be used to monitor which worker is processing or has processed a given job.

                -

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                -

                Optional removeOnComplete

                removeOnComplete?: KeepJobs

                You can provide an object specifying max +

                Optional prefix

                prefix?: string

                Prefix for all queue keys.

                +

                Optional removeOnComplete

                removeOnComplete?: KeepJobs

                You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.

                -

                Optional removeOnFail

                removeOnFail?: KeepJobs

                You can provide an object specifying max +

                Optional removeOnFail

                removeOnFail?: KeepJobs

                You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the failed set.

                -

                Optional runRetryDelay

                runRetryDelay?: number

                This is an internal option that should not be modified.

                +

                Optional runRetryDelay

                runRetryDelay?: number

                This is an internal option that should not be modified.

                Default

                15000
                -

                Optional settings

                settings?: AdvancedOptions

                More advanced options.

                -

                Optional skipLockRenewal

                skipLockRenewal?: boolean

                Skip lock renewal for this worker. If set to true, the lock will expire +

                Optional settings

                settings?: AdvancedOptions

                More advanced options.

                +

                Optional skipLockRenewal

                skipLockRenewal?: boolean

                Skip lock renewal for this worker. If set to true, the lock will expire after lockDuration and moved back to the wait queue (if the stalled check is not disabled)

                Default

                false
                -

                Optional skipStalledCheck

                skipStalledCheck?: boolean

                Skip stalled check for this worker. Note that other workers could still +

                Optional skipStalledCheck

                skipStalledCheck?: boolean

                Skip stalled check for this worker. Note that other workers could still perform stalled checkd and move jobs back to wait for jobs being processed by this worker.

                Default

                false
                -

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                +

                Optional skipVersionCheck

                skipVersionCheck?: boolean

                Avoid version validation to be greater or equal than v5.0.0.

                Default Value

                false
                -

                Optional stalledInterval

                stalledInterval?: number

                Number of milliseconds between stallness checks.

                +

                Optional stalledInterval

                stalledInterval?: number

                Number of milliseconds between stallness checks.

                Default

                30000
                -

                Optional useWorkerThreads

                useWorkerThreads?: boolean

                Use Worker Threads instead of Child Processes. +

                Optional useWorkerThreads

                useWorkerThreads?: boolean

                Use Worker Threads instead of Child Processes. Note: This option can only be used when specifying a file for the processor argument.

                Default

                false
                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/modules/v1.html b/modules/v1.html index 677ea7aaaa..bbcc3a3aaf 100644 --- a/modules/v1.html +++ b/modules/v1.html @@ -1,4 +1,4 @@ -v1 | bullmq - v5.12.6

                Module v1

                Enumerations

                ChildCommand +v1 | bullmq - v5.12.7

                Module v1

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -131,4 +131,4 @@ tryCatch

                Type Aliases

                ActiveEventCallback3

                ActiveEventCallback3<T>: ((job, jobPromise?) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job, jobPromise?): void

                  • Parameters

                    Returns void

                BackoffFunction

                BackoffFunction: ((attemptsMade?, err?, job?) => number)

                Type declaration

                  • (attemptsMade?, err?, job?): number

                  • Parameters

                    • Optional attemptsMade: number
                    • Optional err: Error
                    • Optional job: Job

                    Returns number

                BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                CleanedEventCallback3

                CleanedEventCallback3<T>: ((jobs, status) => void)

                Type Parameters

                • T = any

                Type declaration

                ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                CompletedEventCallback3

                CompletedEventCallback3<T>: ((job, result) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job, result): void

                  • Parameters

                    • job: Job<T>
                    • result: any

                    Returns void

                ConnectionOptions

                ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

                EntryId

                EntryId: string

                EntryRaw

                EntryRaw: [EntryId, string[]]

                ErrorEventCallback3

                ErrorEventCallback3: ((error) => void)

                Type declaration

                  • (error): void

                  • Parameters

                    • error: Error

                    Returns void

                EventCallback3

                EventCallback3: (() => void)

                Type declaration

                  • (): void

                  • Returns void

                FailedEventCallback3

                FailedEventCallback3<T>: ((job, error) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job, error): void

                  • Parameters

                    • job: Job<T>
                    • error: Error

                    Returns void

                FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                FinishedStatus

                FinishedStatus: "completed" | "failed"

                FlowQueuesOpts

                FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

                JobData

                JobData: [JobJsonRaw | number, string?]

                JobJsonSandbox

                JobJsonSandbox: JobJson & {
                    prefix: string;
                    queueName: string;
                }

                Type declaration

                • prefix: string
                • queueName: string

                JobState

                JobState: FinishedStatus | "active" | "delayed" | "waiting" | "waiting-children"

                JobStatusClean3

                JobStatusClean3: "completed" | "wait" | "active" | "delayed" | "paused" | "failed"

                JobType

                JobType: JobState | "paused" | "repeat" | "wait"

                KeysMap

                KeysMap: {
                    [index in string]: string
                }

                MinimalQueue

                MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">

                ParentOpts

                ParentOpts: {
                    parentDependenciesKey?: string;
                    parentKey?: string;
                    waitChildrenKey?: string;
                }

                Type declaration

                • Optional parentDependenciesKey?: string
                • Optional parentKey?: string
                • Optional waitChildrenKey?: string

                Processor

                Processor<T, R, N>: ((job, token?) => Promise<R>)

                Type Parameters

                • T = any
                • R = any
                • N extends string = string

                Type declaration

                  • (job, token?): Promise<R>

                  • An async function that receives Jobs and handles them.

                    Parameters

                    • job: Job<T, R, N>
                    • Optional token: string

                    Returns Promise<R>

                ProgressEventCallback3

                ProgressEventCallback3<T>: ((job, progress) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job, progress): void

                  • Parameters

                    • job: Job<T>
                    • progress: any

                    Returns void

                RedisClient

                RedisClient: Redis | Cluster

                RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                RemovedEventCallback3

                RemovedEventCallback3<T>: ((job) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job): void

                  • Parameters

                    Returns void

                RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number)

                Type declaration

                  • (millis, opts, name?): number

                  • Parameters

                    Returns number

                SandboxedJobProcessor

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                  • (job): R | PromiseLike<R>

                  • Parameters

                    Returns R | PromiseLike<R>

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -

                StalledEventCallback3

                StalledEventCallback3<T>: ((job) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job): void

                  • Parameters

                    Returns void

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][]

                WaitingEventCallback3

                WaitingEventCallback3: ((jobId) => void)

                Type declaration

                  • (jobId): void

                  • Parameters

                    • jobId: string

                    Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                StalledEventCallback3

                StalledEventCallback3<T>: ((job) => void)

                Type Parameters

                • T = any

                Type declaration

                  • (job): void

                  • Parameters

                    Returns void

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][]

                WaitingEventCallback3

                WaitingEventCallback3: ((jobId) => void)

                Type declaration

                  • (jobId): void

                  • Parameters

                    • jobId: string

                    Returns void

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/modules/v2.html b/modules/v2.html index ec4ec637dc..6ce33524af 100644 --- a/modules/v2.html +++ b/modules/v2.html @@ -1,4 +1,4 @@ -v2 | bullmq - v5.12.6

                Module v2

                Enumerations

                ChildCommand +v2 | bullmq - v5.12.7

                Module v2

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -121,4 +121,4 @@

                Parameters

                • job: Job<T, R, N>
                • Optional token: string

                Returns Promise<R>

                RedisClient

                RedisClient: Redis | Cluster

                RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    fpof?: boolean;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                Type declaration

                • Optional fpof?: boolean

                  If true, moves parent to failed.

                RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number)

                Type declaration

                  • (millis, opts, name?): number

                  • Parameters

                    Returns number

                SandboxedJobProcessor

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                  • (job): R | PromiseLike<R>

                  • Parameters

                    Returns R | PromiseLike<R>

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][]

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][]

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/modules/v3.html b/modules/v3.html index 304d59763e..a6e816844c 100644 --- a/modules/v3.html +++ b/modules/v3.html @@ -1,4 +1,4 @@ -v3 | bullmq - v5.12.6

                Module v3

                Enumerations

                ChildCommand +v3 | bullmq - v5.12.7

                Module v3

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -124,4 +124,4 @@

                Type declaration

                • Optional fpof?: boolean

                  If true, moves parent to failed.

                • Optional kl?: number

                  Maximum amount of log entries that will be preserved

                RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number)

                Type declaration

                  • (millis, opts, name?): number

                  • Parameters

                    Returns number

                SandboxedJobProcessor

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                  • (job): R | PromiseLike<R>

                  • Parameters

                    Returns R | PromiseLike<R>

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                StreamName

                StreamName: string

                StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/modules/v4.html b/modules/v4.html index 83f33e8bd4..0d06791a62 100644 --- a/modules/v4.html +++ b/modules/v4.html @@ -1,4 +1,4 @@ -v4 | bullmq - v5.12.6

                Module v4

                Index

                Enumerations

                ChildCommand +v4 | bullmq - v5.12.7

                Module v4

                Index

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -124,4 +124,4 @@ raw2NextJobData removeAllQueueData tryCatch -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/modules/v5.html b/modules/v5.html index a48d9cfe2b..f26957c3e4 100644 --- a/modules/v5.html +++ b/modules/v5.html @@ -1,4 +1,4 @@ -v5 | bullmq - v5.12.6

                Module v5

                Index

                Enumerations

                ChildCommand +v5 | bullmq - v5.12.7

                Module v5

                Index

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -123,4 +123,4 @@ removeAllQueueData toString tryCatch -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.BackoffStrategy.html b/types/v4.BackoffStrategy.html index 05ad6546a9..3b60861b8e 100644 --- a/types/v4.BackoffStrategy.html +++ b/types/v4.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.12.6

                Type alias BackoffStrategy

                BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

                Type declaration

                  • (attemptsMade, type?, err?, job?): Promise<number> | number

                  • Parameters

                    • attemptsMade: number
                    • Optional type: string
                    • Optional err: Error
                    • Optional job: MinimalJob

                    Returns Promise<number> | number

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +BackoffStrategy | bullmq - v5.12.7

                Type alias BackoffStrategy

                BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

                Type declaration

                  • (attemptsMade, type?, err?, job?): Promise<number> | number

                  • Parameters

                    • attemptsMade: number
                    • Optional type: string
                    • Optional err: Error
                    • Optional job: MinimalJob

                    Returns Promise<number> | number

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.BulkJobOptions.html b/types/v4.BulkJobOptions.html index 2de06ce53b..3f3eaa7566 100644 --- a/types/v4.BulkJobOptions.html +++ b/types/v4.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.12.6

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +BulkJobOptions | bullmq - v5.12.7

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.ClusterOptions.html b/types/v4.ClusterOptions.html index 3cb7d00c04..ed71039a61 100644 --- a/types/v4.ClusterOptions.html +++ b/types/v4.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.12.6

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ClusterOptions | bullmq - v5.12.7

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.ConnectionOptions.html b/types/v4.ConnectionOptions.html index 5f99f9e3f0..66b77d9f87 100644 --- a/types/v4.ConnectionOptions.html +++ b/types/v4.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.12.6

                Type alias ConnectionOptions

                ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ConnectionOptions | bullmq - v5.12.7

                Type alias ConnectionOptions

                ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.EntryId.html b/types/v4.EntryId.html index 2f743b681b..ba583e9794 100644 --- a/types/v4.EntryId.html +++ b/types/v4.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.12.6

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +EntryId | bullmq - v5.12.7

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.EntryRaw.html b/types/v4.EntryRaw.html index d2872e03a7..f5d98112cd 100644 --- a/types/v4.EntryRaw.html +++ b/types/v4.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.12.6

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +EntryRaw | bullmq - v5.12.7

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.FinishedPropValAttribute.html b/types/v4.FinishedPropValAttribute.html index 111e2216ad..6b03e58d48 100644 --- a/types/v4.FinishedPropValAttribute.html +++ b/types/v4.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.12.6

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FinishedPropValAttribute | bullmq - v5.12.7

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.FinishedStatus.html b/types/v4.FinishedStatus.html index 3cb33016e3..ed35ff3901 100644 --- a/types/v4.FinishedStatus.html +++ b/types/v4.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.12.6

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FinishedStatus | bullmq - v5.12.7

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.FlowChildJob.html b/types/v4.FlowChildJob.html index 9477c06a0f..fc7728fa15 100644 --- a/types/v4.FlowChildJob.html +++ b/types/v4.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.12.6

                Type alias FlowChildJob

                FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowChildJob | bullmq - v5.12.7

                Type alias FlowChildJob

                FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.FlowJob.html b/types/v4.FlowJob.html index c669b580f6..d926f651f0 100644 --- a/types/v4.FlowJob.html +++ b/types/v4.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.12.6

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowJob | bullmq - v5.12.7

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.FlowQueuesOpts.html b/types/v4.FlowQueuesOpts.html index 80b35b0685..feac3c6b10 100644 --- a/types/v4.FlowQueuesOpts.html +++ b/types/v4.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.12.6

                Type alias FlowQueuesOpts

                FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowQueuesOpts | bullmq - v5.12.7

                Type alias FlowQueuesOpts

                FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.JobData.html b/types/v4.JobData.html index 0f53a82056..e51a2d4cbb 100644 --- a/types/v4.JobData.html +++ b/types/v4.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.12.6

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobData | bullmq - v5.12.7

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.JobJsonSandbox.html b/types/v4.JobJsonSandbox.html index 47576274cf..1aa393fb8d 100644 --- a/types/v4.JobJsonSandbox.html +++ b/types/v4.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.12.6

                Type alias JobJsonSandbox

                JobJsonSandbox: JobJson & {
                    prefix: string;
                    queueName: string;
                }

                Type declaration

                • prefix: string
                • queueName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobJsonSandbox | bullmq - v5.12.7

                Type alias JobJsonSandbox

                JobJsonSandbox: JobJson & {
                    prefix: string;
                    queueName: string;
                }

                Type declaration

                • prefix: string
                • queueName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.JobState.html b/types/v4.JobState.html index 3d9a42fd23..00a6865b06 100644 --- a/types/v4.JobState.html +++ b/types/v4.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.12.6

                Type alias JobState

                JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobState | bullmq - v5.12.7

                Type alias JobState

                JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.JobType.html b/types/v4.JobType.html index 3506309e8c..a8109fa384 100644 --- a/types/v4.JobType.html +++ b/types/v4.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.12.6

                Type alias JobType

                JobType: JobState | "paused" | "repeat" | "wait"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobType | bullmq - v5.12.7

                Type alias JobType

                JobType: JobState | "paused" | "repeat" | "wait"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.JobsOptions.html b/types/v4.JobsOptions.html index 8ef249fadf..2b682ef3cd 100644 --- a/types/v4.JobsOptions.html +++ b/types/v4.JobsOptions.html @@ -1,3 +1,3 @@ -JobsOptions | bullmq - v5.12.6

                Type alias JobsOptions

                JobsOptions: BaseJobOptions & {
                    failParentOnFailure?: boolean;
                    removeDependencyOnFailure?: boolean;
                }

                Type declaration

                • Optional failParentOnFailure?: boolean

                  If true, moves parent to failed.

                  +JobsOptions | bullmq - v5.12.7

                  Type alias JobsOptions

                  JobsOptions: BaseJobOptions & {
                      failParentOnFailure?: boolean;
                      removeDependencyOnFailure?: boolean;
                  }

                  Type declaration

                  • Optional failParentOnFailure?: boolean

                    If true, moves parent to failed.

                  • Optional removeDependencyOnFailure?: boolean

                    If true, removes the job from its parent dependencies when it fails after all attempts.

                    -

                  Settings

                  Member Visibility

                  Theme

                  Generated using TypeDoc

                  \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.KeysMap.html b/types/v4.KeysMap.html index f71293edd0..38fb00e01e 100644 --- a/types/v4.KeysMap.html +++ b/types/v4.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.12.6

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +KeysMap | bullmq - v5.12.7

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.MinimalQueue.html b/types/v4.MinimalQueue.html index bcbaf41157..44ca9a390a 100644 --- a/types/v4.MinimalQueue.html +++ b/types/v4.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.12.6

                Type alias MinimalQueue

                MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +MinimalQueue | bullmq - v5.12.7

                Type alias MinimalQueue

                MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.ParentOpts.html b/types/v4.ParentOpts.html index b93bcb1bd8..f93cce84b5 100644 --- a/types/v4.ParentOpts.html +++ b/types/v4.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.12.6

                Type alias ParentOpts

                ParentOpts: {
                    parentDependenciesKey?: string;
                    parentKey?: string;
                    waitChildrenKey?: string;
                }

                Type declaration

                • Optional parentDependenciesKey?: string
                • Optional parentKey?: string
                • Optional waitChildrenKey?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ParentOpts | bullmq - v5.12.7

                Type alias ParentOpts

                ParentOpts: {
                    parentDependenciesKey?: string;
                    parentKey?: string;
                    waitChildrenKey?: string;
                }

                Type declaration

                • Optional parentDependenciesKey?: string
                • Optional parentKey?: string
                • Optional waitChildrenKey?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.Processor.html b/types/v4.Processor.html index 133d90dfb6..d49f54ba4b 100644 --- a/types/v4.Processor.html +++ b/types/v4.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.12.6

                Type alias Processor<T, R, N>

                Processor<T, R, N>: ((job, token?) => Promise<R>)

                Type Parameters

                • T = any
                • R = any
                • N extends string = string

                Type declaration

                  • (job, token?): Promise<R>

                  • An async function that receives Jobs and handles them.

                    -

                    Parameters

                    • job: Job<T, R, N>
                    • Optional token: string

                    Returns Promise<R>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +Processor | bullmq - v5.12.7

                Type alias Processor<T, R, N>

                Processor<T, R, N>: ((job, token?) => Promise<R>)

                Type Parameters

                • T = any
                • R = any
                • N extends string = string

                Type declaration

                  • (job, token?): Promise<R>

                  • An async function that receives Jobs and handles them.

                    +

                    Parameters

                    • job: Job<T, R, N>
                    • Optional token: string

                    Returns Promise<R>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.RedisClient.html b/types/v4.RedisClient.html index c567ee37b9..833ce95cba 100644 --- a/types/v4.RedisClient.html +++ b/types/v4.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.12.6

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RedisClient | bullmq - v5.12.7

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.RedisJobOptions.html b/types/v4.RedisJobOptions.html index 3e5c48b9b1..f93bf2f3b2 100644 --- a/types/v4.RedisJobOptions.html +++ b/types/v4.RedisJobOptions.html @@ -1,5 +1,5 @@ -RedisJobOptions | bullmq - v5.12.6

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    fpof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                +RedisJobOptions | bullmq - v5.12.7

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    fpof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                Type declaration

                • Optional fpof?: boolean

                  If true, moves parent to failed.

                • Optional kl?: number

                  Maximum amount of log entries that will be preserved

                • Optional rdof?: boolean

                  If true, removes the job from its parent dependencies when it fails after all attempts.

                  -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.RedisOptions.html b/types/v4.RedisOptions.html index 5b2ae97827..9cf6a62ee9 100644 --- a/types/v4.RedisOptions.html +++ b/types/v4.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.12.6

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RedisOptions | bullmq - v5.12.7

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.RepeatStrategy.html b/types/v4.RepeatStrategy.html index 36659e4a43..878f535ab0 100644 --- a/types/v4.RepeatStrategy.html +++ b/types/v4.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.12.6

                Type alias RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

                Type declaration

                  • (millis, opts, name?): number | undefined | Promise<number | undefined>

                  • Parameters

                    Returns number | undefined | Promise<number | undefined>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RepeatStrategy | bullmq - v5.12.7

                Type alias RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

                Type declaration

                  • (millis, opts, name?): number | undefined | Promise<number | undefined>

                  • Parameters

                    Returns number | undefined | Promise<number | undefined>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.RepeatableJob.html b/types/v4.RepeatableJob.html index 9565e2622b..62b8d3c87c 100644 --- a/types/v4.RepeatableJob.html +++ b/types/v4.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.12.6

                Type alias RepeatableJob

                RepeatableJob: {
                    endDate: number | null;
                    id: string | null;
                    key: string;
                    name: string;
                    next: number;
                    pattern: string;
                    tz: string | null;
                }

                Type declaration

                • endDate: number | null
                • id: string | null
                • key: string
                • name: string
                • next: number
                • pattern: string
                • tz: string | null

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RepeatableJob | bullmq - v5.12.7

                Type alias RepeatableJob

                RepeatableJob: {
                    endDate: number | null;
                    id: string | null;
                    key: string;
                    name: string;
                    next: number;
                    pattern: string;
                    tz: string | null;
                }

                Type declaration

                • endDate: number | null
                • id: string | null
                • key: string
                • name: string
                • next: number
                • pattern: string
                • tz: string | null

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.SandboxedJobProcessor.html b/types/v4.SandboxedJobProcessor.html index 049a1bf9e1..4d3e092bb7 100644 --- a/types/v4.SandboxedJobProcessor.html +++ b/types/v4.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.12.6

                Type alias SandboxedJobProcessor<T, R>

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                  • (job): R | PromiseLike<R>

                  • Parameters

                    Returns R | PromiseLike<R>

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +SandboxedJobProcessor | bullmq - v5.12.7

                Type alias SandboxedJobProcessor<T, R>

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                  • (job): R | PromiseLike<R>

                  • Parameters

                    Returns R | PromiseLike<R>

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.StreamName.html b/types/v4.StreamName.html index eb625d7d5c..786add399f 100644 --- a/types/v4.StreamName.html +++ b/types/v4.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.12.6

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +StreamName | bullmq - v5.12.7

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v4.StreamReadRaw.html b/types/v4.StreamReadRaw.html index 0ce9450e01..a2f4093a97 100644 --- a/types/v4.StreamReadRaw.html +++ b/types/v4.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.12.6

                Type alias StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +StreamReadRaw | bullmq - v5.12.7

                Type alias StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.BackoffStrategy.html b/types/v5.BackoffStrategy.html index 3a99e57b9b..7d59569a65 100644 --- a/types/v5.BackoffStrategy.html +++ b/types/v5.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.12.6

                Type alias BackoffStrategy

                BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

                Type declaration

                  • (attemptsMade, type?, err?, job?): Promise<number> | number

                  • Parameters

                    • attemptsMade: number
                    • Optional type: string
                    • Optional err: Error
                    • Optional job: MinimalJob

                    Returns Promise<number> | number

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +BackoffStrategy | bullmq - v5.12.7

                Type alias BackoffStrategy

                BackoffStrategy: ((attemptsMade, type?, err?, job?) => Promise<number> | number)

                Type declaration

                  • (attemptsMade, type?, err?, job?): Promise<number> | number

                  • Parameters

                    • attemptsMade: number
                    • Optional type: string
                    • Optional err: Error
                    • Optional job: MinimalJob

                    Returns Promise<number> | number

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.BulkJobOptions.html b/types/v5.BulkJobOptions.html index cb6075fef7..4386802ceb 100644 --- a/types/v5.BulkJobOptions.html +++ b/types/v5.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.12.6

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +BulkJobOptions | bullmq - v5.12.7

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.ClusterOptions.html b/types/v5.ClusterOptions.html index 902b8ba16f..07ec873c98 100644 --- a/types/v5.ClusterOptions.html +++ b/types/v5.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.12.6

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ClusterOptions | bullmq - v5.12.7

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.ConnectionOptions.html b/types/v5.ConnectionOptions.html index 333483dda8..de97c508b9 100644 --- a/types/v5.ConnectionOptions.html +++ b/types/v5.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.12.6

                Type alias ConnectionOptions

                ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ConnectionOptions | bullmq - v5.12.7

                Type alias ConnectionOptions

                ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.EntryId.html b/types/v5.EntryId.html index 20a488cfd4..d339c3b837 100644 --- a/types/v5.EntryId.html +++ b/types/v5.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.12.6

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +EntryId | bullmq - v5.12.7

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.EntryRaw.html b/types/v5.EntryRaw.html index 468c80f676..9b6ce7146c 100644 --- a/types/v5.EntryRaw.html +++ b/types/v5.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.12.6

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +EntryRaw | bullmq - v5.12.7

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.FinishedPropValAttribute.html b/types/v5.FinishedPropValAttribute.html index 4c5f4860a2..493ee7b072 100644 --- a/types/v5.FinishedPropValAttribute.html +++ b/types/v5.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.12.6

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FinishedPropValAttribute | bullmq - v5.12.7

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.FinishedStatus.html b/types/v5.FinishedStatus.html index 5b84b78594..f079ad7eb0 100644 --- a/types/v5.FinishedStatus.html +++ b/types/v5.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.12.6

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FinishedStatus | bullmq - v5.12.7

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.FlowChildJob.html b/types/v5.FlowChildJob.html index 081cb3b3b9..e8b6255c9b 100644 --- a/types/v5.FlowChildJob.html +++ b/types/v5.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.12.6

                Type alias FlowChildJob

                FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowChildJob | bullmq - v5.12.7

                Type alias FlowChildJob

                FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.FlowJob.html b/types/v5.FlowJob.html index 9008b2dd58..baa4c0c336 100644 --- a/types/v5.FlowJob.html +++ b/types/v5.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.12.6

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowJob | bullmq - v5.12.7

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.FlowQueuesOpts.html b/types/v5.FlowQueuesOpts.html index d22ecadeff..174b29f0ec 100644 --- a/types/v5.FlowQueuesOpts.html +++ b/types/v5.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.12.6

                Type alias FlowQueuesOpts

                FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FlowQueuesOpts | bullmq - v5.12.7

                Type alias FlowQueuesOpts

                FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.JobData.html b/types/v5.JobData.html index 18442fa6d7..ada51505f1 100644 --- a/types/v5.JobData.html +++ b/types/v5.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.12.6

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobData | bullmq - v5.12.7

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.JobJsonSandbox.html b/types/v5.JobJsonSandbox.html index 95a4b80be4..5cec509760 100644 --- a/types/v5.JobJsonSandbox.html +++ b/types/v5.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.12.6

                Type alias JobJsonSandbox

                JobJsonSandbox: JobJson & {
                    prefix: string;
                    queueName: string;
                }

                Type declaration

                • prefix: string
                • queueName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobJsonSandbox | bullmq - v5.12.7

                Type alias JobJsonSandbox

                JobJsonSandbox: JobJson & {
                    prefix: string;
                    queueName: string;
                }

                Type declaration

                • prefix: string
                • queueName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.JobState.html b/types/v5.JobState.html index bf9dbdc542..65819b9ea1 100644 --- a/types/v5.JobState.html +++ b/types/v5.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.12.6

                Type alias JobState

                JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobState | bullmq - v5.12.7

                Type alias JobState

                JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.JobType.html b/types/v5.JobType.html index f316352bd5..1691581afb 100644 --- a/types/v5.JobType.html +++ b/types/v5.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.12.6

                Type alias JobType

                JobType: JobState | "paused" | "repeat" | "wait"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +JobType | bullmq - v5.12.7

                Type alias JobType

                JobType: JobState | "paused" | "repeat" | "wait"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.JobsOptions.html b/types/v5.JobsOptions.html index 6eb9b34cee..b6eca32b46 100644 --- a/types/v5.JobsOptions.html +++ b/types/v5.JobsOptions.html @@ -1,5 +1,5 @@ -JobsOptions | bullmq - v5.12.6

                Type alias JobsOptions

                JobsOptions: BaseJobOptions & {
                    debounce?: DebounceOptions;
                    failParentOnFailure?: boolean;
                    ignoreDependencyOnFailure?: boolean;
                    removeDependencyOnFailure?: boolean;
                }

                Type declaration

                • Optional debounce?: DebounceOptions

                  Debounce options.

                  +JobsOptions | bullmq - v5.12.7

                  Type alias JobsOptions

                  JobsOptions: BaseJobOptions & {
                      debounce?: DebounceOptions;
                      failParentOnFailure?: boolean;
                      ignoreDependencyOnFailure?: boolean;
                      removeDependencyOnFailure?: boolean;
                  }

                  Type declaration

                  • Optional debounce?: DebounceOptions

                    Debounce options.

                  • Optional failParentOnFailure?: boolean

                    If true, moves parent to failed.

                  • Optional ignoreDependencyOnFailure?: boolean

                    If true, moves the jobId from its parent dependencies to failed dependencies when it fails after all attempts.

                  • Optional removeDependencyOnFailure?: boolean

                    If true, removes the job from its parent dependencies when it fails after all attempts.

                    -

                  Settings

                  Member Visibility

                  Theme

                  Generated using TypeDoc

                  \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.KeysMap.html b/types/v5.KeysMap.html index e90490cbe1..733b3a9cbb 100644 --- a/types/v5.KeysMap.html +++ b/types/v5.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.12.6

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +KeysMap | bullmq - v5.12.7

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.MinimalQueue.html b/types/v5.MinimalQueue.html index cdcfcd5fc9..c38211522c 100644 --- a/types/v5.MinimalQueue.html +++ b/types/v5.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.12.6

                Type alias MinimalQueue

                MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +MinimalQueue | bullmq - v5.12.7

                Type alias MinimalQueue

                MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.ParentOpts.html b/types/v5.ParentOpts.html index 4187746912..bff1acace0 100644 --- a/types/v5.ParentOpts.html +++ b/types/v5.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.12.6

                Type alias ParentOpts

                ParentOpts: {
                    parentDependenciesKey?: string;
                    parentKey?: string;
                    waitChildrenKey?: string;
                }

                Type declaration

                • Optional parentDependenciesKey?: string
                • Optional parentKey?: string
                • Optional waitChildrenKey?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ParentOpts | bullmq - v5.12.7

                Type alias ParentOpts

                ParentOpts: {
                    parentDependenciesKey?: string;
                    parentKey?: string;
                    waitChildrenKey?: string;
                }

                Type declaration

                • Optional parentDependenciesKey?: string
                • Optional parentKey?: string
                • Optional waitChildrenKey?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.Processor.html b/types/v5.Processor.html index 2dad967320..a41a3cefa1 100644 --- a/types/v5.Processor.html +++ b/types/v5.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.12.6

                Type alias Processor<T, R, N>

                Processor<T, R, N>: ((job, token?) => Promise<R>)

                An async function that receives Jobs and handles them.

                -

                Type Parameters

                • T = any
                • R = any
                • N extends string = string

                Type declaration

                  • (job, token?): Promise<R>

                  • Parameters

                    • job: Job<T, R, N>
                    • Optional token: string

                    Returns Promise<R>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +Processor | bullmq - v5.12.7

                Type alias Processor<T, R, N>

                Processor<T, R, N>: ((job, token?) => Promise<R>)

                An async function that receives Jobs and handles them.

                +

                Type Parameters

                • T = any
                • R = any
                • N extends string = string

                Type declaration

                  • (job, token?): Promise<R>

                  • Parameters

                    • job: Job<T, R, N>
                    • Optional token: string

                    Returns Promise<R>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RedisClient.html b/types/v5.RedisClient.html index 9311f03419..366a40a537 100644 --- a/types/v5.RedisClient.html +++ b/types/v5.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.12.6

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RedisClient | bullmq - v5.12.7

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RedisJobOptions.html b/types/v5.RedisJobOptions.html index 7b62c63468..d3f04246d9 100644 --- a/types/v5.RedisJobOptions.html +++ b/types/v5.RedisJobOptions.html @@ -1,7 +1,7 @@ -RedisJobOptions | bullmq - v5.12.6

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    deid?: string;
                    fpof?: boolean;
                    idof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                +RedisJobOptions | bullmq - v5.12.7

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    deid?: string;
                    fpof?: boolean;
                    idof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                Type declaration

                • Optional deid?: string

                  Debounce identifier.

                • Optional fpof?: boolean

                  If true, moves parent to failed.

                • Optional idof?: boolean

                  If true, moves the jobId from its parent dependencies to failed dependencies when it fails after all attempts.

                • Optional kl?: number

                  Maximum amount of log entries that will be preserved

                • Optional rdof?: boolean

                  If true, removes the job from its parent dependencies when it fails after all attempts.

                  -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RedisOptions.html b/types/v5.RedisOptions.html index 335f536728..cebfc9c8d8 100644 --- a/types/v5.RedisOptions.html +++ b/types/v5.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.12.6

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RedisOptions | bullmq - v5.12.7

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RepeatStrategy.html b/types/v5.RepeatStrategy.html index fd65077a15..9f83f1b1c9 100644 --- a/types/v5.RepeatStrategy.html +++ b/types/v5.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.12.6

                Type alias RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

                Type declaration

                  • (millis, opts, name?): number | undefined | Promise<number | undefined>

                  • Parameters

                    Returns number | undefined | Promise<number | undefined>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RepeatStrategy | bullmq - v5.12.7

                Type alias RepeatStrategy

                RepeatStrategy: ((millis, opts, name?) => number | undefined | Promise<number | undefined>)

                Type declaration

                  • (millis, opts, name?): number | undefined | Promise<number | undefined>

                  • Parameters

                    Returns number | undefined | Promise<number | undefined>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RepeatableJob.html b/types/v5.RepeatableJob.html index 39f312a319..a3e1c3231b 100644 --- a/types/v5.RepeatableJob.html +++ b/types/v5.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.12.6

                Type alias RepeatableJob

                RepeatableJob: {
                    endDate: number | null;
                    every?: string | null;
                    id?: string | null;
                    key: string;
                    name: string;
                    next: number;
                    pattern: string | null;
                    tz: string | null;
                }

                Type declaration

                • endDate: number | null
                • Optional every?: string | null
                • Optional id?: string | null
                • key: string
                • name: string
                • next: number
                • pattern: string | null
                • tz: string | null

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RepeatableJob | bullmq - v5.12.7

                Type alias RepeatableJob

                RepeatableJob: {
                    endDate: number | null;
                    every?: string | null;
                    id?: string | null;
                    key: string;
                    name: string;
                    next: number;
                    pattern: string | null;
                    tz: string | null;
                }

                Type declaration

                • endDate: number | null
                • Optional every?: string | null
                • Optional id?: string | null
                • key: string
                • name: string
                • next: number
                • pattern: string | null
                • tz: string | null

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.RepeatableOptions.html b/types/v5.RepeatableOptions.html index f34d4dca8f..9f46fd209f 100644 --- a/types/v5.RepeatableOptions.html +++ b/types/v5.RepeatableOptions.html @@ -1 +1 @@ -RepeatableOptions | bullmq - v5.12.6

                Type alias RepeatableOptions

                RepeatableOptions: {
                    endDate?: number;
                    every?: number;
                    name: string;
                    pattern?: string;
                    tz?: string;
                }

                Type declaration

                • Optional endDate?: number
                • Optional every?: number
                • name: string
                • Optional pattern?: string
                • Optional tz?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RepeatableOptions | bullmq - v5.12.7

                Type alias RepeatableOptions

                RepeatableOptions: {
                    endDate?: number;
                    every?: number;
                    name: string;
                    pattern?: string;
                    tz?: string;
                }

                Type declaration

                • Optional endDate?: number
                • Optional every?: number
                • name: string
                • Optional pattern?: string
                • Optional tz?: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.SandboxedJobProcessor.html b/types/v5.SandboxedJobProcessor.html index 6a7c2394e0..32d4c68589 100644 --- a/types/v5.SandboxedJobProcessor.html +++ b/types/v5.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.12.6

                Type alias SandboxedJobProcessor<T, R>

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +SandboxedJobProcessor | bullmq - v5.12.7

                Type alias SandboxedJobProcessor<T, R>

                SandboxedJobProcessor<T, R>: ((job) => R | PromiseLike<R>) | ((job, callback) => void)

                Type Parameters

                • T = any
                • R = any

                Type declaration

                Type declaration

                  • (job, callback): void

                  • Parameters

                    • job: SandboxedJob<T, R>
                    • callback: ((error, result) => void)
                        • (error, result): void

                        • Parameters

                          • error: unknown
                          • result: R

                          Returns void

                    Returns void

                See

                https://docs.bullmq.io/guide/workers/sandboxed-processors

                +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.StreamName.html b/types/v5.StreamName.html index a75cef603c..689194b09b 100644 --- a/types/v5.StreamName.html +++ b/types/v5.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.12.6

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +StreamName | bullmq - v5.12.7

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.StreamReadRaw.html b/types/v5.StreamReadRaw.html index a59a150171..e3b1831bcf 100644 --- a/types/v5.StreamReadRaw.html +++ b/types/v5.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.12.6

                Type alias StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +StreamReadRaw | bullmq - v5.12.7

                Type alias StreamReadRaw

                StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.DELAY_TIME_1.html b/variables/v1.DELAY_TIME_1.html index 9e667e90da..5c3fbc6b89 100644 --- a/variables/v1.DELAY_TIME_1.html +++ b/variables/v1.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.6

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.12.7

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.DELAY_TIME_5.html b/variables/v1.DELAY_TIME_5.html index e708004ba3..3d6c81757e 100644 --- a/variables/v1.DELAY_TIME_5.html +++ b/variables/v1.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.6

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.12.7

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.QUEUE_EVENT_SUFFIX.html b/variables/v1.QUEUE_EVENT_SUFFIX.html index cf2ae6b44c..3834c05977 100644 --- a/variables/v1.QUEUE_EVENT_SUFFIX.html +++ b/variables/v1.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.QUEUE_SCHEDULER_SUFFIX.html b/variables/v1.QUEUE_SCHEDULER_SUFFIX.html index 56b5a2c0f4..88f83d7ff2 100644 --- a/variables/v1.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v1.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_SCHEDULER_SUFFIXConst

                QUEUE_SCHEDULER_SUFFIX: ":qs" = ':qs'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_SCHEDULER_SUFFIXConst

                QUEUE_SCHEDULER_SUFFIX: ":qs" = ':qs'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.WORKER_SUFFIX.html b/variables/v1.WORKER_SUFFIX.html index ed63e63c5e..04635ed6be 100644 --- a/variables/v1.WORKER_SUFFIX.html +++ b/variables/v1.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.6

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.7

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.clientCommandMessageReg.html b/variables/v1.clientCommandMessageReg.html index eca0397c59..46d30412f8 100644 --- a/variables/v1.clientCommandMessageReg.html +++ b/variables/v1.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.6

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.7

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.errorObject.html b/variables/v1.errorObject.html index 255b1cf183..78b37ccf9e 100644 --- a/variables/v1.errorObject.html +++ b/variables/v1.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.6

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +errorObject | bullmq - v5.12.7

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v1.scriptLoader-1.html b/variables/v1.scriptLoader-1.html index 75751e6fb1..68bf516235 100644 --- a/variables/v1.scriptLoader-1.html +++ b/variables/v1.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.6

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.7

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.DELAY_TIME_1.html b/variables/v2.DELAY_TIME_1.html index 95a93d5cd8..bb39d89405 100644 --- a/variables/v2.DELAY_TIME_1.html +++ b/variables/v2.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.6

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.12.7

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.DELAY_TIME_5.html b/variables/v2.DELAY_TIME_5.html index 6697853f8b..61f9ef24c4 100644 --- a/variables/v2.DELAY_TIME_5.html +++ b/variables/v2.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.6

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.12.7

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.QUEUE_EVENT_SUFFIX.html b/variables/v2.QUEUE_EVENT_SUFFIX.html index 337ce2cbde..4a088745fa 100644 --- a/variables/v2.QUEUE_EVENT_SUFFIX.html +++ b/variables/v2.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.QUEUE_SCHEDULER_SUFFIX.html b/variables/v2.QUEUE_SCHEDULER_SUFFIX.html index 7071e50352..967dbb669e 100644 --- a/variables/v2.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v2.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_SCHEDULER_SUFFIXConst

                QUEUE_SCHEDULER_SUFFIX: ":qs" = ':qs'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_SCHEDULER_SUFFIXConst

                QUEUE_SCHEDULER_SUFFIX: ":qs" = ':qs'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.WORKER_SUFFIX.html b/variables/v2.WORKER_SUFFIX.html index fa9f2df2f1..967783f465 100644 --- a/variables/v2.WORKER_SUFFIX.html +++ b/variables/v2.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.6

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.7

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.clientCommandMessageReg.html b/variables/v2.clientCommandMessageReg.html index a54e771589..72ed8e370a 100644 --- a/variables/v2.clientCommandMessageReg.html +++ b/variables/v2.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.6

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.7

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.errorObject.html b/variables/v2.errorObject.html index 1dbabe559f..8c6085dac2 100644 --- a/variables/v2.errorObject.html +++ b/variables/v2.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.6

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +errorObject | bullmq - v5.12.7

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v2.scriptLoader-1.html b/variables/v2.scriptLoader-1.html index 914e358aea..05efa964b3 100644 --- a/variables/v2.scriptLoader-1.html +++ b/variables/v2.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.6

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.7

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.DELAY_TIME_1.html b/variables/v3.DELAY_TIME_1.html index a9b448c203..5c2fa43995 100644 --- a/variables/v3.DELAY_TIME_1.html +++ b/variables/v3.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.6

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.12.7

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.DELAY_TIME_5.html b/variables/v3.DELAY_TIME_5.html index 5ae55fe9d8..b98edf1ca9 100644 --- a/variables/v3.DELAY_TIME_5.html +++ b/variables/v3.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.6

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.12.7

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.QUEUE_EVENT_SUFFIX.html b/variables/v3.QUEUE_EVENT_SUFFIX.html index 951f72c9da..babec62225 100644 --- a/variables/v3.QUEUE_EVENT_SUFFIX.html +++ b/variables/v3.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.WORKER_SUFFIX.html b/variables/v3.WORKER_SUFFIX.html index 4198710f52..64b121e287 100644 --- a/variables/v3.WORKER_SUFFIX.html +++ b/variables/v3.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.6

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.7

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.clientCommandMessageReg.html b/variables/v3.clientCommandMessageReg.html index 07c8e50124..3130a2d83a 100644 --- a/variables/v3.clientCommandMessageReg.html +++ b/variables/v3.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.6

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.7

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.errorObject.html b/variables/v3.errorObject.html index 69fbfa61ca..20bfcb978e 100644 --- a/variables/v3.errorObject.html +++ b/variables/v3.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.6

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +errorObject | bullmq - v5.12.7

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v3.scriptLoader-1.html b/variables/v3.scriptLoader-1.html index 0d01e5284f..560dd35d13 100644 --- a/variables/v3.scriptLoader-1.html +++ b/variables/v3.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.6

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.7

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.DELAY_TIME_1.html b/variables/v4.DELAY_TIME_1.html index 2e2f62b267..95ec98ad69 100644 --- a/variables/v4.DELAY_TIME_1.html +++ b/variables/v4.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.6

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.12.7

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.DELAY_TIME_5.html b/variables/v4.DELAY_TIME_5.html index 4a733070f6..cd154c0d5a 100644 --- a/variables/v4.DELAY_TIME_5.html +++ b/variables/v4.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.6

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.12.7

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.PRIORITY_LIMIT.html b/variables/v4.PRIORITY_LIMIT.html index a45cc8ea52..2ef1547f2b 100644 --- a/variables/v4.PRIORITY_LIMIT.html +++ b/variables/v4.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.12.6

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +PRIORITY_LIMIT | bullmq - v5.12.7

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.QUEUE_EVENT_SUFFIX.html b/variables/v4.QUEUE_EVENT_SUFFIX.html index 8292d5f1b2..e216923b39 100644 --- a/variables/v4.QUEUE_EVENT_SUFFIX.html +++ b/variables/v4.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.RATE_LIMIT_ERROR.html b/variables/v4.RATE_LIMIT_ERROR.html index 1c1d09ae49..64fd35471e 100644 --- a/variables/v4.RATE_LIMIT_ERROR.html +++ b/variables/v4.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.12.6

                Variable RATE_LIMIT_ERRORConst

                RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RATE_LIMIT_ERROR | bullmq - v5.12.7

                Variable RATE_LIMIT_ERRORConst

                RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.WORKER_SUFFIX.html b/variables/v4.WORKER_SUFFIX.html index db0faf0987..158fed8e69 100644 --- a/variables/v4.WORKER_SUFFIX.html +++ b/variables/v4.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.6

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.7

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.clientCommandMessageReg.html b/variables/v4.clientCommandMessageReg.html index db11838991..7d14dea66d 100644 --- a/variables/v4.clientCommandMessageReg.html +++ b/variables/v4.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.6

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.7

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.errorObject.html b/variables/v4.errorObject.html index 34ee55b6a2..d1573827dc 100644 --- a/variables/v4.errorObject.html +++ b/variables/v4.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.6

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +errorObject | bullmq - v5.12.7

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v4.scriptLoader-1.html b/variables/v4.scriptLoader-1.html index 168a50f827..2cb70c8789 100644 --- a/variables/v4.scriptLoader-1.html +++ b/variables/v4.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.6

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.7

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.DELAY_TIME_1.html b/variables/v5.DELAY_TIME_1.html index d9e3843b7f..8f85aafa3e 100644 --- a/variables/v5.DELAY_TIME_1.html +++ b/variables/v5.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.6

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_1 | bullmq - v5.12.7

                Variable DELAY_TIME_1Const

                DELAY_TIME_1: 100 = 100

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.DELAY_TIME_5.html b/variables/v5.DELAY_TIME_5.html index e79d81b4b2..30b4aa50fc 100644 --- a/variables/v5.DELAY_TIME_5.html +++ b/variables/v5.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.6

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +DELAY_TIME_5 | bullmq - v5.12.7

                Variable DELAY_TIME_5Const

                DELAY_TIME_5: 5000 = 5000

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.PRIORITY_LIMIT.html b/variables/v5.PRIORITY_LIMIT.html index 27320f3668..4e43a68c72 100644 --- a/variables/v5.PRIORITY_LIMIT.html +++ b/variables/v5.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.12.6

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +PRIORITY_LIMIT | bullmq - v5.12.7

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.QUEUE_EVENT_SUFFIX.html b/variables/v5.QUEUE_EVENT_SUFFIX.html index 0f176e383d..55e2ab617f 100644 --- a/variables/v5.QUEUE_EVENT_SUFFIX.html +++ b/variables/v5.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.6

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +QUEUE_EVENT_SUFFIX | bullmq - v5.12.7

                Variable QUEUE_EVENT_SUFFIXConst

                QUEUE_EVENT_SUFFIX: ":qe" = ':qe'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.RATE_LIMIT_ERROR.html b/variables/v5.RATE_LIMIT_ERROR.html index ef10cb60c8..7175766352 100644 --- a/variables/v5.RATE_LIMIT_ERROR.html +++ b/variables/v5.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.12.6

                Variable RATE_LIMIT_ERRORConst

                RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RATE_LIMIT_ERROR | bullmq - v5.12.7

                Variable RATE_LIMIT_ERRORConst

                RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.clientCommandMessageReg.html b/variables/v5.clientCommandMessageReg.html index 54dde2184d..fa869e850b 100644 --- a/variables/v5.clientCommandMessageReg.html +++ b/variables/v5.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.6

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +clientCommandMessageReg | bullmq - v5.12.7

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/v5.errorObject.html b/variables/v5.errorObject.html index 404b760839..72489ecce1 100644 --- a/variables/v5.errorObject.html +++ b/variables/v5.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.6

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +errorObject | bullmq - v5.12.7

                Variable errorObjectConst

                errorObject: {
                    [index: string]: any;
                } = ...

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file