From 14e2d7b2b44543a48219a0472215b7bbd433db0a Mon Sep 17 00:00:00 2001 From: manast Date: Mon, 12 Aug 2024 08:30:20 +0000 Subject: [PATCH] deploy: 8468e44e5e9e39c7b65691945c26688a9e5d2275 --- 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 02bf0c16ae..5661f1071e 100644 --- a/classes/v1.Backoffs.html +++ b/classes/v1.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.2

Class Backoffs

Constructors

constructor +Backoffs | bullmq - v5.12.3

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 5588d52dc2..20de883c57 100644 --- a/classes/v1.ChildPool.html +++ b/classes/v1.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.2

Class ChildPool

Constructors

constructor +ChildPool | bullmq - v5.12.3

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 755dd039b3..d61e705818 100644 --- a/classes/v1.ChildProcessor.html +++ b/classes/v1.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.2

Class ChildProcessor

ChildProcessor

+ChildProcessor | bullmq - v5.12.3

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 48ec1fc778..44d57ec67b 100644 --- a/classes/v1.FlowProducer.html +++ b/classes/v1.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.2

Class FlowProducer

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

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 8341989c03..1c2554c033 100644 --- a/classes/v1.Job.html +++ b/classes/v1.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.2

Class Job<DataType, ReturnType, NameType>

Job

+Job | bullmq - v5.12.3

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 350138e02c..541f93d2ab 100644 --- a/classes/v1.Queue.html +++ b/classes/v1.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.2

Class Queue<DataType, ResultType, NameType>

Queue

+Queue | bullmq - v5.12.3

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 2bf55686c7..f779c99030 100644 --- a/classes/v1.Queue3.html +++ b/classes/v1.Queue3.html @@ -1,4 +1,4 @@ -Queue3 | bullmq - v5.12.2

Class Queue3<T>

Deprecated

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

+Queue3 | bullmq - v5.12.3

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 71be55f15b..66d2d0493e 100644 --- a/classes/v1.QueueBase.html +++ b/classes/v1.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.2

Class QueueBase

Description

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

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 516a877165..b374065f58 100644 --- a/classes/v1.QueueEvents.html +++ b/classes/v1.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.2

    Class QueueEvents

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

    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 3d06708769..294425ecfd 100644 --- a/classes/v1.QueueGetters.html +++ b/classes/v1.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.2

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.3

    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 c93a89b8f9..e3e05f45c8 100644 --- a/classes/v1.QueueKeys.html +++ b/classes/v1.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.2

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.3

    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 fb5a5c7fb1..f22d6832c1 100644 --- a/classes/v1.QueueScheduler.html +++ b/classes/v1.QueueScheduler.html @@ -1,4 +1,4 @@ -QueueScheduler | bullmq - v5.12.2

    Class QueueScheduler

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

    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 1ed80575b4..c753f6442f 100644 --- a/classes/v1.RedisConnection.html +++ b/classes/v1.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.2

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.3

    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 02853fe2d1..6308a8452e 100644 --- a/classes/v1.Repeat.html +++ b/classes/v1.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.2

    Class Repeat

    Description

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

    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 93c0b8cee8..e8c081c34e 100644 --- a/classes/v1.ScriptLoader.html +++ b/classes/v1.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.2

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.3

    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 6547a44044..db1c452a25 100644 --- a/classes/v1.ScriptLoaderError.html +++ b/classes/v1.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.12.2

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.3

    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 40d644663d..c1d40659af 100644 --- a/classes/v1.Scripts.html +++ b/classes/v1.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.2

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.3

    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 35f48612a2..343bb23837 100644 --- a/classes/v1.TimerManager.html +++ b/classes/v1.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.12.2

    Class TimerManager

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

    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 f1383d6f55..c103dbdff0 100644 --- a/classes/v1.UnrecoverableError.html +++ b/classes/v1.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.2

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.3

    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 7790e08e5a..f5bc2ca4ca 100644 --- a/classes/v1.Worker.html +++ b/classes/v1.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.2

    Class Worker<DataType, ResultType, NameType>

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

    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 5392161dd9..e4e4d4c48b 100644 --- a/classes/v2.Backoffs.html +++ b/classes/v2.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.2

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.3

    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 42e4ebab3c..fd7b028db5 100644 --- a/classes/v2.ChildPool.html +++ b/classes/v2.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.2

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.3

    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 ec041af32e..0d367b9d02 100644 --- a/classes/v2.ChildProcessor.html +++ b/classes/v2.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.2

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.3

    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 9e3a0629c8..f7b8add81e 100644 --- a/classes/v2.FlowProducer.html +++ b/classes/v2.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.2

    Class FlowProducer

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

    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 a525107c53..eb0d9d1f8f 100644 --- a/classes/v2.Job.html +++ b/classes/v2.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.2

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.3

    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 42dba87dc8..507f4f9a2e 100644 --- a/classes/v2.Queue.html +++ b/classes/v2.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.2

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.3

    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 d725aef6a9..539d6ee147 100644 --- a/classes/v2.QueueBase.html +++ b/classes/v2.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.2

    Class QueueBase

    Description

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

    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 22a7e15ac9..011bcb813b 100644 --- a/classes/v2.QueueEvents.html +++ b/classes/v2.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.2

    Class QueueEvents

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

    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 0704f87485..c7fee6ce94 100644 --- a/classes/v2.QueueGetters.html +++ b/classes/v2.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.2

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.3

    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 e51bbde08d..3a43e0ab54 100644 --- a/classes/v2.QueueKeys.html +++ b/classes/v2.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.2

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.3

    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 759d1398ce..12c403262f 100644 --- a/classes/v2.RedisConnection.html +++ b/classes/v2.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.2

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.3

    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 246daf35a5..5cf75eeeae 100644 --- a/classes/v2.Repeat.html +++ b/classes/v2.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.2

    Class Repeat

    Description

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

    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 0f2c44806e..4ccc848803 100644 --- a/classes/v2.ScriptLoader.html +++ b/classes/v2.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.2

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.3

    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 37c7783807..99efd35243 100644 --- a/classes/v2.ScriptLoaderError.html +++ b/classes/v2.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.12.2

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.3

    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 8c05113e1c..c86c8ed5c5 100644 --- a/classes/v2.Scripts.html +++ b/classes/v2.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.2

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.3

    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 fad277b227..55a20370bf 100644 --- a/classes/v2.TimerManager.html +++ b/classes/v2.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.12.2

    Class TimerManager

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

    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 9d0d879ecb..03f4b78c66 100644 --- a/classes/v2.UnrecoverableError.html +++ b/classes/v2.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.2

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.3

    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 5bceff4613..27506298bd 100644 --- a/classes/v2.Worker.html +++ b/classes/v2.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.2

    Class Worker<DataType, ResultType, NameType>

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

    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 ab87f92b68..7fe9e30fe2 100644 --- a/classes/v3.AsyncFifoQueue.html +++ b/classes/v3.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.2

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.3

    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 35db56f9b9..1fb59ce6b5 100644 --- a/classes/v3.Backoffs.html +++ b/classes/v3.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.2

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.3

    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 7e84744b84..6461a81d9e 100644 --- a/classes/v3.ChildPool.html +++ b/classes/v3.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.2

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.3

    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 b14e51f3cb..d98205c598 100644 --- a/classes/v3.ChildProcessor.html +++ b/classes/v3.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.2

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.3

    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 813f873b7f..e651af8987 100644 --- a/classes/v3.DelayedError.html +++ b/classes/v3.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.2

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.3

    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 fa663f3dd8..e6febb6322 100644 --- a/classes/v3.FlowProducer.html +++ b/classes/v3.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.2

    Class FlowProducer

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

    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 425e605b00..7acb26d4b7 100644 --- a/classes/v3.Job.html +++ b/classes/v3.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.2

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.3

    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 231ddd99f7..b5e8bb17b4 100644 --- a/classes/v3.Queue.html +++ b/classes/v3.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.2

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.3

    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 fad0fde114..a971985961 100644 --- a/classes/v3.QueueBase.html +++ b/classes/v3.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.2

    Class QueueBase

    Description

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

    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 23367ff2b6..4a0790034b 100644 --- a/classes/v3.QueueEvents.html +++ b/classes/v3.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.2

    Class QueueEvents

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

    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 904ea7b6a6..9382d0eeca 100644 --- a/classes/v3.QueueGetters.html +++ b/classes/v3.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.2

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.3

    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 d4ff05bd28..bb6c30d813 100644 --- a/classes/v3.QueueKeys.html +++ b/classes/v3.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.2

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.3

    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 5372a5f6c5..74d8ff81af 100644 --- a/classes/v3.RedisConnection.html +++ b/classes/v3.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.2

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.3

    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 169c6d7bf3..beb99d0db7 100644 --- a/classes/v3.Repeat.html +++ b/classes/v3.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.2

    Class Repeat

    Description

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

    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 99b9687349..a1dfe89f89 100644 --- a/classes/v3.ScriptLoader.html +++ b/classes/v3.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.2

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.3

    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 ab034f9d56..1498bd548a 100644 --- a/classes/v3.ScriptLoaderError.html +++ b/classes/v3.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.12.2

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.3

    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 5725945f96..811dff1a2b 100644 --- a/classes/v3.Scripts.html +++ b/classes/v3.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.2

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.3

    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 71d2322e50..cafb557db1 100644 --- a/classes/v3.UnrecoverableError.html +++ b/classes/v3.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.2

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.3

    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 da0eca3645..5aee8e68ab 100644 --- a/classes/v3.WaitingChildrenError.html +++ b/classes/v3.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.2

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.3

    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 0d75cbbee0..d32799d886 100644 --- a/classes/v3.Worker.html +++ b/classes/v3.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.2

    Class Worker<DataType, ResultType, NameType>

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

    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 96e53ae7c5..e82fb1e20a 100644 --- a/classes/v4.AsyncFifoQueue.html +++ b/classes/v4.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.2

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.3

    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 608b80c295..9833fc60ed 100644 --- a/classes/v4.Backoffs.html +++ b/classes/v4.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.2

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.3

    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 d3239dbee5..c6ccdabdf2 100644 --- a/classes/v4.ChildPool.html +++ b/classes/v4.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.2

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.3

    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 ed025d5116..5a73c0bcd7 100644 --- a/classes/v4.ChildProcessor.html +++ b/classes/v4.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.12.2

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.3

    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 9009f847b3..2c96ad6e57 100644 --- a/classes/v4.DelayedError.html +++ b/classes/v4.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.2

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.3

    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 cf67536f4b..a37429be48 100644 --- a/classes/v4.FlowProducer.html +++ b/classes/v4.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.12.2

    Class FlowProducer

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

    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 ff78e5379b..e908049ef0 100644 --- a/classes/v4.Job.html +++ b/classes/v4.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.12.2

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.3

    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 22e547e352..d2bc937c01 100644 --- a/classes/v4.Queue.html +++ b/classes/v4.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.12.2

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.3

    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 f4a5bbe7d6..e7394f905c 100644 --- a/classes/v4.QueueBase.html +++ b/classes/v4.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.12.2

    Class QueueBase

    Description

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

    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 a75ab820bd..840f17fb3d 100644 --- a/classes/v4.QueueEvents.html +++ b/classes/v4.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.12.2

    Class QueueEvents

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

    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 e96d928667..59a2a951cf 100644 --- a/classes/v4.QueueGetters.html +++ b/classes/v4.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.12.2

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.12.3

    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 ea4b701c0f..dfbf10ce82 100644 --- a/classes/v4.QueueKeys.html +++ b/classes/v4.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.2

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.3

    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 0763841590..b454ea8bde 100644 --- a/classes/v4.RateLimitError.html +++ b/classes/v4.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.12.2

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.12.3

    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 0f4b739a9a..4ead06b4c6 100644 --- a/classes/v4.RedisConnection.html +++ b/classes/v4.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.2

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.3

    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 f4ef51fd02..42ce8cfb3e 100644 --- a/classes/v4.Repeat.html +++ b/classes/v4.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.12.2

    Class Repeat

    Description

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

    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 ac8cdfbf88..597d401344 100644 --- a/classes/v4.ScriptLoader.html +++ b/classes/v4.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.12.2

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.12.3

    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 05d908a860..84da9e1e52 100644 --- a/classes/v4.ScriptLoaderError.html +++ b/classes/v4.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.12.2

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.12.3

    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 fa30a83e8e..f934275251 100644 --- a/classes/v4.Scripts.html +++ b/classes/v4.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.2

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.3

    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 ae70a4fe91..8c2b8ce32e 100644 --- a/classes/v4.UnrecoverableError.html +++ b/classes/v4.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.2

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.3

    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 6827cf4e35..f76ba02d37 100644 --- a/classes/v4.WaitingChildrenError.html +++ b/classes/v4.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.2

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.3

    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 91e6c7357d..545bb6f2e0 100644 --- a/classes/v4.Worker.html +++ b/classes/v4.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.12.2

    Class Worker<DataType, ResultType, NameType>

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

    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 4817e0a6e3..c9851fad37 100644 --- a/classes/v5.AsyncFifoQueue.html +++ b/classes/v5.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.12.2

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.12.3

    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 ad7e6f8afe..0857920646 100644 --- a/classes/v5.Backoffs.html +++ b/classes/v5.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.12.2

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.12.3

    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 ce9c1b8ba5..6a071c0fe0 100644 --- a/classes/v5.ChildPool.html +++ b/classes/v5.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.12.2

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.12.3

    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 eb8de4c7a9..e40c6cce5d 100644 --- a/classes/v5.ChildProcessor.html +++ b/classes/v5.ChildProcessor.html @@ -1,7 +1,7 @@ -ChildProcessor | bullmq - v5.12.2

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.12.3

    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 df87f63d02..22b831da6c 100644 --- a/classes/v5.DelayedError.html +++ b/classes/v5.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.12.2

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.12.3

    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 fd145d1e90..0b2968015c 100644 --- a/classes/v5.FlowProducer.html +++ b/classes/v5.FlowProducer.html @@ -1,10 +1,10 @@ -FlowProducer | bullmq - v5.12.2

    Class FlowProducer

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

    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 2f1103ab89..5e0585c147 100644 --- a/classes/v5.Job.html +++ b/classes/v5.Job.html @@ -1,9 +1,9 @@ -Job | bullmq - v5.12.2

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.12.3

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

    • Moves a job to the completed queue. +

    moveToCompleted

    • moveToCompleted(returnValue, token, fetchNext?): Promise<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<any[]>

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

      -

    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 9f6cb2c221..705d8fc55a 100644 --- a/classes/v5.Queue.html +++ b/classes/v5.Queue.html @@ -1,7 +1,7 @@ -Queue | bullmq - v5.12.2

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.12.3

    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 81833f06c4..c8d45b70f4 100644 --- a/classes/v5.QueueBase.html +++ b/classes/v5.QueueBase.html @@ -1,7 +1,7 @@ -QueueBase | bullmq - v5.12.2

    Class QueueBase

    QueueBase

    +QueueBase | bullmq - v5.12.3

    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 e52d5d2059..c6e8a49412 100644 --- a/classes/v5.QueueEvents.html +++ b/classes/v5.QueueEvents.html @@ -1,7 +1,7 @@ -QueueEvents | bullmq - v5.12.2

    Class QueueEvents

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

    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 8a43574e00..8c90da27b8 100644 --- a/classes/v5.QueueGetters.html +++ b/classes/v5.QueueGetters.html @@ -1,6 +1,6 @@ -QueueGetters | bullmq - v5.12.2

    Class QueueGetters<DataType, ResultType, NameType>

    QueueGetters

    +QueueGetters | bullmq - v5.12.3

    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 249e657008..4a05e62269 100644 --- a/classes/v5.QueueKeys.html +++ b/classes/v5.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.12.2

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.12.3

    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 5e6f5f0e90..464b799c60 100644 --- a/classes/v5.RateLimitError.html +++ b/classes/v5.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.12.2

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.12.3

    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 4341d9e62c..53bc40035f 100644 --- a/classes/v5.RedisConnection.html +++ b/classes/v5.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.12.2

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.12.3

    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 96eb35c725..13917ccd6e 100644 --- a/classes/v5.Repeat.html +++ b/classes/v5.Repeat.html @@ -1,7 +1,7 @@ -Repeat | bullmq - v5.12.2

    Class Repeat

    QueueBase

    +Repeat | bullmq - v5.12.3

    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 88dec42402..8ca0af7fbf 100644 --- a/classes/v5.Scripts.html +++ b/classes/v5.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.12.2

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.12.3

    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 ddc6e4fdce..f98623a420 100644 --- a/classes/v5.UnrecoverableError.html +++ b/classes/v5.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.12.2

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.12.3

    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 56da4d5cd3..3165230f41 100644 --- a/classes/v5.WaitingChildrenError.html +++ b/classes/v5.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.12.2

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.12.3

    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 077d68748a..5efa89e402 100644 --- a/classes/v5.Worker.html +++ b/classes/v5.Worker.html @@ -1,7 +1,7 @@ -Worker | bullmq - v5.12.2

    Class Worker<DataType, ResultType, NameType>

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

    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 f6483c8b90..67c70f2690 100644 --- a/enums/v1.ChildCommand.html +++ b/enums/v1.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.2

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.3

    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 d0ed605b44..e4a8d2fac7 100644 --- a/enums/v1.ClientType.html +++ b/enums/v1.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.2

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.3

    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 21a1cf3aef..9b2167097b 100644 --- a/enums/v1.ErrorCode.html +++ b/enums/v1.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.12.2

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.12.3

    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 e4059f7789..853f217596 100644 --- a/enums/v1.MetricsTime.html +++ b/enums/v1.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.2

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.3

    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 e241e87735..7424b2a8c5 100644 --- a/enums/v1.ParentCommand.html +++ b/enums/v1.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.2

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.3

    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 45570814f6..8922cc2a93 100644 --- a/enums/v2.ChildCommand.html +++ b/enums/v2.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.2

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.3

    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 29c164c867..08d0780795 100644 --- a/enums/v2.ClientType.html +++ b/enums/v2.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.2

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.3

    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 7a53caa1ac..e47bba0155 100644 --- a/enums/v2.ErrorCode.html +++ b/enums/v2.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.12.2

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.12.3

    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 091cd46470..f3771a29c1 100644 --- a/enums/v2.MetricsTime.html +++ b/enums/v2.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.2

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.3

    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 b6e066053d..c1dc81d034 100644 --- a/enums/v2.ParentCommand.html +++ b/enums/v2.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.2

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.3

    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 2e9ca325af..13f99a1e8c 100644 --- a/enums/v3.ChildCommand.html +++ b/enums/v3.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.2

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.3

    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 cc8bbafdb2..ed38fcf3e7 100644 --- a/enums/v3.ClientType.html +++ b/enums/v3.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.2

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.3

    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 d77fe462c2..2328d9678a 100644 --- a/enums/v3.ErrorCode.html +++ b/enums/v3.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.12.2

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.3

    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 a495794d56..ad44f6d0fe 100644 --- a/enums/v3.MetricsTime.html +++ b/enums/v3.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.2

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.3

    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 32d361eb25..8dbd7b66e4 100644 --- a/enums/v3.ParentCommand.html +++ b/enums/v3.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.2

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.3

    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 4ab5a60e5c..f339e8b54a 100644 --- a/enums/v4.ChildCommand.html +++ b/enums/v4.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.2

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.3

    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 c6f56cf14f..0276dde165 100644 --- a/enums/v4.ClientType.html +++ b/enums/v4.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.2

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.3

    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 6b634fa7b6..1028dba331 100644 --- a/enums/v4.ErrorCode.html +++ b/enums/v4.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.12.2

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.3

    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 2d8d362992..0c6ae88b95 100644 --- a/enums/v4.MetricsTime.html +++ b/enums/v4.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.2

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.3

    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 08b1fe226b..219bcdaff2 100644 --- a/enums/v4.ParentCommand.html +++ b/enums/v4.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.2

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.3

    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 1186f27691..1fafb9ca70 100644 --- a/enums/v5.ChildCommand.html +++ b/enums/v5.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.12.2

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.12.3

    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 a4e5156773..6a763d93f2 100644 --- a/enums/v5.ClientType.html +++ b/enums/v5.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.12.2

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.12.3

    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 64a6c91af4..f590fadcf7 100644 --- a/enums/v5.ErrorCode.html +++ b/enums/v5.ErrorCode.html @@ -1,8 +1,8 @@ -ErrorCode | bullmq - v5.12.2

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.12.3

    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 ec87495ab8..6758d36d32 100644 --- a/enums/v5.MetricsTime.html +++ b/enums/v5.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.12.2

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.12.3

    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 7b8a9438fe..9ff5d857ae 100644 --- a/enums/v5.ParentCommand.html +++ b/enums/v5.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.12.2

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.12.3

    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 2298ea7625..d259a635f4 100644 --- a/functions/v1.array2obj.html +++ b/functions/v1.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.2

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

    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 5671a86fc5..64738043ad 100644 --- a/functions/v1.asyncSend.html +++ b/functions/v1.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.2

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

    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 96eb7aceac..d38079031f 100644 --- a/functions/v1.childSend.html +++ b/functions/v1.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.2

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 5ac4e27b3d..9ec62356ec 100644 --- a/functions/v1.delay.html +++ b/functions/v1.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.2

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

    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 4cefbef512..78643e6e84 100644 --- a/functions/v1.getNextMillis.html +++ b/functions/v1.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.2

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 0e5f51114c..550c6cd2ce 100644 --- a/functions/v1.getParentKey.html +++ b/functions/v1.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.2

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

    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 4b41f9b2ab..5bcb41ca2b 100644 --- a/functions/v1.isEmpty.html +++ b/functions/v1.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.2

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

    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 b5e6de8f3e..1af31f1bee 100644 --- a/functions/v1.isNotConnectionError.html +++ b/functions/v1.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.2

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

    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 59d57e2b51..694c94f153 100644 --- a/functions/v1.isRedisCluster.html +++ b/functions/v1.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.2

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

    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 fa206e9f51..ce9c77ebfb 100644 --- a/functions/v1.isRedisInstance.html +++ b/functions/v1.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.2

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

    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 f69883383a..d7b3bb1fb8 100644 --- a/functions/v1.isRedisVersionLowerThan.html +++ b/functions/v1.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.2

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

    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 87bb963e40..35f2d513c8 100644 --- a/functions/v1.jobIdForGroup.html +++ b/functions/v1.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.12.2

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +jobIdForGroup | bullmq - v5.12.3

    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 49bccdfd74..9686b793fd 100644 --- a/functions/v1.killAsync.html +++ b/functions/v1.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.12.2

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

      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 c8f00a2507..c4dc76ddd0 100644 --- a/functions/v1.lengthInUtf8Bytes.html +++ b/functions/v1.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.2

    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 5e1d8f7ab1..5d30cfe6f6 100644 --- a/functions/v1.parentSend.html +++ b/functions/v1.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.12.2

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

    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 a0287c5b18..83d6c84674 100644 --- a/functions/v1.raw2jobData.html +++ b/functions/v1.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.12.2

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +raw2jobData | bullmq - v5.12.3

    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 48cb02789a..eac70b90bd 100644 --- a/functions/v1.removeAllQueueData.html +++ b/functions/v1.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.2

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

    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 9fae81555a..9ee0d06b66 100644 --- a/functions/v1.tryCatch.html +++ b/functions/v1.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.2

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

    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 a4ea401d6f..b9b7b5a859 100644 --- a/functions/v2.array2obj.html +++ b/functions/v2.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.2

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

    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 a355489fd0..7b8f63eadb 100644 --- a/functions/v2.asyncSend.html +++ b/functions/v2.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.2

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

    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 3b950d279b..7e715dd029 100644 --- a/functions/v2.childSend.html +++ b/functions/v2.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.2

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 ea1d70769c..bc90bbcb7b 100644 --- a/functions/v2.delay.html +++ b/functions/v2.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.2

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

    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 99944bca00..ec4ffc4aa7 100644 --- a/functions/v2.getNextMillis.html +++ b/functions/v2.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.2

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 e676914b0d..3389869406 100644 --- a/functions/v2.getParentKey.html +++ b/functions/v2.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.2

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

    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 89766c33ae..fe73f1da01 100644 --- a/functions/v2.isEmpty.html +++ b/functions/v2.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.2

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

    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 27ef8a9d59..9755d80a64 100644 --- a/functions/v2.isNotConnectionError.html +++ b/functions/v2.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.2

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

    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 adccf9e839..35145967cf 100644 --- a/functions/v2.isRedisCluster.html +++ b/functions/v2.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.2

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

    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 6a1a6a9699..1142bbcf26 100644 --- a/functions/v2.isRedisInstance.html +++ b/functions/v2.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.2

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

    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 a2b6464a62..bf1d031d9c 100644 --- a/functions/v2.isRedisVersionLowerThan.html +++ b/functions/v2.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.2

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

    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 88bb6fe3bb..e952a70cf0 100644 --- a/functions/v2.jobIdForGroup.html +++ b/functions/v2.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.12.2

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +jobIdForGroup | bullmq - v5.12.3

    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 115a5bd994..b95ef50439 100644 --- a/functions/v2.killAsync.html +++ b/functions/v2.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.12.2

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

      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 34dc759e96..c3353484e6 100644 --- a/functions/v2.lengthInUtf8Bytes.html +++ b/functions/v2.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.2

    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 e86211ec2c..bb7a5d2d38 100644 --- a/functions/v2.parentSend.html +++ b/functions/v2.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.12.2

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

    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 0473e52a13..882be658ed 100644 --- a/functions/v2.raw2jobData.html +++ b/functions/v2.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.12.2

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +raw2jobData | bullmq - v5.12.3

    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 25daafdf61..96e8391ef8 100644 --- a/functions/v2.removeAllQueueData.html +++ b/functions/v2.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.2

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

    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 ef2d6807a8..b7f91d49ef 100644 --- a/functions/v2.tryCatch.html +++ b/functions/v2.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.2

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

    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 877a76fe71..c183ed5409 100644 --- a/functions/v3.array2obj.html +++ b/functions/v3.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.2

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

    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 3ee7dc54b1..8fea19ba56 100644 --- a/functions/v3.asyncSend.html +++ b/functions/v3.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.2

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

    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 4e4892e73a..76da4ec40f 100644 --- a/functions/v3.childSend.html +++ b/functions/v3.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.2

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 8b37c5773b..8c5eb64fac 100644 --- a/functions/v3.delay.html +++ b/functions/v3.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.2

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

    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 c4415af145..62bafb98e0 100644 --- a/functions/v3.errorToJSON.html +++ b/functions/v3.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.2

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

    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 3859b31265..149bb97762 100644 --- a/functions/v3.getNextMillis.html +++ b/functions/v3.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.2

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 6faaf647ea..f3ff5b2e13 100644 --- a/functions/v3.getParentKey.html +++ b/functions/v3.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.2

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

    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 250dbdbcf9..66c2e606d0 100644 --- a/functions/v3.isEmpty.html +++ b/functions/v3.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.2

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

    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 811b4ffdd5..03ace02e42 100644 --- a/functions/v3.isNotConnectionError.html +++ b/functions/v3.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.2

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

    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 bca15b9e7b..5e50bc033c 100644 --- a/functions/v3.isRedisCluster.html +++ b/functions/v3.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.2

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

    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 85b2f61964..ac1e1b2c6e 100644 --- a/functions/v3.isRedisInstance.html +++ b/functions/v3.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.2

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

    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 8de638e35c..822058a759 100644 --- a/functions/v3.isRedisVersionLowerThan.html +++ b/functions/v3.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.2

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

    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 b8f2bad080..8df418d59d 100644 --- a/functions/v3.lengthInUtf8Bytes.html +++ b/functions/v3.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.2

    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 0042e4c8b5..4be32cbd55 100644 --- a/functions/v3.parseObjectValues.html +++ b/functions/v3.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.2

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

    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 97bc0bbaaa..e970311e2e 100644 --- a/functions/v3.raw2NextJobData.html +++ b/functions/v3.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.2

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 7f0ac0a859..e2fd4a785d 100644 --- a/functions/v3.removeAllQueueData.html +++ b/functions/v3.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.2

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

    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 d34c111d5f..f11f720bbb 100644 --- a/functions/v3.tryCatch.html +++ b/functions/v3.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.2

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

    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 b3adc14fcf..e89bead6c2 100644 --- a/functions/v4.array2obj.html +++ b/functions/v4.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.2

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

    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 de3f57819f..28efe1dd5e 100644 --- a/functions/v4.asyncSend.html +++ b/functions/v4.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.2

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

    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 e7e6f1432f..996111dc3f 100644 --- a/functions/v4.childSend.html +++ b/functions/v4.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.2

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 6110e1ed60..281835c6a5 100644 --- a/functions/v4.decreaseMaxListeners.html +++ b/functions/v4.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.12.2

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

    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 75fa25ff4b..53b557e840 100644 --- a/functions/v4.delay.html +++ b/functions/v4.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.2

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

    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 de262a5fcf..cb7a3a20f9 100644 --- a/functions/v4.errorToJSON.html +++ b/functions/v4.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.2

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

    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 067955f8a0..71ebf9040e 100644 --- a/functions/v4.getNextMillis.html +++ b/functions/v4.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.2

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 56745f97ee..b4f9857dea 100644 --- a/functions/v4.getParentKey.html +++ b/functions/v4.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.2

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

    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 67f3747b9e..0d3f61126b 100644 --- a/functions/v4.increaseMaxListeners.html +++ b/functions/v4.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.12.2

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

    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 5875f178f1..d8850f9150 100644 --- a/functions/v4.isEmpty.html +++ b/functions/v4.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.2

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

    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 180d1472db..8c9362384b 100644 --- a/functions/v4.isNotConnectionError.html +++ b/functions/v4.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.2

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

    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 4828ad4012..0a5cc77666 100644 --- a/functions/v4.isRedisCluster.html +++ b/functions/v4.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.2

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

    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 2800c89a17..4fd7734fa7 100644 --- a/functions/v4.isRedisInstance.html +++ b/functions/v4.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.2

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

    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 ef0a7ff217..f669b74646 100644 --- a/functions/v4.isRedisVersionLowerThan.html +++ b/functions/v4.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.2

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

    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 79fb8eeb91..3033de2854 100644 --- a/functions/v4.lengthInUtf8Bytes.html +++ b/functions/v4.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.2

    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 baf0369e29..030c506a3c 100644 --- a/functions/v4.parseObjectValues.html +++ b/functions/v4.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.2

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

    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 9197a3ce9c..fd85f8f18f 100644 --- a/functions/v4.raw2NextJobData.html +++ b/functions/v4.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.2

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 d662157e5e..e8add846a7 100644 --- a/functions/v4.removeAllQueueData.html +++ b/functions/v4.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.2

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

    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 9487a7e84a..ff9e0d3d79 100644 --- a/functions/v4.tryCatch.html +++ b/functions/v4.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.2

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

    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 8e0a7035d8..20880c0aa4 100644 --- a/functions/v5.array2obj.html +++ b/functions/v5.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.12.2

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

    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 b449480daf..a3b5516968 100644 --- a/functions/v5.asyncSend.html +++ b/functions/v5.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.12.2

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

    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 3d929cdf60..9e79439a26 100644 --- a/functions/v5.childSend.html +++ b/functions/v5.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.12.2

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 e5bfd13de0..221f10cced 100644 --- a/functions/v5.decreaseMaxListeners.html +++ b/functions/v5.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.12.2

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

    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 dadd7a2260..a9c6143531 100644 --- a/functions/v5.delay.html +++ b/functions/v5.delay.html @@ -1 +1 @@ -delay | bullmq - v5.12.2

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

    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 6d7fd6c7ae..cc2d5988c7 100644 --- a/functions/v5.errorToJSON.html +++ b/functions/v5.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.12.2

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

    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 0b987dfad9..81e50dd3a3 100644 --- a/functions/v5.getNextMillis.html +++ b/functions/v5.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.12.2

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 332bb08d4a..17a2d22621 100644 --- a/functions/v5.getParentKey.html +++ b/functions/v5.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.12.2

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

    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 7ced8c88d1..842b2b22a8 100644 --- a/functions/v5.increaseMaxListeners.html +++ b/functions/v5.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.12.2

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

    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 66524d19cc..8941945a28 100644 --- a/functions/v5.invertObject.html +++ b/functions/v5.invertObject.html @@ -1 +1 @@ -invertObject | bullmq - v5.12.2

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

    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 3a4859a6e7..8d0b84a123 100644 --- a/functions/v5.isEmpty.html +++ b/functions/v5.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.12.2

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

    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 1be8c8a60d..3f6fb79c1b 100644 --- a/functions/v5.isNotConnectionError.html +++ b/functions/v5.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.12.2

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

    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 fa1404a8f3..fb29ca7ffb 100644 --- a/functions/v5.isRedisCluster.html +++ b/functions/v5.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.12.2

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

    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 7f685d9729..bff8156bce 100644 --- a/functions/v5.isRedisInstance.html +++ b/functions/v5.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.12.2

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

    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 e1f909ff89..e902fa85b5 100644 --- a/functions/v5.isRedisVersionLowerThan.html +++ b/functions/v5.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.12.2

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

    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 87888f0e38..2ae6038462 100644 --- a/functions/v5.lengthInUtf8Bytes.html +++ b/functions/v5.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.12.2

    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 6eb684b910..db9ab580e1 100644 --- a/functions/v5.parseObjectValues.html +++ b/functions/v5.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.12.2

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

    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 85228f2618..d16e053705 100644 --- a/functions/v5.raw2NextJobData.html +++ b/functions/v5.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.12.2

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 715f9d1d41..8c54fe129b 100644 --- a/functions/v5.removeAllQueueData.html +++ b/functions/v5.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.12.2

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

    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 5a9b02af9e..f3d9713cd4 100644 --- a/functions/v5.toString.html +++ b/functions/v5.toString.html @@ -1 +1 @@ -toString | bullmq - v5.12.2

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

    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 d0c96e120d..32b85eeb5f 100644 --- a/functions/v5.tryCatch.html +++ b/functions/v5.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.12.2

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

    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 3e0618afe3..7dcb2f6e5e 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -bullmq - v5.12.2

    bullmq - v5.12.2

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bullmq - v5.12.3

    bullmq - v5.12.3

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index e0046ae45d..6ce1595f21 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -bullmq - v5.12.2

    bullmq - v5.12.2

    +bullmq - v5.12.3

    bullmq - v5.12.3



    @@ -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 c52b588062..3f79c28634 100644 --- a/interfaces/v1.AddChildrenOpts.html +++ b/interfaces/v1.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.2

    Interface AddChildrenOpts

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

    Properties

    multi +AddChildrenOpts | bullmq - v5.12.3

    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 0ec7ae78da..3708ff646a 100644 --- a/interfaces/v1.AddNodeOpts.html +++ b/interfaces/v1.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.2

    Interface AddNodeOpts

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

    Properties

    multi +AddNodeOpts | bullmq - v5.12.3

    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 9f33b6361c..ede44d2ebb 100644 --- a/interfaces/v1.AdvancedOptions.html +++ b/interfaces/v1.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.2

    Interface AdvancedOptions

    interface AdvancedOptions {
        backoffStrategies?: {};
        repeatStrategy?: RepeatStrategy;
    }

    Hierarchy (view full)

    Properties

    backoffStrategies? +AdvancedOptions | bullmq - v5.12.3

    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 d1d426e66b..77d9c5fd18 100644 --- a/interfaces/v1.AdvancedRepeatOptions.html +++ b/interfaces/v1.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.2

      Interface AdvancedRepeatOptions

      interface AdvancedRepeatOptions {
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.3

      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 144ae08707..56c1cc5124 100644 --- a/interfaces/v1.BackoffOptions.html +++ b/interfaces/v1.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.2

      Interface BackoffOptions

      Settings for backing off failed jobs.

      +BackoffOptions | bullmq - v5.12.3

      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 f0d8e4d9fd..878935cfb9 100644 --- a/interfaces/v1.BaseJobOptions.html +++ b/interfaces/v1.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.2

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

      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 3bc256d6fd..ddd2c4ce25 100644 --- a/interfaces/v1.ChildMessage.html +++ b/interfaces/v1.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.2

      Interface ChildMessage

      interface ChildMessage {
          cmd: ParentCommand;
          err?: Error;
          value?: any;
      }

      Properties

      cmd +ChildMessage | bullmq - v5.12.3

      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 d9d981b5d5..3fc185ee76 100644 --- a/interfaces/v1.ChildProcessExt.html +++ b/interfaces/v1.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.12.2

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

      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 8f47fe0e96..0468fcc9ec 100644 --- a/interfaces/v1.Command.html +++ b/interfaces/v1.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.2

      Interface Command

      interface Command {
          name: string;
          options: {
              lua: string;
              numberOfKeys: number;
          };
      }

      Properties

      name +Command | bullmq - v5.12.3

      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 df07a7964e..a37ac57804 100644 --- a/interfaces/v1.DependenciesOpts.html +++ b/interfaces/v1.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.2

      Interface DependenciesOpts

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

      Properties

      processed? +DependenciesOpts | bullmq - v5.12.3

      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 978983c25b..ad066a9298 100644 --- a/interfaces/v1.FlowJob.html +++ b/interfaces/v1.FlowJob.html @@ -1,7 +1,7 @@ -FlowJob | bullmq - v5.12.2

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

      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 791b0e3302..b71bc420fb 100644 --- a/interfaces/v1.FlowOpts.html +++ b/interfaces/v1.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.2

      Interface FlowOpts

      interface FlowOpts {
          queuesOptions: FlowQueuesOpts;
      }

      Properties

      queuesOptions +FlowOpts | bullmq - v5.12.3

      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 614fec35f8..1b7e774a2f 100644 --- a/interfaces/v1.FlowProducerListener.html +++ b/interfaces/v1.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.2

      Interface FlowProducerListener

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

      Hierarchy (view full)

      Properties

      error +FlowProducerListener | bullmq - v5.12.3

      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 ad4a15c8c5..dc6d07957e 100644 --- a/interfaces/v1.GetNextJobOptions.html +++ b/interfaces/v1.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.2

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

      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 5a7a9e51c9..6a8e307a8f 100644 --- a/interfaces/v1.IConnection.html +++ b/interfaces/v1.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.2

      Interface IConnection

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

      Hierarchy

      • EventEmitter
        • IConnection

      Properties

      client +IConnection | bullmq - v5.12.3

      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 25bd74267f..9f741cfa77 100644 --- a/interfaces/v1.IoredisListener.html +++ b/interfaces/v1.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.2

      Interface IoredisListener

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

      Hierarchy (view full)

      Properties

      ioredis:close +IoredisListener | bullmq - v5.12.3

      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 372c230ac9..495bef47d5 100644 --- a/interfaces/v1.JobInformation3.html +++ b/interfaces/v1.JobInformation3.html @@ -1,8 +1,8 @@ -JobInformation3 | bullmq - v5.12.2

      Interface JobInformation3

      interface JobInformation3 {
          cron: string;
          endDate?: number;
          id?: string;
          key: string;
          name: string;
          next: number;
          tz?: string;
      }

      Properties

      cron +JobInformation3 | bullmq - v5.12.3

      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 f4ff046e6c..375896267e 100644 --- a/interfaces/v1.JobJson.html +++ b/interfaces/v1.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.2

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

      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 dc3ce1a794..26165bf59b 100644 --- a/interfaces/v1.JobJsonRaw.html +++ b/interfaces/v1.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.2

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

      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 a5a0288693..da98782d26 100644 --- a/interfaces/v1.JobNode.html +++ b/interfaces/v1.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.2

      Interface JobNode

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

      Properties

      children? +JobNode | bullmq - v5.12.3

      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 a13ee734f2..e0ddaa3280 100644 --- a/interfaces/v1.JobPromise3.html +++ b/interfaces/v1.JobPromise3.html @@ -1,3 +1,3 @@ -JobPromise3 | bullmq - v5.12.2

      Interface JobPromise3

      interface JobPromise3 {
          cancel(): void;
      }

      Methods

      cancel +JobPromise3 | bullmq - v5.12.3

      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 fbf11e1923..33065f1866 100644 --- a/interfaces/v1.JobsOptions.html +++ b/interfaces/v1.JobsOptions.html @@ -1,4 +1,4 @@ -JobsOptions | bullmq - v5.12.2

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

      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 c0f8a0b5bb..7affca498b 100644 --- a/interfaces/v1.KeepJobs.html +++ b/interfaces/v1.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.2

      Interface KeepJobs

      KeepJobs

      +KeepJobs | bullmq - v5.12.3

      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 49b685107f..984a2105eb 100644 --- a/interfaces/v1.Metrics.html +++ b/interfaces/v1.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.2

      Interface Metrics

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

      Properties

      count +Metrics | bullmq - v5.12.3

      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 6137ed7443..c37d567edd 100644 --- a/interfaces/v1.MetricsOptions.html +++ b/interfaces/v1.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.2

      Interface MetricsOptions

      interface MetricsOptions {
          maxDataPoints?: number;
      }

      Properties

      maxDataPoints? +MetricsOptions | bullmq - v5.12.3

      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 e7754ffd02..8ea311fb94 100644 --- a/interfaces/v1.MoveToWaitingChildrenOpts.html +++ b/interfaces/v1.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.2

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

      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 dfba31cf14..a35d0ff38d 100644 --- a/interfaces/v1.NodeOpts.html +++ b/interfaces/v1.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.2

      Interface NodeOpts

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

      Properties

      depth? +NodeOpts | bullmq - v5.12.3

      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 94aff182c7..710dff01ee 100644 --- a/interfaces/v1.ObliterateOpts.html +++ b/interfaces/v1.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.2

      Interface ObliterateOpts

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

      Properties

      count? +ObliterateOpts | bullmq - v5.12.3

      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 649c283689..259bb9685b 100644 --- a/interfaces/v1.Parent.html +++ b/interfaces/v1.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.2

      Interface Parent<T>

      Describes the parent for a Job.

      +Parent | bullmq - v5.12.3

      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 2b0541a604..8957af01c9 100644 --- a/interfaces/v1.ParentKeys.html +++ b/interfaces/v1.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.2

      Interface ParentKeys

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

      Properties

      id +ParentKeys | bullmq - v5.12.3

      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 8d970e7b80..63d3c9d694 100644 --- a/interfaces/v1.ParentMessage.html +++ b/interfaces/v1.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.2

      Interface ParentMessage

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

      Properties

      cmd +ParentMessage | bullmq - v5.12.3

      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 c56064aa66..d6592c9094 100644 --- a/interfaces/v1.QueueBaseOptions.html +++ b/interfaces/v1.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.2

      Interface QueueBaseOptions

      Base Queue options

      +QueueBaseOptions | bullmq - v5.12.3

      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 588903a160..897aac77ce 100644 --- a/interfaces/v1.QueueEventsListener.html +++ b/interfaces/v1.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.2

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

      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 3000702c6e..c32f29137e 100644 --- a/interfaces/v1.QueueEventsOptions.html +++ b/interfaces/v1.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.2

      Interface QueueEventsOptions

      Options for QueueEvents

      +QueueEventsOptions | bullmq - v5.12.3

      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 cb7cb44616..86db0057fb 100644 --- a/interfaces/v1.QueueListener.html +++ b/interfaces/v1.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.2

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

      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 9320aa0244..132f42df63 100644 --- a/interfaces/v1.QueueOptions.html +++ b/interfaces/v1.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.2

      Interface QueueOptions

      Options for the Queue class.

      +QueueOptions | bullmq - v5.12.3

      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 f4d4412bd5..0242048150 100644 --- a/interfaces/v1.QueueSchedulerListener.html +++ b/interfaces/v1.QueueSchedulerListener.html @@ -1,4 +1,4 @@ -QueueSchedulerListener | bullmq - v5.12.2

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

      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 0dcd564224..103bedb05e 100644 --- a/interfaces/v1.QueueSchedulerOptions.html +++ b/interfaces/v1.QueueSchedulerOptions.html @@ -1,4 +1,4 @@ -QueueSchedulerOptions | bullmq - v5.12.2

      Interface QueueSchedulerOptions

      Options for customizing the behaviour of the scheduler.

      +QueueSchedulerOptions | bullmq - v5.12.3

      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 b14a03a6d3..77cb6cff89 100644 --- a/interfaces/v1.RateLimiterOptions.html +++ b/interfaces/v1.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.12.2

      Interface RateLimiterOptions

      interface RateLimiterOptions {
          duration: number;
          groupKey?: string;
          max: number;
          workerDelay?: boolean;
      }

      Properties

      duration +RateLimiterOptions | bullmq - v5.12.3

      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 02c79f6436..e9fe33a500 100644 --- a/interfaces/v1.RepeatBaseOptions.html +++ b/interfaces/v1.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.2

      Interface RepeatBaseOptions

      Options for the Repeat class.

      +RepeatBaseOptions | bullmq - v5.12.3

      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 84a44c4397..51bbb66908 100644 --- a/interfaces/v1.RepeatOptions.html +++ b/interfaces/v1.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.2

      Interface RepeatOptions

      Settings for repeatable jobs

      +RepeatOptions | bullmq - v5.12.3

      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 bcd47cb123..89188443ab 100644 --- a/interfaces/v1.SandboxedJob.html +++ b/interfaces/v1.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.2

      Interface SandboxedJob<T, R>

      See

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

      +SandboxedJob | bullmq - v5.12.3

      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 dbbaa554dc..b1a06a56e7 100644 --- a/interfaces/v1.ScriptMetadata.html +++ b/interfaces/v1.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.2

      Interface ScriptMetadata

      Script metadata

      +ScriptMetadata | bullmq - v5.12.3

      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 d35a2a81f2..9991d6d720 100644 --- a/interfaces/v1.Strategies.html +++ b/interfaces/v1.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.12.2

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

      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 2cda7d645a..870c7508ee 100644 --- a/interfaces/v1.WorkerListener.html +++ b/interfaces/v1.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.2

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

      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 22f1b8bf8a..049e62fd4d 100644 --- a/interfaces/v1.WorkerOptions.html +++ b/interfaces/v1.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.2

      Interface WorkerOptions

      Base Queue options

      +WorkerOptions | bullmq - v5.12.3

      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 43ac99b725..04de5540d1 100644 --- a/interfaces/v2.AddChildrenOpts.html +++ b/interfaces/v2.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.2

      Interface AddChildrenOpts

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

      Properties

      multi +AddChildrenOpts | bullmq - v5.12.3

      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 cb115e5c06..40f15c4147 100644 --- a/interfaces/v2.AddNodeOpts.html +++ b/interfaces/v2.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.2

      Interface AddNodeOpts

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

      Properties

      multi +AddNodeOpts | bullmq - v5.12.3

      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 ad7d76d34b..90d22de2ee 100644 --- a/interfaces/v2.AdvancedOptions.html +++ b/interfaces/v2.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.2

      Interface AdvancedOptions

      interface AdvancedOptions {
          backoffStrategies?: {};
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      backoffStrategies? +AdvancedOptions | bullmq - v5.12.3

      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 0b21aec947..004680ac62 100644 --- a/interfaces/v2.AdvancedRepeatOptions.html +++ b/interfaces/v2.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.2

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.3

        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 3d85a23adf..399b1157e5 100644 --- a/interfaces/v2.BackoffOptions.html +++ b/interfaces/v2.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.2

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.3

        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 aa412a4006..cc330f51f1 100644 --- a/interfaces/v2.BaseJobOptions.html +++ b/interfaces/v2.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.2

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

        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 6c830e985d..5c341779ea 100644 --- a/interfaces/v2.ChildMessage.html +++ b/interfaces/v2.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.2

        Interface ChildMessage

        interface ChildMessage {
            cmd: ParentCommand;
            err?: Error;
            value?: any;
        }

        Properties

        cmd +ChildMessage | bullmq - v5.12.3

        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 aa0ff1f44d..7d3f97c1a8 100644 --- a/interfaces/v2.ChildProcessExt.html +++ b/interfaces/v2.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.12.2

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

        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 9f76d37997..6bf58d0600 100644 --- a/interfaces/v2.Command.html +++ b/interfaces/v2.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.2

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.3

        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 ba054e0d37..355b131241 100644 --- a/interfaces/v2.DefaultJobOptions.html +++ b/interfaces/v2.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.2

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

        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 af4685ce64..01231cfe59 100644 --- a/interfaces/v2.DependenciesOpts.html +++ b/interfaces/v2.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.2

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.3

        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 41761bae4b..d19a7882db 100644 --- a/interfaces/v2.FlowOpts.html +++ b/interfaces/v2.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.2

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.3

        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 5116ab070d..4b563e4bf3 100644 --- a/interfaces/v2.FlowProducerListener.html +++ b/interfaces/v2.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.2

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.3

        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 3be8347f8e..2bc347c2cc 100644 --- a/interfaces/v2.GetNextJobOptions.html +++ b/interfaces/v2.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.2

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

        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 292468f56d..a706368e1e 100644 --- a/interfaces/v2.IConnection.html +++ b/interfaces/v2.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.2

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.3

        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 cf2d18e4a5..c8be1120bc 100644 --- a/interfaces/v2.IoredisListener.html +++ b/interfaces/v2.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.2

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.3

        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 49b2b97db9..856d80b0e3 100644 --- a/interfaces/v2.JobJson.html +++ b/interfaces/v2.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.2

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

        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 a3107e4c98..e52b1192f4 100644 --- a/interfaces/v2.JobJsonRaw.html +++ b/interfaces/v2.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.2

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

        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 cc1983df24..23b57f0ecb 100644 --- a/interfaces/v2.JobNode.html +++ b/interfaces/v2.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.2

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.3

        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 386f00a3e9..367d1774cc 100644 --- a/interfaces/v2.KeepJobs.html +++ b/interfaces/v2.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.2

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.3

        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 9174d8b6bf..822236f984 100644 --- a/interfaces/v2.Metrics.html +++ b/interfaces/v2.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.2

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.3

        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 b1f5d68baf..6452690516 100644 --- a/interfaces/v2.MetricsOptions.html +++ b/interfaces/v2.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.2

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.3

        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 bdca3f9ff3..7356585a16 100644 --- a/interfaces/v2.MoveToWaitingChildrenOpts.html +++ b/interfaces/v2.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.2

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

        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 3873309437..37d8cfc41a 100644 --- a/interfaces/v2.NodeOpts.html +++ b/interfaces/v2.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.2

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.3

        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 de8d90a741..e6857835ea 100644 --- a/interfaces/v2.ObliterateOpts.html +++ b/interfaces/v2.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.2

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.3

        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 29be4868d2..1672fd6095 100644 --- a/interfaces/v2.Parent.html +++ b/interfaces/v2.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.2

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.3

        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 9e9d1df70e..9778161e94 100644 --- a/interfaces/v2.ParentKeys.html +++ b/interfaces/v2.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.2

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.3

        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 563c6d9495..df1c65f0d3 100644 --- a/interfaces/v2.ParentMessage.html +++ b/interfaces/v2.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.2

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.3

        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 0729cf007d..e4a8cf5231 100644 --- a/interfaces/v2.QueueBaseOptions.html +++ b/interfaces/v2.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.2

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.3

        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 4fa91b66c1..bd768d7d2f 100644 --- a/interfaces/v2.QueueEventsListener.html +++ b/interfaces/v2.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.2

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

        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 5924cba501..ba9b3a9332 100644 --- a/interfaces/v2.QueueEventsOptions.html +++ b/interfaces/v2.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.2

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.3

        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 ec013e510e..939d59e0a4 100644 --- a/interfaces/v2.QueueListener.html +++ b/interfaces/v2.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.2

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

        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 c591141918..972fdc6305 100644 --- a/interfaces/v2.QueueOptions.html +++ b/interfaces/v2.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.2

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.3

        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 991f6f0dd3..7ccf1b4431 100644 --- a/interfaces/v2.RateLimiterOptions.html +++ b/interfaces/v2.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.12.2

        Interface RateLimiterOptions

        interface RateLimiterOptions {
            duration: number;
            groupKey?: string;
            max: number;
            workerDelay?: boolean;
        }

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.3

        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 f42ca7c033..ce12cfbae8 100644 --- a/interfaces/v2.RawCommand.html +++ b/interfaces/v2.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.2

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.12.3

        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 d8e56ef2e2..37ce76bd25 100644 --- a/interfaces/v2.RepeatBaseOptions.html +++ b/interfaces/v2.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.2

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.3

        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 adb579f942..8cd12b61fa 100644 --- a/interfaces/v2.RepeatOptions.html +++ b/interfaces/v2.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.2

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.3

        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 576ca86834..532b4afdeb 100644 --- a/interfaces/v2.SandboxedJob.html +++ b/interfaces/v2.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.2

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.12.3

        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 35e350d950..0760b6a868 100644 --- a/interfaces/v2.ScriptMetadata.html +++ b/interfaces/v2.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.2

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.3

        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 41a256c091..7e308ad429 100644 --- a/interfaces/v2.Strategies.html +++ b/interfaces/v2.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.12.2

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

        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 1263e579da..5782be5cd9 100644 --- a/interfaces/v2.WorkerListener.html +++ b/interfaces/v2.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.2

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

        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 b9bd93c1d9..f5b19e74a8 100644 --- a/interfaces/v2.WorkerOptions.html +++ b/interfaces/v2.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.2

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.3

        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 6eeef226d8..fc8b529d6d 100644 --- a/interfaces/v3.AddChildrenOpts.html +++ b/interfaces/v3.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.2

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.3

        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 18780b4b25..bdc83ce309 100644 --- a/interfaces/v3.AddNodeOpts.html +++ b/interfaces/v3.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.2

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.12.3

        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 5d6e794b44..6a3b38a09d 100644 --- a/interfaces/v3.AdvancedOptions.html +++ b/interfaces/v3.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.12.2

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.3

        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 71dd4b1ee7..3bd6c68344 100644 --- a/interfaces/v3.AdvancedRepeatOptions.html +++ b/interfaces/v3.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.12.2

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.12.3

        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 9c097ee9af..01c04023fd 100644 --- a/interfaces/v3.BackoffOptions.html +++ b/interfaces/v3.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.2

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.3

        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 148603f365..c9bf9a8aff 100644 --- a/interfaces/v3.BaseJobOptions.html +++ b/interfaces/v3.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.2

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

        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 27670e0fa4..f8913daff7 100644 --- a/interfaces/v3.BaseOptions.html +++ b/interfaces/v3.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.2

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

        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 93a13c9f63..5befc3b286 100644 --- a/interfaces/v3.BuiltInStrategies.html +++ b/interfaces/v3.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.2

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

        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 7053e50b1a..ab03da12e2 100644 --- a/interfaces/v3.ChildMessage.html +++ b/interfaces/v3.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.2

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.12.3

        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 45ac1265f5..e27357c085 100644 --- a/interfaces/v3.Command.html +++ b/interfaces/v3.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.2

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.3

        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 5073bc939d..42b84c8131 100644 --- a/interfaces/v3.DefaultJobOptions.html +++ b/interfaces/v3.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.2

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

        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 d37d27b4db..c159d04a2d 100644 --- a/interfaces/v3.DependenciesOpts.html +++ b/interfaces/v3.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.2

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.3

        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 74d3029e25..cbff9191f1 100644 --- a/interfaces/v3.FlowJobBase.html +++ b/interfaces/v3.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.2

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

        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 e8b3bc8333..5174f85efd 100644 --- a/interfaces/v3.FlowOpts.html +++ b/interfaces/v3.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.2

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.3

        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 c5bcc14c18..ae5810e6aa 100644 --- a/interfaces/v3.FlowProducerListener.html +++ b/interfaces/v3.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.2

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.3

        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 3a9a9e6b90..f775bcaa28 100644 --- a/interfaces/v3.GetNextJobOptions.html +++ b/interfaces/v3.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.2

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

        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 f9a8c29b97..6ea5022bda 100644 --- a/interfaces/v3.IConnection.html +++ b/interfaces/v3.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.2

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.3

        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 78617edcdc..a65697138b 100644 --- a/interfaces/v3.IoredisListener.html +++ b/interfaces/v3.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.2

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.3

        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 a55e74d632..67d411e2d7 100644 --- a/interfaces/v3.JobJson.html +++ b/interfaces/v3.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.2

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

        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 7f1e0b68e1..ebf5d075e0 100644 --- a/interfaces/v3.JobJsonRaw.html +++ b/interfaces/v3.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.2

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

        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 41eaa75996..046cba9285 100644 --- a/interfaces/v3.JobNode.html +++ b/interfaces/v3.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.2

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.3

        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 6c35b3da30..88f89dc388 100644 --- a/interfaces/v3.KeepJobs.html +++ b/interfaces/v3.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.2

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.3

        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 26989eada7..6b6a6f5fe8 100644 --- a/interfaces/v3.Metrics.html +++ b/interfaces/v3.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.2

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.3

        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 6f31202e6b..2482644851 100644 --- a/interfaces/v3.MetricsOptions.html +++ b/interfaces/v3.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.2

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.3

        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 bd3c839c1b..82d4dc585b 100644 --- a/interfaces/v3.MinimalJob.html +++ b/interfaces/v3.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.12.2

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.12.3

        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 1e900f89b1..d729e5bdfb 100644 --- a/interfaces/v3.MoveToWaitingChildrenOpts.html +++ b/interfaces/v3.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.2

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

        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 71662e5740..77da74eef1 100644 --- a/interfaces/v3.NodeOpts.html +++ b/interfaces/v3.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.2

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.3

        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 f28ac98fb3..afb166ccea 100644 --- a/interfaces/v3.ObliterateOpts.html +++ b/interfaces/v3.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.12.2

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.3

        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 dceed65054..9c828c119f 100644 --- a/interfaces/v3.Parent.html +++ b/interfaces/v3.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.2

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.3

        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 513ca20486..6522d77de4 100644 --- a/interfaces/v3.ParentKeys.html +++ b/interfaces/v3.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.2

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.3

        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 01246f3c18..36a307504d 100644 --- a/interfaces/v3.ParentMessage.html +++ b/interfaces/v3.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.2

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.3

        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 b03af5dea7..178b95fd3d 100644 --- a/interfaces/v3.QueueBaseOptions.html +++ b/interfaces/v3.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.2

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.3

        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 3d5aa5e017..775770e289 100644 --- a/interfaces/v3.QueueEventsListener.html +++ b/interfaces/v3.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.2

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

        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 edef00ebfd..e26b5e6e33 100644 --- a/interfaces/v3.QueueEventsOptions.html +++ b/interfaces/v3.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.2

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.3

        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 a938b50bde..0bbfdc02be 100644 --- a/interfaces/v3.QueueListener.html +++ b/interfaces/v3.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.2

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

        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 482373136f..4663f8abbe 100644 --- a/interfaces/v3.QueueOptions.html +++ b/interfaces/v3.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.2

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.3

        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 6d21bd738b..e183b83ade 100644 --- a/interfaces/v3.RateLimiterOptions.html +++ b/interfaces/v3.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.2

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.3

        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 42664f879b..f2cad79369 100644 --- a/interfaces/v3.RawCommand.html +++ b/interfaces/v3.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.2

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.12.3

        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 a05e8b896a..ff8cac28e7 100644 --- a/interfaces/v3.RepeatBaseOptions.html +++ b/interfaces/v3.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.2

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.3

        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 9786010eeb..9c0869bed0 100644 --- a/interfaces/v3.RepeatOptions.html +++ b/interfaces/v3.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.2

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.3

        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 b5fc3310cd..b092ad5313 100644 --- a/interfaces/v3.SandboxedJob.html +++ b/interfaces/v3.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.2

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.12.3

        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 38746ff4e9..c4e520bcfc 100644 --- a/interfaces/v3.ScriptMetadata.html +++ b/interfaces/v3.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.2

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.3

        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 ad1c5403fa..d04e2bf1c9 100644 --- a/interfaces/v3.WorkerListener.html +++ b/interfaces/v3.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.2

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

        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 fe578f6ce7..edc4c963b9 100644 --- a/interfaces/v3.WorkerOptions.html +++ b/interfaces/v3.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.2

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.3

        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 9fe984b2a5..374bd7819d 100644 --- a/interfaces/v4.AddChildrenOpts.html +++ b/interfaces/v4.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.2

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.3

        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 c6de811e45..7e659bfc9f 100644 --- a/interfaces/v4.AddNodeOpts.html +++ b/interfaces/v4.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.2

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.12.3

        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 89eac5bb7e..67793e11d6 100644 --- a/interfaces/v4.AdvancedOptions.html +++ b/interfaces/v4.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.12.2

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.3

        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 ec896af879..562c0c567a 100644 --- a/interfaces/v4.AdvancedRepeatOptions.html +++ b/interfaces/v4.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.12.2

        Interface AdvancedRepeatOptions

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

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.12.3

        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 ccd30fd88f..fabf0d180f 100644 --- a/interfaces/v4.BackoffOptions.html +++ b/interfaces/v4.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.2

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.3

        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 e63c2e4ed2..d06c84cfd2 100644 --- a/interfaces/v4.BaseJobOptions.html +++ b/interfaces/v4.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.2

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

        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 4a7b36ba5c..314a6f40eb 100644 --- a/interfaces/v4.BaseOptions.html +++ b/interfaces/v4.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.2

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

        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 d1a650b852..c648d6de06 100644 --- a/interfaces/v4.BuiltInStrategies.html +++ b/interfaces/v4.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.2

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

        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 1a4bac6bf8..0c8636161c 100644 --- a/interfaces/v4.ChildMessage.html +++ b/interfaces/v4.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.2

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.12.3

        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 9430fd3644..8639cd8de5 100644 --- a/interfaces/v4.Command.html +++ b/interfaces/v4.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.12.2

        Interface Command

        interface Command {
            name: string;
            options: {
                lua: string;
                numberOfKeys: number;
            };
        }

        Properties

        name +Command | bullmq - v5.12.3

        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 fc329b9635..e2e9f3b86f 100644 --- a/interfaces/v4.DefaultJobOptions.html +++ b/interfaces/v4.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.2

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

        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 b300d604ab..6295f7c763 100644 --- a/interfaces/v4.DependenciesOpts.html +++ b/interfaces/v4.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.2

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.3

        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 1d346573b2..f6bcd5f273 100644 --- a/interfaces/v4.FlowJobBase.html +++ b/interfaces/v4.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.2

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

        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 156d7b94e5..784996bb68 100644 --- a/interfaces/v4.FlowOpts.html +++ b/interfaces/v4.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.2

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.3

        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 236807634a..ffc1cb9b07 100644 --- a/interfaces/v4.FlowProducerListener.html +++ b/interfaces/v4.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.12.2

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.3

        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 89ce1c1bcc..fc576317f8 100644 --- a/interfaces/v4.GetNextJobOptions.html +++ b/interfaces/v4.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.2

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

        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 da26bda013..ee2fc27f71 100644 --- a/interfaces/v4.IConnection.html +++ b/interfaces/v4.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.2

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.3

        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 4c8ee92bd5..ac909c796b 100644 --- a/interfaces/v4.IoredisListener.html +++ b/interfaces/v4.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.12.2

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.3

        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 f183bf6cec..d268f4fca2 100644 --- a/interfaces/v4.JobJson.html +++ b/interfaces/v4.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.2

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

        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 9cf5ce4425..f49dbd3e9c 100644 --- a/interfaces/v4.JobJsonRaw.html +++ b/interfaces/v4.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.2

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

        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 91b39d9d03..19367160b3 100644 --- a/interfaces/v4.JobNode.html +++ b/interfaces/v4.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.2

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.3

        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 e97776df1f..bbd26fc449 100644 --- a/interfaces/v4.KeepJobs.html +++ b/interfaces/v4.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.12.2

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.3

        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 7214d55998..a767512da8 100644 --- a/interfaces/v4.Metrics.html +++ b/interfaces/v4.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.2

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.3

        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 a144c0cf57..4af9a21137 100644 --- a/interfaces/v4.MetricsOptions.html +++ b/interfaces/v4.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.2

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.3

        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 0ba62587c3..18f87adea8 100644 --- a/interfaces/v4.MinimalJob.html +++ b/interfaces/v4.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.12.2

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.12.3

        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 73aaeaecb6..ac0ea0449a 100644 --- a/interfaces/v4.MoveToWaitingChildrenOpts.html +++ b/interfaces/v4.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.2

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

        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 85729b3560..f8040c922a 100644 --- a/interfaces/v4.NodeOpts.html +++ b/interfaces/v4.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.12.2

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.3

        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 35a7eef426..24a44e28bb 100644 --- a/interfaces/v4.ObliterateOpts.html +++ b/interfaces/v4.ObliterateOpts.html @@ -1,4 +1,4 @@ -ObliterateOpts | bullmq - v5.12.2

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.3

        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 1eb47ea38b..ce974607ca 100644 --- a/interfaces/v4.Parent.html +++ b/interfaces/v4.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.2

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.12.3

        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 2dd2e2d8ee..f2fe31363b 100644 --- a/interfaces/v4.ParentKeys.html +++ b/interfaces/v4.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.2

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.3

        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 92f1478891..3e91cc327e 100644 --- a/interfaces/v4.ParentMessage.html +++ b/interfaces/v4.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.2

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.3

        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 da3c5b7964..e278f69518 100644 --- a/interfaces/v4.QueueBaseOptions.html +++ b/interfaces/v4.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.12.2

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.12.3

        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 b1dd438b64..8337fc6362 100644 --- a/interfaces/v4.QueueEventsListener.html +++ b/interfaces/v4.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.2

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

        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 de9e985224..3f24859b5b 100644 --- a/interfaces/v4.QueueEventsOptions.html +++ b/interfaces/v4.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.12.2

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.12.3

        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 b6f08844b4..54d0a48282 100644 --- a/interfaces/v4.QueueListener.html +++ b/interfaces/v4.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.2

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

        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 9dc3d033aa..1846d686e7 100644 --- a/interfaces/v4.QueueOptions.html +++ b/interfaces/v4.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.12.2

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.12.3

        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 b7d8b670ca..cef6c4d72a 100644 --- a/interfaces/v4.RateLimiterOptions.html +++ b/interfaces/v4.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.2

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.12.3

        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 a5ea9892dc..46dd667a3e 100644 --- a/interfaces/v4.RawCommand.html +++ b/interfaces/v4.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.2

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.12.3

        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 8eb518ef41..2b29be17ff 100644 --- a/interfaces/v4.RepeatBaseOptions.html +++ b/interfaces/v4.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.12.2

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.12.3

        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 8b19ba4ee2..928788103b 100644 --- a/interfaces/v4.RepeatOptions.html +++ b/interfaces/v4.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.12.2

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.12.3

        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 4f700f2bd6..cf3da6df36 100644 --- a/interfaces/v4.SandboxedJob.html +++ b/interfaces/v4.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.12.2

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.12.3

        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 37bb5ba740..c01c36f19c 100644 --- a/interfaces/v4.ScriptMetadata.html +++ b/interfaces/v4.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.12.2

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.12.3

        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 aefce120c0..a16499ebdf 100644 --- a/interfaces/v4.WorkerListener.html +++ b/interfaces/v4.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.2

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

        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 2cbf733016..62a208d1b1 100644 --- a/interfaces/v4.WorkerOptions.html +++ b/interfaces/v4.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.12.2

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.12.3

        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 bb8983bde9..b85a620c2a 100644 --- a/interfaces/v5.AddChildrenOpts.html +++ b/interfaces/v5.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.12.2

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.12.3

        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 20391ce1dc..702b3fa316 100644 --- a/interfaces/v5.AddNodeOpts.html +++ b/interfaces/v5.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.12.2

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.12.3

        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 e1bf638bd1..e8fb93a761 100644 --- a/interfaces/v5.AdvancedOptions.html +++ b/interfaces/v5.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.12.2

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.12.3

        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 d3329f914c..08bfc8997c 100644 --- a/interfaces/v5.AdvancedRepeatOptions.html +++ b/interfaces/v5.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.12.2

        Interface AdvancedRepeatOptions

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

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.12.3

        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 71d37bc033..2318736d34 100644 --- a/interfaces/v5.BackoffOptions.html +++ b/interfaces/v5.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.12.2

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.12.3

        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 0cf284a44e..09c5366153 100644 --- a/interfaces/v5.BaseJobOptions.html +++ b/interfaces/v5.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.12.2

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

        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 6067ccc8be..a9329ce5b4 100644 --- a/interfaces/v5.BaseOptions.html +++ b/interfaces/v5.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.12.2

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

        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 564cc9d5b4..5bb0154265 100644 --- a/interfaces/v5.BuiltInStrategies.html +++ b/interfaces/v5.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.12.2

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

        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 3c91d79928..0432d03c55 100644 --- a/interfaces/v5.ChildMessage.html +++ b/interfaces/v5.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.12.2

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.12.3

        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 ec34c57fc3..029be6c94c 100644 --- a/interfaces/v5.DebounceOptions.html +++ b/interfaces/v5.DebounceOptions.html @@ -1,6 +1,6 @@ -DebounceOptions | bullmq - v5.12.2

        Interface DebounceOptions

        Debounce options

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

        Properties

        id +DebounceOptions | bullmq - v5.12.3

        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 03dbd294b3..c343664616 100644 --- a/interfaces/v5.DefaultJobOptions.html +++ b/interfaces/v5.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.12.2

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

        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 5ae96cfddc..26e29f32a5 100644 --- a/interfaces/v5.DependenciesOpts.html +++ b/interfaces/v5.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.12.2

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.12.3

        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 56254cf7e6..fa666606e0 100644 --- a/interfaces/v5.FlowJobBase.html +++ b/interfaces/v5.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.12.2

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

        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 66428b5fc3..9224498f5e 100644 --- a/interfaces/v5.FlowOpts.html +++ b/interfaces/v5.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.12.2

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.12.3

        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 03e7e1056a..59f296abe7 100644 --- a/interfaces/v5.FlowProducerListener.html +++ b/interfaces/v5.FlowProducerListener.html @@ -1,11 +1,11 @@ -FlowProducerListener | bullmq - v5.12.2

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.12.3

        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 1bab33af30..6025ddaf1d 100644 --- a/interfaces/v5.GetNextJobOptions.html +++ b/interfaces/v5.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.12.2

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

        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 fa4212934d..57138a6fd1 100644 --- a/interfaces/v5.IConnection.html +++ b/interfaces/v5.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.12.2

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.12.3

        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 be10a7c959..8d46a42a1a 100644 --- a/interfaces/v5.IoredisListener.html +++ b/interfaces/v5.IoredisListener.html @@ -1,6 +1,6 @@ -IoredisListener | bullmq - v5.12.2

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.12.3

        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 92cc53f606..2f7b8ee3e6 100644 --- a/interfaces/v5.JobJson.html +++ b/interfaces/v5.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.12.2

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

        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 ebaed66fcf..7de32f75c7 100644 --- a/interfaces/v5.JobJsonRaw.html +++ b/interfaces/v5.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.12.2

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

        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 40c259fea4..79a06e77fe 100644 --- a/interfaces/v5.JobNode.html +++ b/interfaces/v5.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.12.2

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.12.3

        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 241691b177..5eed32bcee 100644 --- a/interfaces/v5.KeepJobs.html +++ b/interfaces/v5.KeepJobs.html @@ -1,9 +1,9 @@ -KeepJobs | bullmq - v5.12.2

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.12.3

        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 3ff5dac0c3..7d58289aae 100644 --- a/interfaces/v5.Metrics.html +++ b/interfaces/v5.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.12.2

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.12.3

        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 f64290d1a9..ad521276ec 100644 --- a/interfaces/v5.MetricsOptions.html +++ b/interfaces/v5.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.12.2

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.12.3

        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 14aeae21ee..391765be7e 100644 --- a/interfaces/v5.MinimalJob.html +++ b/interfaces/v5.MinimalJob.html @@ -1,5 +1,5 @@ -MinimalJob | bullmq - v5.12.2

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

        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 a926202159..2909bd62e5 100644 --- a/interfaces/v5.MoveToDelayedOpts.html +++ b/interfaces/v5.MoveToDelayedOpts.html @@ -1,2 +1,2 @@ -MoveToDelayedOpts | bullmq - v5.12.2

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

        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 5bc52ae6fc..780480b2f7 100644 --- a/interfaces/v5.MoveToWaitingChildrenOpts.html +++ b/interfaces/v5.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.12.2

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

        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 2a55eab545..f18972726d 100644 --- a/interfaces/v5.NodeOpts.html +++ b/interfaces/v5.NodeOpts.html @@ -1,11 +1,11 @@ -NodeOpts | bullmq - v5.12.2

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.12.3

        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 dd4fc100b5..c4656d3725 100644 --- a/interfaces/v5.ObliterateOpts.html +++ b/interfaces/v5.ObliterateOpts.html @@ -1,9 +1,9 @@ -ObliterateOpts | bullmq - v5.12.2

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.12.3

        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 4630dc3d41..9122db6b86 100644 --- a/interfaces/v5.Parent.html +++ b/interfaces/v5.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.12.2

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

        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 d20e4095d8..77102458a5 100644 --- a/interfaces/v5.ParentKeys.html +++ b/interfaces/v5.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.12.2

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.12.3

        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 cd82a275b0..7258f543c1 100644 --- a/interfaces/v5.ParentMessage.html +++ b/interfaces/v5.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.12.2

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.12.3

        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 544fa38357..004d5d4786 100644 --- a/interfaces/v5.QueueBaseOptions.html +++ b/interfaces/v5.QueueBaseOptions.html @@ -1,12 +1,12 @@ -QueueBaseOptions | bullmq - v5.12.2

        Interface QueueBaseOptions

        Base Queue options

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

        Hierarchy (view full)

        Properties

        blockingConnection? +QueueBaseOptions | bullmq - v5.12.3

        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 70861ef629..a1b73e538e 100644 --- a/interfaces/v5.QueueEventsListener.html +++ b/interfaces/v5.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.12.2

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

        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 f467f50d59..fdd968948b 100644 --- a/interfaces/v5.QueueEventsOptions.html +++ b/interfaces/v5.QueueEventsOptions.html @@ -1,5 +1,5 @@ -QueueEventsOptions | bullmq - v5.12.2

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

                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 12d3a3ecf3..f72c6c928c 100644 --- a/interfaces/v5.QueueListener.html +++ b/interfaces/v5.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.12.2

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

                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 8a8ded83bc..a06af21466 100644 --- a/interfaces/v5.QueueOptions.html +++ b/interfaces/v5.QueueOptions.html @@ -1,5 +1,5 @@ -QueueOptions | bullmq - v5.12.2

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

                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 5c4ad2ea29..809031e0a5 100644 --- a/interfaces/v5.RateLimiterOptions.html +++ b/interfaces/v5.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.12.2

                Interface RateLimiterOptions

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

                Properties

                duration +RateLimiterOptions | bullmq - v5.12.3

                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 e042221827..85f4bcc33e 100644 --- a/interfaces/v5.RawCommand.html +++ b/interfaces/v5.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.12.2

                Interface RawCommand

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

                Properties

                content +RawCommand | bullmq - v5.12.3

                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 171c28e2f7..ea8ab6dcd4 100644 --- a/interfaces/v5.RepeatBaseOptions.html +++ b/interfaces/v5.RepeatBaseOptions.html @@ -1,13 +1,13 @@ -RepeatBaseOptions | bullmq - v5.12.2

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

                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 802b776872..e25f6b666a 100644 --- a/interfaces/v5.RepeatOptions.html +++ b/interfaces/v5.RepeatOptions.html @@ -1,6 +1,6 @@ -RepeatOptions | bullmq - v5.12.2

                Interface RepeatOptions

                Settings for repeatable jobs

                +RepeatOptions | bullmq - v5.12.3

                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 8147ff6f62..d0c8476aa9 100644 --- a/interfaces/v5.SandboxedJob.html +++ b/interfaces/v5.SandboxedJob.html @@ -1,5 +1,5 @@ -SandboxedJob | bullmq - v5.12.2

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

                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 fc816f1e57..48a527c7e6 100644 --- a/interfaces/v5.WorkerListener.html +++ b/interfaces/v5.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.12.2

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

                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 c0ad9f6efa..a521098b54 100644 --- a/interfaces/v5.WorkerOptions.html +++ b/interfaces/v5.WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | bullmq - v5.12.2

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

                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 153afbc1f3..62dfdc3e68 100644 --- a/modules/v1.html +++ b/modules/v1.html @@ -1,4 +1,4 @@ -v1 | bullmq - v5.12.2

                Module v1

                Enumerations

                ChildCommand +v1 | bullmq - v5.12.3

                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 9a236a6444..91a86d936a 100644 --- a/modules/v2.html +++ b/modules/v2.html @@ -1,4 +1,4 @@ -v2 | bullmq - v5.12.2

                Module v2

                Enumerations

                ChildCommand +v2 | bullmq - v5.12.3

                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 58c8b7d84c..11bc7cfe3b 100644 --- a/modules/v3.html +++ b/modules/v3.html @@ -1,4 +1,4 @@ -v3 | bullmq - v5.12.2

                Module v3

                Enumerations

                ChildCommand +v3 | bullmq - v5.12.3

                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 6090ab8914..25d2f8a06f 100644 --- a/modules/v4.html +++ b/modules/v4.html @@ -1,4 +1,4 @@ -v4 | bullmq - v5.12.2

                Module v4

                Index

                Enumerations

                ChildCommand +v4 | bullmq - v5.12.3

                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 1dd992ef7e..3ec9dc2b7b 100644 --- a/modules/v5.html +++ b/modules/v5.html @@ -1,4 +1,4 @@ -v5 | bullmq - v5.12.2

                Module v5

                Index

                Enumerations

                ChildCommand +v5 | bullmq - v5.12.3

                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 a6c7a1f385..11b4f05565 100644 --- a/types/v4.BackoffStrategy.html +++ b/types/v4.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.12.2

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

                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 253f628d51..212195b384 100644 --- a/types/v4.BulkJobOptions.html +++ b/types/v4.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.12.2

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 cc3fe3ee3c..59a4e56fa9 100644 --- a/types/v4.ClusterOptions.html +++ b/types/v4.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.12.2

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 213cf305ae..95a3c9ac48 100644 --- a/types/v4.ConnectionOptions.html +++ b/types/v4.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.12.2

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

                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 18490a108a..0adb9584a6 100644 --- a/types/v4.EntryId.html +++ b/types/v4.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.12.2

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 c43769d166..70318f7346 100644 --- a/types/v4.EntryRaw.html +++ b/types/v4.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.12.2

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 6e9e39d227..952308b159 100644 --- a/types/v4.FinishedPropValAttribute.html +++ b/types/v4.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.12.2

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 6e0cc571c1..5ef70a47f9 100644 --- a/types/v4.FinishedStatus.html +++ b/types/v4.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.12.2

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 39358787f5..b03cdf1bfe 100644 --- a/types/v4.FlowChildJob.html +++ b/types/v4.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.12.2

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

                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 165f696e0f..7aee66d1b3 100644 --- a/types/v4.FlowJob.html +++ b/types/v4.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.12.2

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 01f6aa2284..b4fc737644 100644 --- a/types/v4.FlowQueuesOpts.html +++ b/types/v4.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.12.2

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

                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 1fc9edd555..cda409a4a2 100644 --- a/types/v4.JobData.html +++ b/types/v4.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.12.2

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 5dd38c7aeb..def1bb9e71 100644 --- a/types/v4.JobJsonSandbox.html +++ b/types/v4.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.12.2

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

                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 113b14c335..ae69a18b56 100644 --- a/types/v4.JobState.html +++ b/types/v4.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.12.2

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

                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 39e8b52111..52f282c2f5 100644 --- a/types/v4.JobType.html +++ b/types/v4.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.12.2

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

                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 d18030c175..b3fe10ea63 100644 --- a/types/v4.JobsOptions.html +++ b/types/v4.JobsOptions.html @@ -1,3 +1,3 @@ -JobsOptions | bullmq - v5.12.2

                Type alias JobsOptions

                JobsOptions: BaseJobOptions & {
                    failParentOnFailure?: boolean;
                    removeDependencyOnFailure?: boolean;
                }

                Type declaration

                • Optional failParentOnFailure?: boolean

                  If true, moves parent to failed.

                  +JobsOptions | bullmq - v5.12.3

                  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 c08707f84a..23e97e8497 100644 --- a/types/v4.KeysMap.html +++ b/types/v4.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.12.2

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

                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 a6bf6834ff..9dea4dcaf2 100644 --- a/types/v4.MinimalQueue.html +++ b/types/v4.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.12.2

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

                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 c46246d23a..0b6fe1a885 100644 --- a/types/v4.ParentOpts.html +++ b/types/v4.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.12.2

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

                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 75631bf604..8da75a3ea5 100644 --- a/types/v4.Processor.html +++ b/types/v4.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.12.2

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

                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 4b3e19cffb..c4bd4098bc 100644 --- a/types/v4.RedisClient.html +++ b/types/v4.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.12.2

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 4fd5ff0efa..88951896f4 100644 --- a/types/v4.RedisJobOptions.html +++ b/types/v4.RedisJobOptions.html @@ -1,5 +1,5 @@ -RedisJobOptions | bullmq - v5.12.2

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

                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 3c6b697454..6255f51e66 100644 --- a/types/v4.RedisOptions.html +++ b/types/v4.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.12.2

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 8bcbbcfce7..a2bd06129d 100644 --- a/types/v4.RepeatStrategy.html +++ b/types/v4.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.12.2

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

                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 08694a9924..29fc182c28 100644 --- a/types/v4.RepeatableJob.html +++ b/types/v4.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.12.2

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

                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 a59e7f5ac1..720adec44b 100644 --- a/types/v4.SandboxedJobProcessor.html +++ b/types/v4.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.12.2

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

                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 6d2e60495b..fc92f10c62 100644 --- a/types/v4.StreamName.html +++ b/types/v4.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.12.2

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 1a24aec19c..273060c0ca 100644 --- a/types/v4.StreamReadRaw.html +++ b/types/v4.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.12.2

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

                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 91b5d164c7..9cb14b6a51 100644 --- a/types/v5.BackoffStrategy.html +++ b/types/v5.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.12.2

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

                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 42e2901d0c..4bebc17186 100644 --- a/types/v5.BulkJobOptions.html +++ b/types/v5.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.12.2

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 3293bf42be..8ce81a6286 100644 --- a/types/v5.ClusterOptions.html +++ b/types/v5.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.12.2

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 2bad05b1b5..b2f455fe8e 100644 --- a/types/v5.ConnectionOptions.html +++ b/types/v5.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.12.2

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

                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 e45f1e7222..e7531e0f84 100644 --- a/types/v5.EntryId.html +++ b/types/v5.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.12.2

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 d0a8835f4e..0a6fc9b99e 100644 --- a/types/v5.EntryRaw.html +++ b/types/v5.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.12.2

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 14c56a9e02..5ec171b21e 100644 --- a/types/v5.FinishedPropValAttribute.html +++ b/types/v5.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.12.2

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 6589e2b5ad..f6a02594f2 100644 --- a/types/v5.FinishedStatus.html +++ b/types/v5.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.12.2

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 c2eb63814f..cc644fa45c 100644 --- a/types/v5.FlowChildJob.html +++ b/types/v5.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.12.2

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

                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 57d7d14c7c..b031c9461a 100644 --- a/types/v5.FlowJob.html +++ b/types/v5.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.12.2

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 27bc84e952..f2ae44eebc 100644 --- a/types/v5.FlowQueuesOpts.html +++ b/types/v5.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.12.2

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

                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 c3aa1e284c..526485263d 100644 --- a/types/v5.JobData.html +++ b/types/v5.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.12.2

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 f53ca0cadc..d7e5355cca 100644 --- a/types/v5.JobJsonSandbox.html +++ b/types/v5.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.12.2

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

                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 931d1bf56a..67fad61f5b 100644 --- a/types/v5.JobState.html +++ b/types/v5.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.12.2

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

                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 37e8689306..e702555e4b 100644 --- a/types/v5.JobType.html +++ b/types/v5.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.12.2

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

                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 3a15d0586c..b4588125be 100644 --- a/types/v5.JobsOptions.html +++ b/types/v5.JobsOptions.html @@ -1,5 +1,5 @@ -JobsOptions | bullmq - v5.12.2

                Type alias JobsOptions

                JobsOptions: BaseJobOptions & {
                    debounce?: DebounceOptions;
                    failParentOnFailure?: boolean;
                    ignoreDependencyOnFailure?: boolean;
                    removeDependencyOnFailure?: boolean;
                }

                Type declaration

                • Optional debounce?: DebounceOptions

                  Debounce options.

                  +JobsOptions | bullmq - v5.12.3

                  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 e6ea52fd3c..59ca1bbd36 100644 --- a/types/v5.KeysMap.html +++ b/types/v5.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.12.2

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

                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 f7bd2d927f..74a2427c57 100644 --- a/types/v5.MinimalQueue.html +++ b/types/v5.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.12.2

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

                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 59e0355468..cfe010895e 100644 --- a/types/v5.ParentOpts.html +++ b/types/v5.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.12.2

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

                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 37514d5859..6f4975a052 100644 --- a/types/v5.Processor.html +++ b/types/v5.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.12.2

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

                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 4c1447e234..41e646ee7a 100644 --- a/types/v5.RedisClient.html +++ b/types/v5.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.12.2

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 c876ef3859..81c1afd410 100644 --- a/types/v5.RedisJobOptions.html +++ b/types/v5.RedisJobOptions.html @@ -1,7 +1,7 @@ -RedisJobOptions | bullmq - v5.12.2

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

                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 791ca2ffa3..8c69443adf 100644 --- a/types/v5.RedisOptions.html +++ b/types/v5.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.12.2

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 f3ab2c7e27..c4bbc7c36f 100644 --- a/types/v5.RepeatStrategy.html +++ b/types/v5.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.12.2

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

                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 accd9327f7..45f4720424 100644 --- a/types/v5.RepeatableJob.html +++ b/types/v5.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.12.2

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

                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 469b2dc49e..6a72696e67 100644 --- a/types/v5.RepeatableOptions.html +++ b/types/v5.RepeatableOptions.html @@ -1 +1 @@ -RepeatableOptions | bullmq - v5.12.2

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

                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 e4bd7f53c1..1e3961c5e4 100644 --- a/types/v5.SandboxedJobProcessor.html +++ b/types/v5.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.12.2

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

                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 edf1718e1e..08fc7c2093 100644 --- a/types/v5.StreamName.html +++ b/types/v5.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.12.2

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 36fcbd6f8f..16dc2aa3b3 100644 --- a/types/v5.StreamReadRaw.html +++ b/types/v5.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.12.2

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

                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 12bdf17c95..57a402c711 100644 --- a/variables/v1.DELAY_TIME_1.html +++ b/variables/v1.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.2

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

                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 807e8861af..0d11310092 100644 --- a/variables/v1.DELAY_TIME_5.html +++ b/variables/v1.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.2

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

                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 dbe2620486..5ec1d3cb6e 100644 --- a/variables/v1.QUEUE_EVENT_SUFFIX.html +++ b/variables/v1.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.2

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

                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 a733b77051..70bbab812f 100644 --- a/variables/v1.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v1.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.2

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

                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 6c838971d2..95909d7586 100644 --- a/variables/v1.WORKER_SUFFIX.html +++ b/variables/v1.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.2

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.3

                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 f4f8763a61..f612346855 100644 --- a/variables/v1.clientCommandMessageReg.html +++ b/variables/v1.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.2

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 b378b9811e..3fd6be96e4 100644 --- a/variables/v1.errorObject.html +++ b/variables/v1.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.2

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

                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 1318f9b4d9..370d13ab52 100644 --- a/variables/v1.scriptLoader-1.html +++ b/variables/v1.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.2

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.3

                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 bf7198f357..ed396964db 100644 --- a/variables/v2.DELAY_TIME_1.html +++ b/variables/v2.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.2

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

                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 6c7118ece8..71094f0172 100644 --- a/variables/v2.DELAY_TIME_5.html +++ b/variables/v2.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.2

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

                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 c28c1de0ca..67417367c3 100644 --- a/variables/v2.QUEUE_EVENT_SUFFIX.html +++ b/variables/v2.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.2

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

                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 602e120452..84577cc6d4 100644 --- a/variables/v2.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v2.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.12.2

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

                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 861854e285..0890696846 100644 --- a/variables/v2.WORKER_SUFFIX.html +++ b/variables/v2.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.2

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.3

                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 866f7a6ed8..17b8be8cae 100644 --- a/variables/v2.clientCommandMessageReg.html +++ b/variables/v2.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.2

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 f8040e50e0..af1d78b1d8 100644 --- a/variables/v2.errorObject.html +++ b/variables/v2.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.2

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

                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 39bc3d40d3..32668db1cd 100644 --- a/variables/v2.scriptLoader-1.html +++ b/variables/v2.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.2

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.3

                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 a2d9d6ba72..c29eb1602c 100644 --- a/variables/v3.DELAY_TIME_1.html +++ b/variables/v3.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.2

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

                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 5bdb503a7c..6d0e56f752 100644 --- a/variables/v3.DELAY_TIME_5.html +++ b/variables/v3.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.2

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

                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 8df9c89242..f4115081d2 100644 --- a/variables/v3.QUEUE_EVENT_SUFFIX.html +++ b/variables/v3.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.2

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

                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 591cbc425e..b35d4a934e 100644 --- a/variables/v3.WORKER_SUFFIX.html +++ b/variables/v3.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.2

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.3

                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 96169a1225..d72497a89c 100644 --- a/variables/v3.clientCommandMessageReg.html +++ b/variables/v3.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.2

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 cbeb93c93d..e881c1e40e 100644 --- a/variables/v3.errorObject.html +++ b/variables/v3.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.2

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

                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 1271b3a916..491f8c6d93 100644 --- a/variables/v3.scriptLoader-1.html +++ b/variables/v3.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.2

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.3

                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 0cd871f588..b1be4c4b2e 100644 --- a/variables/v4.DELAY_TIME_1.html +++ b/variables/v4.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.2

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

                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 e8b551c284..a54df42459 100644 --- a/variables/v4.DELAY_TIME_5.html +++ b/variables/v4.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.2

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

                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 cd58d2f08a..f0b4718896 100644 --- a/variables/v4.PRIORITY_LIMIT.html +++ b/variables/v4.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.12.2

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 26a2b2f3a5..ae8aae789e 100644 --- a/variables/v4.QUEUE_EVENT_SUFFIX.html +++ b/variables/v4.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.2

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

                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 85914e810d..9d6f39f875 100644 --- a/variables/v4.RATE_LIMIT_ERROR.html +++ b/variables/v4.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.12.2

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

                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 d7a2730e24..ba86e63137 100644 --- a/variables/v4.WORKER_SUFFIX.html +++ b/variables/v4.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.12.2

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.12.3

                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 46781944c1..4d5b8dc0a1 100644 --- a/variables/v4.clientCommandMessageReg.html +++ b/variables/v4.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.2

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 4491ac9799..a94095a06a 100644 --- a/variables/v4.errorObject.html +++ b/variables/v4.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.2

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

                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 e37994946c..1498bf06c9 100644 --- a/variables/v4.scriptLoader-1.html +++ b/variables/v4.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.12.2

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.12.3

                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 c4d259bb07..a44bf16482 100644 --- a/variables/v5.DELAY_TIME_1.html +++ b/variables/v5.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.12.2

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

                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 971e1dd533..d278d560da 100644 --- a/variables/v5.DELAY_TIME_5.html +++ b/variables/v5.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.12.2

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

                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 1d79219c60..eaf386194d 100644 --- a/variables/v5.PRIORITY_LIMIT.html +++ b/variables/v5.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.12.2

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 189092f670..137f75631f 100644 --- a/variables/v5.QUEUE_EVENT_SUFFIX.html +++ b/variables/v5.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.12.2

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

                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 fc8f1843ca..7a16cf6001 100644 --- a/variables/v5.RATE_LIMIT_ERROR.html +++ b/variables/v5.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.12.2

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

                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 9165b11e34..4d5c54d867 100644 --- a/variables/v5.clientCommandMessageReg.html +++ b/variables/v5.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.12.2

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 819b7d0e2d..cc791e46bd 100644 --- a/variables/v5.errorObject.html +++ b/variables/v5.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.12.2

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

                Variable errorObjectConst

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

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file