From 1d1fe5f35849143aa1a404aae4d5d46560e81468 Mon Sep 17 00:00:00 2001 From: roggervalf Date: Wed, 4 Dec 2024 06:17:20 +0000 Subject: [PATCH] deploy: 3402bfe0d01e5e5205db74d2106cd19d7df53fcb --- 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 | 126 ++++++++-------- classes/v5.JobScheduler.html | 22 +-- classes/v5.Queue.html | 144 +++++++++---------- classes/v5.QueueBase.html | 22 +-- classes/v5.QueueEvents.html | 24 ++-- classes/v5.QueueEventsProducer.html | 24 ++-- classes/v5.QueueGetters.html | 80 +++++------ classes/v5.QueueKeys.html | 4 +- classes/v5.RateLimitError.html | 6 +- classes/v5.RedisConnection.html | 6 +- classes/v5.Repeat.html | 22 +-- classes/v5.Scripts.html | 16 +-- classes/v5.UnrecoverableError.html | 6 +- classes/v5.WaitingChildrenError.html | 6 +- classes/v5.Worker.html | 40 +++--- 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 +- enums/v5.SpanKind.html | 4 +- enums/v5.TelemetryAttributes.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.defaultRepeatStrategy.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.optsAsJSON.html | 2 +- functions/v5.optsFromJSON.html | 2 +- functions/v5.parseObjectValues.html | 2 +- functions/v5.raw2NextJobData.html | 2 +- functions/v5.removeAllQueueData.html | 2 +- functions/v5.removeUndefinedFields.html | 2 +- functions/v5.toString.html | 2 +- functions/v5.trace.html | 4 +- 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.Attributes.html | 2 +- interfaces/v5.BackoffOptions.html | 8 +- interfaces/v5.BaseJobOptions.html | 36 ++--- interfaces/v5.BaseOptions.html | 4 +- interfaces/v5.BuiltInStrategies.html | 2 +- interfaces/v5.ChildMessage.html | 4 +- interfaces/v5.ContextManager.html | 12 +- 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.JobSchedulerJson.html | 4 +- interfaces/v5.JobSchedulerTemplateJson.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 | 14 +- interfaces/v5.QueueEventsListener.html | 42 +++--- interfaces/v5.QueueEventsOptions.html | 20 +-- interfaces/v5.QueueListener.html | 18 +-- interfaces/v5.QueueOptions.html | 20 +-- interfaces/v5.RateLimiterOptions.html | 6 +- interfaces/v5.RawCommand.html | 4 +- interfaces/v5.RepeatBaseOptions.html | 14 +- interfaces/v5.RepeatOptions.html | 22 +-- interfaces/v5.SandboxedJob.html | 6 +- interfaces/v5.SandboxedOptions.html | 8 +- interfaces/v5.Span.html | 16 +-- interfaces/v5.SpanOptions.html | 4 +- interfaces/v5.Telemetry.html | 8 +- interfaces/v5.Tracer.html | 6 +- interfaces/v5.WorkerListener.html | 28 ++-- interfaces/v5.WorkerOptions.html | 52 +++---- 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.AttributeValue.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.Exception.html | 2 +- types/v5.ExceptionType.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 +- types/v5.Time.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 +- 561 files changed, 1366 insertions(+), 1366 deletions(-) diff --git a/classes/v1.Backoffs.html b/classes/v1.Backoffs.html index e9fefd22c7..c1b36cc7f3 100644 --- a/classes/v1.Backoffs.html +++ b/classes/v1.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.30.1

Class Backoffs

Constructors

constructor +Backoffs | bullmq - v5.31.0

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 e43033bff1..8b8181595f 100644 --- a/classes/v1.ChildPool.html +++ b/classes/v1.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.30.1

Class ChildPool

Constructors

constructor +ChildPool | bullmq - v5.31.0

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 6bbf0b93b1..445750b382 100644 --- a/classes/v1.ChildProcessor.html +++ b/classes/v1.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.30.1

Class ChildProcessor

ChildProcessor

+ChildProcessor | bullmq - v5.31.0

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 9dca3d1778..eeecbefffe 100644 --- a/classes/v1.FlowProducer.html +++ b/classes/v1.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.30.1

Class FlowProducer

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

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 cffe9250c3..0e8f5c0836 100644 --- a/classes/v1.Job.html +++ b/classes/v1.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.30.1

Class Job<DataType, ReturnType, NameType>

Job

+Job | bullmq - v5.31.0

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 9720207f04..f6ddc58c9d 100644 --- a/classes/v1.Queue.html +++ b/classes/v1.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.30.1

Class Queue<DataType, ResultType, NameType>

Queue

+Queue | bullmq - v5.31.0

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 96416cb0fb..e5a351ff67 100644 --- a/classes/v1.Queue3.html +++ b/classes/v1.Queue3.html @@ -1,4 +1,4 @@ -Queue3 | bullmq - v5.30.1

Class Queue3<T>

Deprecated

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

+Queue3 | bullmq - v5.31.0

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 61a9a481f8..64b9d815a1 100644 --- a/classes/v1.QueueBase.html +++ b/classes/v1.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.30.1

Class QueueBase

Description

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

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 63e92e1f37..80ad91d814 100644 --- a/classes/v1.QueueEvents.html +++ b/classes/v1.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.30.1

    Class QueueEvents

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

    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 290bdf47a7..00f914c3f0 100644 --- a/classes/v1.QueueGetters.html +++ b/classes/v1.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.30.1

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.31.0

    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 5602bdfea4..10fa6d710c 100644 --- a/classes/v1.QueueKeys.html +++ b/classes/v1.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.30.1

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.31.0

    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 ce1bf7798e..35df4bad5d 100644 --- a/classes/v1.QueueScheduler.html +++ b/classes/v1.QueueScheduler.html @@ -1,4 +1,4 @@ -QueueScheduler | bullmq - v5.30.1

    Class QueueScheduler

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

    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 1cd309e609..897ff4063a 100644 --- a/classes/v1.RedisConnection.html +++ b/classes/v1.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.30.1

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.31.0

    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 5f8b9c1acc..14047ea984 100644 --- a/classes/v1.Repeat.html +++ b/classes/v1.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.30.1

    Class Repeat

    Description

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

    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 60f6a18b1c..c02cc73b11 100644 --- a/classes/v1.ScriptLoader.html +++ b/classes/v1.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.30.1

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.31.0

    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 65a884c297..30a17929d8 100644 --- a/classes/v1.ScriptLoaderError.html +++ b/classes/v1.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.30.1

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.31.0

    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 d33f33a301..329642b118 100644 --- a/classes/v1.Scripts.html +++ b/classes/v1.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.30.1

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.31.0

    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 7ace355c53..131da5a7a7 100644 --- a/classes/v1.TimerManager.html +++ b/classes/v1.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.30.1

    Class TimerManager

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

    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 2056c29641..12299e4397 100644 --- a/classes/v1.UnrecoverableError.html +++ b/classes/v1.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.30.1

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.31.0

    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 266dbd9a70..263bfbe4d7 100644 --- a/classes/v1.Worker.html +++ b/classes/v1.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.30.1

    Class Worker<DataType, ResultType, NameType>

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

    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 ca83d3418b..99b44f3cf5 100644 --- a/classes/v2.Backoffs.html +++ b/classes/v2.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.30.1

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.31.0

    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 1d545acbde..0e26ce5247 100644 --- a/classes/v2.ChildPool.html +++ b/classes/v2.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.30.1

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.31.0

    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 1c731e7225..66b315524b 100644 --- a/classes/v2.ChildProcessor.html +++ b/classes/v2.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.30.1

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.31.0

    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 5aab2b1f7d..ee87f6cc58 100644 --- a/classes/v2.FlowProducer.html +++ b/classes/v2.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.30.1

    Class FlowProducer

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

    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 86cfd72b17..95c796e6c8 100644 --- a/classes/v2.Job.html +++ b/classes/v2.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.30.1

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.31.0

    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 f486e052af..32e9f648a1 100644 --- a/classes/v2.Queue.html +++ b/classes/v2.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.30.1

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.31.0

    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 91dffebd43..e570705e83 100644 --- a/classes/v2.QueueBase.html +++ b/classes/v2.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.30.1

    Class QueueBase

    Description

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

    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 79d5139ccd..7cf4fa50f0 100644 --- a/classes/v2.QueueEvents.html +++ b/classes/v2.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.30.1

    Class QueueEvents

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

    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 585dbba385..41c1b0746b 100644 --- a/classes/v2.QueueGetters.html +++ b/classes/v2.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.30.1

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.31.0

    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 f449ec1595..b5d019d293 100644 --- a/classes/v2.QueueKeys.html +++ b/classes/v2.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.30.1

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.31.0

    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 2c31841fdd..b4353c4d17 100644 --- a/classes/v2.RedisConnection.html +++ b/classes/v2.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.30.1

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.31.0

    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 04413aa094..2441f4ca69 100644 --- a/classes/v2.Repeat.html +++ b/classes/v2.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.30.1

    Class Repeat

    Description

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

    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 fb0c461861..b21fec19aa 100644 --- a/classes/v2.ScriptLoader.html +++ b/classes/v2.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.30.1

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.31.0

    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 51d468d5e8..9b5a0637df 100644 --- a/classes/v2.ScriptLoaderError.html +++ b/classes/v2.ScriptLoaderError.html @@ -1,7 +1,7 @@ -ScriptLoaderError | bullmq - v5.30.1

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.31.0

    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 435e425ae9..44a6042f50 100644 --- a/classes/v2.Scripts.html +++ b/classes/v2.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.30.1

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.31.0

    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 0d1add1e8b..dcbf1b7a72 100644 --- a/classes/v2.TimerManager.html +++ b/classes/v2.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | bullmq - v5.30.1

    Class TimerManager

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

    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 685663f104..9df955a055 100644 --- a/classes/v2.UnrecoverableError.html +++ b/classes/v2.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.30.1

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.31.0

    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 cb38c71e38..380ccc8a1d 100644 --- a/classes/v2.Worker.html +++ b/classes/v2.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.30.1

    Class Worker<DataType, ResultType, NameType>

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

    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 012a977aa2..0459b3d7e0 100644 --- a/classes/v3.AsyncFifoQueue.html +++ b/classes/v3.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.30.1

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.31.0

    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 6da77e24e9..34ffec9063 100644 --- a/classes/v3.Backoffs.html +++ b/classes/v3.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.30.1

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.31.0

    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 e5f218459b..9972b27c25 100644 --- a/classes/v3.ChildPool.html +++ b/classes/v3.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.30.1

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.31.0

    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 ee6b8d6747..5da28f8d4f 100644 --- a/classes/v3.ChildProcessor.html +++ b/classes/v3.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.30.1

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.31.0

    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 092e5da392..343f8d7c40 100644 --- a/classes/v3.DelayedError.html +++ b/classes/v3.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.30.1

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.31.0

    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 1220e2e0cd..ffcd5d3f6d 100644 --- a/classes/v3.FlowProducer.html +++ b/classes/v3.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.30.1

    Class FlowProducer

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

    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 908a8251e3..3a3a20e6bb 100644 --- a/classes/v3.Job.html +++ b/classes/v3.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.30.1

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.31.0

    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 ea26f05f9c..daf26ddc16 100644 --- a/classes/v3.Queue.html +++ b/classes/v3.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.30.1

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.31.0

    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 6433805e22..b45caaff25 100644 --- a/classes/v3.QueueBase.html +++ b/classes/v3.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.30.1

    Class QueueBase

    Description

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

    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 99cc157ed4..38847cd96a 100644 --- a/classes/v3.QueueEvents.html +++ b/classes/v3.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.30.1

    Class QueueEvents

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

    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 36deb5a130..3704791efc 100644 --- a/classes/v3.QueueGetters.html +++ b/classes/v3.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.30.1

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.31.0

    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 eafe44d2e2..5b6193c728 100644 --- a/classes/v3.QueueKeys.html +++ b/classes/v3.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.30.1

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.31.0

    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 e9e3a64704..6eeddb17d9 100644 --- a/classes/v3.RedisConnection.html +++ b/classes/v3.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.30.1

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.31.0

    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 a3bce6d6d6..1d0b8480f7 100644 --- a/classes/v3.Repeat.html +++ b/classes/v3.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.30.1

    Class Repeat

    Description

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

    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 df0897081d..cb9c7559e6 100644 --- a/classes/v3.ScriptLoader.html +++ b/classes/v3.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.30.1

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.31.0

    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 18e03a1b3d..9a18827ab2 100644 --- a/classes/v3.ScriptLoaderError.html +++ b/classes/v3.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.30.1

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.31.0

    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 ff45968092..1473ac614a 100644 --- a/classes/v3.Scripts.html +++ b/classes/v3.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.30.1

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.31.0

    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 97f36b46f8..e5151ac649 100644 --- a/classes/v3.UnrecoverableError.html +++ b/classes/v3.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.30.1

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.31.0

    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 863a622f19..96e9c5e211 100644 --- a/classes/v3.WaitingChildrenError.html +++ b/classes/v3.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.30.1

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.31.0

    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 69408656a8..e67b471b9c 100644 --- a/classes/v3.Worker.html +++ b/classes/v3.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.30.1

    Class Worker<DataType, ResultType, NameType>

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

    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 3e4a76224e..03b3b54c64 100644 --- a/classes/v4.AsyncFifoQueue.html +++ b/classes/v4.AsyncFifoQueue.html @@ -1,4 +1,4 @@ -AsyncFifoQueue | bullmq - v5.30.1

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.31.0

    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 1e50b1b552..4e9816ab32 100644 --- a/classes/v4.Backoffs.html +++ b/classes/v4.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.30.1

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.31.0

    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 5fe24e95c6..b643090d94 100644 --- a/classes/v4.ChildPool.html +++ b/classes/v4.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.30.1

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.31.0

    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 7cb8dadc24..e50db55fcd 100644 --- a/classes/v4.ChildProcessor.html +++ b/classes/v4.ChildProcessor.html @@ -1,4 +1,4 @@ -ChildProcessor | bullmq - v5.30.1

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.31.0

    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 86f8e0c055..a62b3c466a 100644 --- a/classes/v4.DelayedError.html +++ b/classes/v4.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.30.1

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.31.0

    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 847e4b9ac6..f7283383fa 100644 --- a/classes/v4.FlowProducer.html +++ b/classes/v4.FlowProducer.html @@ -1,4 +1,4 @@ -FlowProducer | bullmq - v5.30.1

    Class FlowProducer

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

    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 a741528aac..204baf0f94 100644 --- a/classes/v4.Job.html +++ b/classes/v4.Job.html @@ -1,4 +1,4 @@ -Job | bullmq - v5.30.1

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.31.0

    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 d3e77fcf5e..12df563983 100644 --- a/classes/v4.Queue.html +++ b/classes/v4.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.30.1

    Class Queue<DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.31.0

    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 15003cc66c..e7f2ce68a5 100644 --- a/classes/v4.QueueBase.html +++ b/classes/v4.QueueBase.html @@ -1,4 +1,4 @@ -QueueBase | bullmq - v5.30.1

    Class QueueBase

    Description

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

    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 7b16c156e2..db16cbacb9 100644 --- a/classes/v4.QueueEvents.html +++ b/classes/v4.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | bullmq - v5.30.1

    Class QueueEvents

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

    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 2d7f5c3924..5506c02cd2 100644 --- a/classes/v4.QueueGetters.html +++ b/classes/v4.QueueGetters.html @@ -1,4 +1,4 @@ -QueueGetters | bullmq - v5.30.1

    Class QueueGetters<DataType, ResultType, NameType>

    Description

    Provides different getters for different aspects of a queue.

    +QueueGetters | bullmq - v5.31.0

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

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.31.0

    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 1849ffb037..fa490af50a 100644 --- a/classes/v4.RateLimitError.html +++ b/classes/v4.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.30.1

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.31.0

    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 392671ce05..a5abb731d7 100644 --- a/classes/v4.RedisConnection.html +++ b/classes/v4.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.30.1

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.31.0

    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 eedfe2c771..dcc9b2a8db 100644 --- a/classes/v4.Repeat.html +++ b/classes/v4.Repeat.html @@ -1,4 +1,4 @@ -Repeat | bullmq - v5.30.1

    Class Repeat

    Description

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

    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 22c73744df..5554befd61 100644 --- a/classes/v4.ScriptLoader.html +++ b/classes/v4.ScriptLoader.html @@ -1,4 +1,4 @@ -ScriptLoader | bullmq - v5.30.1

    Class ScriptLoader

    Lua script loader with include support

    +ScriptLoader | bullmq - v5.31.0

    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 86a8e0e9e9..53a7e0066e 100644 --- a/classes/v4.ScriptLoaderError.html +++ b/classes/v4.ScriptLoaderError.html @@ -1,6 +1,6 @@ -ScriptLoaderError | bullmq - v5.30.1

    Class ScriptLoaderError

    Hierarchy

    • Error
      • ScriptLoaderError

    Constructors

    constructor +ScriptLoaderError | bullmq - v5.31.0

    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 548a039c18..f952379483 100644 --- a/classes/v4.Scripts.html +++ b/classes/v4.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.30.1

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.31.0

    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 39033440c1..638214c6d8 100644 --- a/classes/v4.UnrecoverableError.html +++ b/classes/v4.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.30.1

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.31.0

    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 4f58dd81d0..705185f753 100644 --- a/classes/v4.WaitingChildrenError.html +++ b/classes/v4.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.30.1

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.31.0

    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 1f2a2344d0..faf2751096 100644 --- a/classes/v4.Worker.html +++ b/classes/v4.Worker.html @@ -1,4 +1,4 @@ -Worker | bullmq - v5.30.1

    Class Worker<DataType, ResultType, NameType>

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

    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 4d31dd247d..afc63aff85 100644 --- a/classes/v5.AsyncFifoQueue.html +++ b/classes/v5.AsyncFifoQueue.html @@ -1,11 +1,11 @@ -AsyncFifoQueue | bullmq - v5.30.1

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

    +AsyncFifoQueue | bullmq - v5.31.0

    Class AsyncFifoQueue<T>

    AsyncFifoQueue

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

    -

    Type Parameters

    • T

    Constructors

    constructor +

    Type Parameters

    • T

    Constructors

    constructor

    Methods

    add fetch numPending numQueued numTotal waitAll -

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    add

    fetch

    numPending

    numQueued

    numTotal

    waitAll

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.Backoffs.html b/classes/v5.Backoffs.html index 72b447f601..8b9a5edfc3 100644 --- a/classes/v5.Backoffs.html +++ b/classes/v5.Backoffs.html @@ -1,5 +1,5 @@ -Backoffs | bullmq - v5.30.1

    Class Backoffs

    Constructors

    constructor +Backoffs | bullmq - v5.31.0

    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 25389dd6ab..c12ca6f3d7 100644 --- a/classes/v5.ChildPool.html +++ b/classes/v5.ChildPool.html @@ -1,4 +1,4 @@ -ChildPool | bullmq - v5.30.1

    Class ChildPool

    Constructors

    constructor +ChildPool | bullmq - v5.31.0

    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, exitHandler): Promise<Child>

    • Parameters

      • processFile: string
      • exitHandler: any

      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, exitHandler): Promise<Child>

    • Parameters

      • processFile: string
      • exitHandler: any

      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 fb3d9e936a..fc976dc064 100644 --- a/classes/v5.ChildProcessor.html +++ b/classes/v5.ChildProcessor.html @@ -1,7 +1,7 @@ -ChildProcessor | bullmq - v5.30.1

    Class ChildProcessor

    ChildProcessor

    +ChildProcessor | bullmq - v5.31.0

    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 0113078177..0f0fb9d03f 100644 --- a/classes/v5.DelayedError.html +++ b/classes/v5.DelayedError.html @@ -1,5 +1,5 @@ -DelayedError | bullmq - v5.30.1

    Class DelayedError

    DelayedError

    +DelayedError | bullmq - v5.31.0

    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 b510cf6079..710ac0a169 100644 --- a/classes/v5.FlowProducer.html +++ b/classes/v5.FlowProducer.html @@ -1,10 +1,10 @@ -FlowProducer | bullmq - v5.30.1

    Class FlowProducer

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

    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 73bbd458ff..e2b1927440 100644 --- a/classes/v5.Job.html +++ b/classes/v5.Job.html @@ -1,9 +1,9 @@ -Job | bullmq - v5.30.1

    Class Job<DataType, ReturnType, NameType>

    Job

    +Job | bullmq - v5.31.0

    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 @@ -69,145 +69,145 @@

    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.

    +

    data

    data: DataType

    The payload for this job.

    +

    Optional debounceId

    debounceId?: string

    Debounce identifier.

    Deprecated

    use deduplicationId

    -

    Optional deduplicationId

    deduplicationId?: string

    Deduplication identifier.

    -

    delay

    delay: number = 0

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

    +

    Optional deduplicationId

    deduplicationId?: string

    Deduplication identifier.

    +

    delay

    delay: number = 0

    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.

    -

    priority

    priority: number = 0

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that +

    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.

    +

    priority

    priority: number = 0

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

    Default Value

    0
    -

    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.

    +

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

        options containing priority and lifo values.

        • Optional lifo?: boolean
        • Optional priority?: number

      Returns Promise<void>

      void

      -

    clearLogs

    clearLogs

    • clearLogs(keepLogs?): Promise<void>

    • Clears job's logs

      Parameters

      • Optional keepLogs: number

        the amount of log entries to preserve

        -

      Returns Promise<void>

    discard

    • discard(): void

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

      -

      Returns void

    extendLock

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

    • Extend the lock for this job.

      +

    Returns Promise<void>

    discard

    • discard(): void

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

      +

      Returns void

    extendLock

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

    • Extend the lock for this job.

      Parameters

      • token: string

        unique token for the lock

      • duration: number

        lock duration in milliseconds

        -

      Returns Promise<number>

    getChildrenValues

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

    • Get this jobs children result values if any.

      +

    Returns Promise<number>

    getChildrenValues

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

    • Get this jobs children result values if any.

      Type Parameters

      • CT = any

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

      Object mapping children job keys with their values.

      -

    getDependencies

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

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

      +

    getDependencies

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

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

      Parameters

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

      dependencies separated by processed and unprocessed.

      Remarks

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

      See

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

      -

    getDependenciesCount

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

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

      +

    getDependenciesCount

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

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

      Parameters

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

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

      dependencies count separated by processed and unprocessed.

      -

    getFailedChildrenValues

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

    • Get this jobs children failure values if any.

      +

    getFailedChildrenValues

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

    • Get this jobs children failure values if any.

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

      Object mapping children job keys with their failure values.

      -

    getState

    getState

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

    • Get current state.

      Returns Promise<"unknown" | JobState>

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

      -

    isActive

    • isActive(): Promise<boolean>

    • Returns Promise<boolean>

      true of the job is active.

      -

    isCompleted

    • isCompleted(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has completed.

      -

    isDelayed

    • isDelayed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is delayed.

      -

    isFailed

    • isFailed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has failed.

      -

    isWaiting

    • isWaiting(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting.

      -

    isWaitingChildren

    • isWaitingChildren(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting for children.

      -

    log

    isActive

    • isActive(): Promise<boolean>

    • Returns Promise<boolean>

      true of the job is active.

      +

    isCompleted

    • isCompleted(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has completed.

      +

    isDelayed

    • isDelayed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is delayed.

      +

    isFailed

    • isFailed(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job has failed.

      +

    isWaiting

    • isWaiting(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting.

      +

    isWaitingChildren

    • isWaitingChildren(): Promise<boolean>

    • Returns Promise<boolean>

      true if the job is waiting for children.

      +

    log

    • log(logRow): Promise<number>

    • Logs one row of log data.

      Parameters

      • logRow: string

        string with log data to be logged.

      Returns Promise<number>

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

      -

    moveToCompleted

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

    • Moves a job to the completed queue. +

    moveToCompleted

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

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

      Parameters

      • returnValue: ReturnType

        The jobs success message.

      • token: string

        Worker token used to acquire completed job.

      • fetchNext: boolean = true

        True when wanting to fetch the next job.

      Returns Promise<void | any[]>

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

      -

    moveToDelayed

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

    • Moves the job to the delay set.

      +

    moveToDelayed

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

    • Moves the job to the delay set.

      Parameters

      • timestamp: number

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

      • Optional token: string

        token to check job is locked by current worker

        -

      Returns Promise<void>

    moveToFailed

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

    • Moves a job to the failed queue.

      +

    Returns Promise<void>

    moveToFailed

    moveToWaitingChildren

    moveToWaitingChildren

    promote

    remove

    promote

    remove

    removeChildDependency

    Returns Promise<void>

    removeChildDependency

    retry

    retry

    toJSON

    updateData

    toJSON

    updateData

    updateProgress

    Returns Promise<void>

    updateProgress

    waitUntilFinished

    Returns Promise<void>

    waitUntilFinished

    Static addJobLog

    Returns Promise<ReturnType>

    Static addJobLog

    Static create

    Static create

    Static createBulk

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

    Static createBulk

    Static fromId

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

    Static fromId

    Static fromJSON

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

    Static fromJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Job<T, R, N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.JobScheduler.html b/classes/v5.JobScheduler.html index 3c77c918d2..d41a33efe5 100644 --- a/classes/v5.JobScheduler.html +++ b/classes/v5.JobScheduler.html @@ -1,7 +1,7 @@ -JobScheduler | bullmq - v5.30.1

    Class JobScheduler

    QueueBase

    +JobScheduler | bullmq - v5.31.0

    Class JobScheduler

    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,17 +20,17 @@ trace upsertJobScheduler 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

    • 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

    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

    getJobScheduler

    getJobSchedulers

    getSchedulersCount

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<number>

    • Parameters

      • jobSchedulerId: string

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +
    • Rest ...args: any[]

    Returns boolean

    getJobScheduler

    getJobSchedulers

    getSchedulersCount

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<number>

    • Parameters

      • jobSchedulerId: string

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    upsertJobScheduler

    • upsertJobScheduler<T, R, N>(jobSchedulerId, repeatOpts, jobName, jobData, opts, __namedParameters): Promise<Job<T, R, N>>

    • Type Parameters

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

      Parameters

      • jobSchedulerId: string
      • repeatOpts: Omit<RepeatOptions, "offset" | "key" | "prevMillis">
      • jobName: N
      • jobData: T
      • opts: Omit<JobsOptions, "repeat" | "jobId" | "delay">
      • __namedParameters: {
            override: boolean;
        }
        • override: boolean

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

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    upsertJobScheduler

    waitUntilReady

    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 cd192413e8..1bc8d98799 100644 --- a/classes/v5.Queue.html +++ b/classes/v5.Queue.html @@ -1,4 +1,4 @@ -Queue | bullmq - v5.30.1

    Class Queue<DataTypeOrJob, DefaultResultType, DefaultNameType, DataType, ResultType, NameType>

    Queue

    +Queue | bullmq - v5.31.0

    Class Queue<DataTypeOrJob, DefaultResultType, DefaultNameType, 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.

    Example

    import { Queue } from 'bullmq';

    interface MyDataType {
     foo: string;
    }

    interface MyResultType {
      bar: string;
    }

    const queue = new Queue<MyDataType, MyResultType, "blue" | "brown">('myQueue');
@@ -6,7 +6,7 @@

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing jobsOpts keys @@ -91,60 +91,60 @@ updateJobProgress upsertJobScheduler 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

    jobScheduler

    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

    jobScheduler

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

      • 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<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getActiveCount

    getCompleted

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    • getDebounceJobId(id): Promise<string>

    • Get jobId that starts debounced state.

      +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getCompletedCount

    getCountsPerPriority

    getDebounceJobId

    getDeduplicationJobId

    getDeduplicationJobId

    getDelayed

    Returns Promise<string>

    getDelayed

    getDelayedCount

    getDependencies

    • getDependencies(parentId, type, start, end): Promise<{
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs: JobJsonRaw[];
          total: number;
      }>

    • Returns the qualified job ids and the raw job data (if available) of the +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getDelayedCount

    getDependencies

    • getDependencies(parentId, type, start, end): Promise<{
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs: JobJsonRaw[];
          total: number;
      }>

    • Returns the qualified job ids and the raw job data (if available) of the children jobs of the given parent job. It is possible to get either the already processed children, in this case an array of qualified job ids and their result values will be returned, @@ -154,43 +154,43 @@ for example: "bull:myqueue:jobid".

      Parameters

      • parentId: string

        The id of the parent job

      • type: "pending" | "processed"

        "processed" | "pending"

        -
      • start: number
      • end: number

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

    getFailed

    • getFailed(start?, end?): Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    • Returns the jobs that are in the "failed" status.

      +
    • start: number
    • end: number

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

    getFailed

    getFailedCount

    getGlobalConcurrency

    • getGlobalConcurrency(): Promise<number>

    • Get global concurrency value. +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getFailedCount

    getGlobalConcurrency

    • getGlobalConcurrency(): Promise<number>

    • Get global concurrency value. Returns null in case no value is set.

      -

      Returns Promise<number>

    getJob

    getJobCountByTypes

    • getJobCountByTypes(...types): Promise<number>

    • Job counts by type

      +

      Returns Promise<number>

    getJob

    getJobCountByTypes

    • getJobCountByTypes(...types): Promise<number>

    • Job counts by type

      Queue#getJobCountByTypes('completed') => completed count Queue#getJobCountByTypes('completed,failed') => completed + failed count Queue#getJobCountByTypes('completed', 'failed') => completed + failed count Queue#getJobCountByTypes('completed', 'waiting', 'failed') => completed + waiting + failed count

      -

      Parameters

      Returns Promise<number>

    getJobCounts

    getJobCounts

    • getJobCounts(...types): Promise<{
          [index: string]: number;
      }>

    • Returns the job counts for each type specified or every list/set in the queue by default.

      Parameters

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

      An object, key (type) and value (count)

      -

    getJobLogs

    getJobLogs

    • getJobLogs(jobId, start?, end?, asc?): Promise<{
          count: number;
          logs: string[];
      }>

    • Returns the logs for a given Job.

      Parameters

      • jobId: string

        the id of the job to get the logs for.

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

      • asc: boolean = true

        if true, the jobs will be returned in ascending order.

        -

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

    getJobScheduler

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

    getJobScheduler

    getJobSchedulers

    • getJobSchedulers(start?, end?, asc?): Promise<RepeatableJob[]>

    • Get all Job Schedulers

      +

    Returns Promise<JobSchedulerJson<DataType>>

    getJobSchedulers

    • getJobSchedulers(start?, end?, asc?): Promise<RepeatableJob[]>

    • Get all Job Schedulers

      Parameters

      • Optional start: number

        Offset of first scheduler to return.

      • Optional end: number

        Offset of last scheduler to return.

      • Optional asc: boolean

        Determine the order in which schedulers are returned based on their next execution time.

        -

      Returns Promise<RepeatableJob[]>

    getJobSchedulersCount

    • getJobSchedulersCount(): Promise<number>

    • Get the number of job schedulers.

      +

    Returns Promise<RepeatableJob[]>

    getJobSchedulersCount

    • getJobSchedulersCount(): Promise<number>

    • Get the number of job schedulers.

      Returns Promise<number>

      The number of job schedulers.

      -

    getJobState

    getJobState

    • getJobState(jobId): Promise<"unknown" | JobState>

    • Get current job state.

      Parameters

      • jobId: string

        job identifier.

      Returns Promise<"unknown" | JobState>

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

      -

    getJobs

    getJobs

    getMetrics

    • getMetrics(type, start?, end?): Promise<Metrics>

    • Get queue metrics related to the queue.

      +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getMetrics

    • getMetrics(type, start?, end?): Promise<Metrics>

    • Get queue metrics related to the queue.

      This method returns the gathered metrics for the queue. The metrics are represented as an array of job counts per unit of time (1 minute).

      @@ -201,110 +201,110 @@

    Returns Promise<Metrics>

    • Returns an object with queue metrics.
    -

    getPrioritized

    getPrioritized

    getPrioritizedCount

    getQueueEvents

    • getQueueEvents(): Promise<{
          [index: string]: string;
      }[]>

    • Get queue events list related to the queue. +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getPrioritizedCount

    getQueueEvents

    • getQueueEvents(): Promise<{
          [index: string]: string;
      }[]>

    • Get queue events list related to the queue. Note: GCP does not support SETNAME, so this call will not work

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

      • Returns an array with queue events info.

      Deprecated

      do not use this method, it will be removed in the future.

      -

    getRanges

    getRateLimitTtl

    getRanges

    getRateLimitTtl

    • getRateLimitTtl(maxJobs?): Promise<number>

    • Returns the time to live for a rate limited key in milliseconds.

      Parameters

      • Optional maxJobs: number

        max jobs to be considered in rate limit state. If not passed it will return the remaining ttl without considering if max jobs is excedeed.

      Returns Promise<number>

      -2 if the key does not exist. -1 if the key exists but has no associated expire.

      See

      https://redis.io/commands/pttl/

      -

    getRepeatableJobs

    getRepeatableJobs

    • getRepeatableJobs(start?, end?, asc?): Promise<RepeatableJob[]>

    • Get all repeatable meta jobs.

      Parameters

      • Optional start: number

        Offset of first job to return.

      • Optional end: number

        Offset of last job to return.

      • Optional asc: boolean

        Determine the order in which jobs are returned based on their next execution time.

      Returns Promise<RepeatableJob[]>

      Deprecated

      This method is deprecated and will be removed in v6. Use getJobSchedulers instead.

      -

    getVersion

    getVersion

    • getVersion(): Promise<string>

    • Get library version.

      Returns Promise<string>

      the content of the meta.library field.

      -

    getWaiting

    getWaiting

    getWaitingChildren

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getWaitingChildren

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    • getWorkers(): Promise<{
          [index: string]: string;
      }[]>

    • Get the worker list related to the queue. i.e. all the known +

    Returns Promise<JobBase<DataTypeOrJob, ResultType, NameType>[]>

    getWaitingChildrenCount

    getWaitingCount

    getWorkers

    • getWorkers(): Promise<{
          [index: string]: string;
      }[]>

    • Get the worker list related to the queue. i.e. all the known workers that are available to process jobs for this queue. Note: GCP does not support SETNAME, so this call will not work

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

      • Returns an array with workers info.
      -

    getWorkersCount

    getWorkersCount

    isMaxed

    • isMaxed(): Promise<boolean>

    • Returns true if the queue is currently maxed.

      -

      Returns Promise<boolean>

    isPaused

    • isPaused(): Promise<boolean>

    • Returns true if the queue is currently paused.

      -

      Returns Promise<boolean>

    obliterate

    isMaxed

    • isMaxed(): Promise<boolean>

    • Returns true if the queue is currently maxed.

      +

      Returns Promise<boolean>

    isPaused

    • isPaused(): Promise<boolean>

    • Returns true if the queue is currently paused.

      +

      Returns Promise<boolean>

    obliterate

    • obliterate(opts?): Promise<void>

    • Completely destroys the queue and all of its contents irreversibly. This method will the pause the queue and requires that there are no active jobs. It is possible to bypass this requirement, i.e. not having active jobs using the "force" option.

      Note: This operation requires to iterate on all the jobs stored in the queue and can be slow for very large queues.

      Parameters

      Returns Promise<void>

    off

    on

    once

    pause

    • pause(): Promise<void>

    • Pauses the processing of this queue globally.

      +

    Returns Promise<void>

    off

    on

    once

    pause

    • pause(): Promise<void>

    • Pauses the processing of this queue globally.

      We use an atomic RENAME operation on the wait queue. Since we have blocking calls with BRPOPLPUSH on the wait queue, as long as the queue is renamed to 'paused', no new jobs will be processed (the current ones will run until finalized).

      Adding jobs requires a LUA script to check first if the paused list exist and in that case it will add it there instead of the wait list.

      -

      Returns Promise<void>

    promoteJobs

    • promoteJobs(opts?): Promise<void>

    • Promote all the delayed jobs.

      -

      Parameters

      • opts: {
            count?: number;
        } = {}
        • Optional count?: number

      Returns Promise<void>

    rateLimit

    • rateLimit(expireTimeMs): Promise<void>

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

      +

      Returns Promise<void>

    promoteJobs

    • promoteJobs(opts?): Promise<void>

    • Promote all the delayed jobs.

      +

      Parameters

      • opts: {
            count?: number;
        } = {}
        • Optional count?: number

      Returns Promise<void>

    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>

    remove

    • remove(jobId, opts?): Promise<number>

    • Removes the given job from the queue as well as all its +

    Returns Promise<void>

    remove

    • remove(jobId, opts?): Promise<number>

    • Removes the given job from the queue as well as all its dependencies.

      Parameters

      • jobId: string

        The id of the job to remove

      • opts: {
            removeChildren: boolean;
        } = {}

        Options to remove a job

        • removeChildren: boolean

      Returns Promise<number>

      1 if it managed to remove the job or 0 if the job or any of its dependencies were locked.

      -

    removeDebounceKey

    removeDebounceKey

    • removeDebounceKey(id): Promise<number>

    • Removes a debounce key.

      Parameters

      • id: string

        identifier

      Returns Promise<number>

      Deprecated

      use removeDeduplicationKey

      -

    removeDeduplicationKey

    • removeDeduplicationKey(id): Promise<number>

    • Removes a deduplication key.

      +

    removeDeduplicationKey

    • removeDeduplicationKey(id): Promise<number>

    • Removes a deduplication key.

      Parameters

      • id: string

        identifier

        -

      Returns Promise<number>

    removeDeprecatedPriorityKey

    • removeDeprecatedPriorityKey(): Promise<number>

    • Delete old priority helper key.

      -

      Returns Promise<number>

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<boolean>

    • Removes a job scheduler.

      -

      Parameters

      • jobSchedulerId: string

      Returns Promise<boolean>

    removeRateLimitKey

    • removeRateLimitKey(): Promise<number>

    • Removes rate limit key.

      -

      Returns Promise<number>

    removeRepeatable

    • removeRepeatable(name, repeatOpts, jobId?): Promise<boolean>

    • Removes a repeatable job.

      +

    Returns Promise<number>

    removeDeprecatedPriorityKey

    • removeDeprecatedPriorityKey(): Promise<number>

    • Delete old priority helper key.

      +

      Returns Promise<number>

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<boolean>

    • Removes a job scheduler.

      +

      Parameters

      • jobSchedulerId: string

      Returns Promise<boolean>

    removeRateLimitKey

    • removeRateLimitKey(): Promise<number>

    • Removes rate limit key.

      +

      Returns Promise<number>

    removeRepeatable

    • removeRepeatable(name, repeatOpts, jobId?): Promise<boolean>

    • Removes a repeatable job.

      Note: you need to use the exact same repeatOpts when deleting a repeatable job than when adding it.

      Parameters

      Returns Promise<boolean>

      Deprecated

      This method is deprecated and will be removed in v6. Use removeJobScheduler instead.

      See

      removeRepeatableByKey

      -

    removeRepeatableByKey

    • removeRepeatableByKey(key): Promise<boolean>

    • Removes a repeatable job by its key. Note that the key is the one used +

    removeRepeatableByKey

    • removeRepeatableByKey(key): Promise<boolean>

    • Removes a repeatable job by its key. Note that the key is the one used to store the repeatable job metadata and not one of the job iterations themselves. You can use "getRepeatableJobs" in order to get the keys.

      Parameters

      • key: string

      Returns Promise<boolean>

      See

      getRepeatableJobs

      Deprecated

      This method is deprecated and will be removed in v6. Use removeJobScheduler instead.

      -

    resume

    • resume(): Promise<void>

    • Resumes the processing of this queue globally.

      +

    resume

    • resume(): Promise<void>

    • Resumes the processing of this queue globally.

      The method reverses the pause operation by resuming the processing of the queue.

      -

      Returns Promise<void>

    retryJobs

    • retryJobs(opts?): Promise<void>

    • Retry all the failed or completed jobs.

      -

      Parameters

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

      Returns Promise<void>

    setGlobalConcurrency

    • setGlobalConcurrency(concurrency): Promise<number>

    • Enable and set global concurrency value.

      +

      Returns Promise<void>

    retryJobs

    • retryJobs(opts?): Promise<void>

    • Retry all the failed or completed jobs.

      +

      Parameters

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

      Returns Promise<void>

    setGlobalConcurrency

    • setGlobalConcurrency(concurrency): Promise<number>

    • Enable and set global concurrency value.

      Parameters

      • concurrency: number

        Maximum number of simultaneous jobs that the workers can handle. For instance, setting this value to 1 ensures that no more than one job is processed at any given time. If this limit is not defined, there will be no restriction on the number of concurrent jobs.

        -

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +

    Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    trimEvents

    • trimEvents(maxLength): Promise<number>

    • Trim the event stream to an approximately maxLength.

      -

      Parameters

      • maxLength: number

      Returns Promise<number>

    updateJobProgress

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

    • Updates the given job's progress.

      +
        • (span?, dstPropagationMetadata?): T | Promise<T>

        • Parameters

          • Optional span: Span<any>
          • Optional dstPropagationMetadata: string

          Returns T | Promise<T>

    • Optional srcPropagationMetadata: string

    Returns Promise<T | Promise<T>>

    trimEvents

    • trimEvents(maxLength): Promise<number>

    • Trim the event stream to an approximately maxLength.

      +

      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>

    upsertJobScheduler

    Returns Promise<void>

    upsertJobScheduler

    • upsertJobScheduler(jobSchedulerId, repeatOpts, jobTemplate?): Promise<Job<DataType, ResultType, NameType>>

    • Upserts a scheduler.

      A scheduler is a job factory that creates jobs at a given interval. Upserting a scheduler will create a new job scheduler or update an existing one. It will also create the first job based on the repeat options and delayed accordingly.

      @@ -312,4 +312,4 @@

      Deprecated

      This method is deprecated and will be removed in v6. Use r

    • Optional jobTemplate: {
          data?: DataType;
          name?: NameType;
          opts?: Omit<JobsOptions, "repeat" | "jobId" | "delay">;
      }

      Job template. If provided it will be used for all the jobs created by the scheduler.

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

    The next job to be scheduled (would normally be in delayed state).

    -

    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/v5.QueueBase.html b/classes/v5.QueueBase.html index 4a15c62485..cc7de1bd5b 100644 --- a/classes/v5.QueueBase.html +++ b/classes/v5.QueueBase.html @@ -1,7 +1,7 @@ -QueueBase | bullmq - v5.30.1

    Class QueueBase

    QueueBase

    +QueueBase | bullmq - v5.31.0

    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 @@ -19,17 +19,17 @@
  • 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.

    -
  • hasBlockingConnection: boolean = false

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

      +
    • hasBlockingConnection: boolean = false

    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

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +
    • Rest ...args: any[]

    Returns boolean

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    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 edbd8135cb..0f071d87f7 100644 --- a/classes/v5.QueueEvents.html +++ b/classes/v5.QueueEvents.html @@ -1,7 +1,7 @@ -QueueEvents | bullmq - v5.30.1

    Class QueueEvents

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

    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 @@ -19,19 +19,19 @@ run trace 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<QEL, 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: CustomParameters<QEL[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>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +

      Returns Promise<void>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v5.QueueEventsProducer.html b/classes/v5.QueueEventsProducer.html index 00febe4ce3..eb5a7ae92e 100644 --- a/classes/v5.QueueEventsProducer.html +++ b/classes/v5.QueueEventsProducer.html @@ -1,5 +1,5 @@ -QueueEventsProducer | bullmq - v5.30.1

    Class QueueEventsProducer

    The QueueEventsProducer class is used for publishing custom events.

    -

    Hierarchy (view full)

    Constructors

    constructor +QueueEventsProducer | bullmq - v5.31.0

    Class QueueEventsProducer

    The QueueEventsProducer class is used for publishing custom events.

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    closing keys name @@ -14,20 +14,20 @@ publishEvent trace 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(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

    • 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

    publishEvent

    • publishEvent<T>(argsObj, maxEvents?): Promise<void>

    • Publish custom event to be processed in QueueEvents.

      +
    • Rest ...args: any[]

    Returns boolean

    publishEvent

    • publishEvent<T>(argsObj, maxEvents?): Promise<void>

    • Publish custom event to be processed in QueueEvents.

      Type Parameters

      • T extends {
            eventName: string;
        }

      Parameters

      • argsObj: T

        Event payload

      • maxEvents: number = 1000

        Max quantity of events to be saved

        -

      Returns Promise<void>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +

    Returns Promise<void>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    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 31b7c31990..e20d8cff7c 100644 --- a/classes/v5.QueueGetters.html +++ b/classes/v5.QueueGetters.html @@ -1,6 +1,6 @@ -QueueGetters | bullmq - v5.30.1

    Class QueueGetters<JobBase>

    QueueGetters

    +QueueGetters | bullmq - v5.31.0

    Class QueueGetters<JobBase>

    QueueGetters

    Description

    Provides different getters for different aspects of a queue.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

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

    -
  • hasBlockingConnection: boolean = false

    • Returns QueueGetters<JobBase>

    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 +

    • hasBlockingConnection: boolean = false

    Returns QueueGetters<JobBase>

    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

    • getActive(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "active" status.

      +
    • Rest ...args: any[]

    Returns boolean

    getActive

    • getActive(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "active" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getActiveCount

    • getActiveCount(): Promise<number>

    • Returns the number of jobs in active status.

      -

      Returns Promise<number>

    getCompleted

    • getCompleted(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "completed" status.

      +

    Returns Promise<JobBase[]>

    getActiveCount

    • getActiveCount(): Promise<number>

    • Returns the number of jobs in active status.

      +

      Returns Promise<number>

    getCompleted

    • getCompleted(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "completed" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

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

    getDebounceJobId

    • getDebounceJobId(id): Promise<string>

    • Get jobId that starts debounced state.

      +

    Returns Promise<JobBase[]>

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

    getDebounceJobId

    • getDebounceJobId(id): Promise<string>

    • Get jobId that starts debounced state.

      Parameters

      • id: string

        debounce identifier

      Returns Promise<string>

      Deprecated

      use getDeduplicationJobId method

      -

    getDeduplicationJobId

    getDeduplicationJobId

    • getDeduplicationJobId(id): Promise<string>

    • Get jobId from deduplicated state.

      Parameters

      • id: string

        deduplication identifier

        -

      Returns Promise<string>

    getDelayed

    • getDelayed(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "delayed" status.

      +

    Returns Promise<string>

    getDelayed

    • getDelayed(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "delayed" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getDelayedCount

    • getDelayedCount(): Promise<number>

    • Returns the number of jobs in delayed status.

      -

      Returns Promise<number>

    getDependencies

    • getDependencies(parentId, type, start, end): Promise<{
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs: JobJsonRaw[];
          total: number;
      }>

    • Returns the qualified job ids and the raw job data (if available) of the +

    Returns Promise<JobBase[]>

    getDelayedCount

    • getDelayedCount(): Promise<number>

    • Returns the number of jobs in delayed status.

      +

      Returns Promise<number>

    getDependencies

    • getDependencies(parentId, type, start, end): Promise<{
          items: {
              err?: string;
              id: string;
              v?: any;
          }[];
          jobs: JobJsonRaw[];
          total: number;
      }>

    • Returns the qualified job ids and the raw job data (if available) of the children jobs of the given parent job. It is possible to get either the already processed children, in this case an array of qualified job ids and their result values will be returned, @@ -87,32 +87,32 @@ for example: "bull:myqueue:jobid".

      Parameters

      • parentId: string

        The id of the parent job

      • type: "pending" | "processed"

        "processed" | "pending"

        -
      • start: number
      • end: number

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

    getFailed

    • getFailed(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "failed" status.

      +
    • start: number
    • end: number

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

    getFailed

    • getFailed(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "failed" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getFailedCount

    • getFailedCount(): Promise<number>

    • Returns the number of jobs in failed status.

      -

      Returns Promise<number>

    getJob

    getJobCountByTypes

    • getJobCountByTypes(...types): Promise<number>

    • Job counts by type

      +

    Returns Promise<JobBase[]>

    getFailedCount

    • getFailedCount(): Promise<number>

    • Returns the number of jobs in failed status.

      +

      Returns Promise<number>

    getJob

    getJobCountByTypes

    • getJobCountByTypes(...types): Promise<number>

    • Job counts by type

      Queue#getJobCountByTypes('completed') => completed count Queue#getJobCountByTypes('completed,failed') => completed + failed count Queue#getJobCountByTypes('completed', 'failed') => completed + failed count Queue#getJobCountByTypes('completed', 'waiting', 'failed') => completed + waiting + failed count

      -

      Parameters

      Returns Promise<number>

    getJobCounts

    • getJobCounts(...types): Promise<{
          [index: string]: number;
      }>

    • Returns the job counts for each type specified or every list/set in the queue by default.

      +

      Parameters

      Returns Promise<number>

    getJobCounts

    • getJobCounts(...types): Promise<{
          [index: string]: number;
      }>

    • Returns the job counts for each type specified or every list/set in the queue by default.

      Parameters

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

      An object, key (type) and value (count)

      -

    getJobLogs

    • getJobLogs(jobId, start?, end?, asc?): Promise<{
          count: number;
          logs: string[];
      }>

    • Returns the logs for a given Job.

      +

    getJobLogs

    • getJobLogs(jobId, start?, end?, asc?): Promise<{
          count: number;
          logs: string[];
      }>

    • Returns the logs for a given Job.

      Parameters

      • jobId: string

        the id of the job to get the logs for.

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

      • asc: boolean = true

        if true, the jobs will be returned in ascending order.

        -

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

    getJobState

    • getJobState(jobId): Promise<"unknown" | JobState>

    • Get current job state.

      +

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

    getJobState

    • getJobState(jobId): Promise<"unknown" | JobState>

    • Get current job state.

      Parameters

      • jobId: string

        job identifier.

      Returns Promise<"unknown" | JobState>

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

      -

    getJobs

    • getJobs(types?, start?, end?, asc?): Promise<JobBase[]>

    • Returns the jobs that are on the given statuses (note that JobType is synonym for job status)

      +

    getJobs

    • getJobs(types?, start?, end?, asc?): Promise<JobBase[]>

    • Returns the jobs that are on the given statuses (note that JobType is synonym for job status)

      Parameters

      • Optional types: JobType | JobType[]

        the statuses of the jobs to return.

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

      • asc: boolean = false

        if true, the jobs will be returned in ascending order.

        -

      Returns Promise<JobBase[]>

    getMetrics

    • getMetrics(type, start?, end?): Promise<Metrics>

    • Get queue metrics related to the queue.

      +

    Returns Promise<JobBase[]>

    getMetrics

    • getMetrics(type, start?, end?): Promise<Metrics>

    • Get queue metrics related to the queue.

      This method returns the gathered metrics for the queue. The metrics are represented as an array of job counts per unit of time (1 minute).

      @@ -123,42 +123,42 @@

    Returns Promise<Metrics>

    • Returns an object with queue metrics.
    -

    getPrioritized

    getPrioritized

    • getPrioritized(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "prioritized" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getPrioritizedCount

    • getPrioritizedCount(): Promise<number>

    • Returns the number of jobs in prioritized status.

      -

      Returns Promise<number>

    getQueueEvents

    • getQueueEvents(): Promise<{
          [index: string]: string;
      }[]>

    • Get queue events list related to the queue. +

    Returns Promise<JobBase[]>

    getPrioritizedCount

    • getPrioritizedCount(): Promise<number>

    • Returns the number of jobs in prioritized status.

      +

      Returns Promise<number>

    getQueueEvents

    • getQueueEvents(): Promise<{
          [index: string]: string;
      }[]>

    • Get queue events list related to the queue. Note: GCP does not support SETNAME, so this call will not work

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

      • Returns an array with queue events info.

      Deprecated

      do not use this method, it will be removed in the future.

      -

    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>

    • Returns the time to live for a rate limited key in milliseconds.

      +

    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>

    • Returns the time to live for a rate limited key in milliseconds.

      Parameters

      • Optional maxJobs: number

        max jobs to be considered in rate limit state. If not passed it will return the remaining ttl without considering if max jobs is excedeed.

      Returns Promise<number>

      -2 if the key does not exist. -1 if the key exists but has no associated expire.

      See

      https://redis.io/commands/pttl/

      -

    getWaiting

    getWaiting

    • getWaiting(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "waiting" status.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getWaitingChildren

    • getWaitingChildren(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "waiting-children" status. +

    Returns Promise<JobBase[]>

    getWaitingChildren

    • getWaitingChildren(start?, end?): Promise<JobBase[]>

    • Returns the jobs that are in the "waiting-children" status. I.E. parent jobs that have at least one child that has not completed yet.

      Parameters

      • start: number = 0

        zero based index from where to start returning jobs.

      • end: number = -1

        zero based index where to stop returning jobs.

        -

      Returns Promise<JobBase[]>

    getWaitingChildrenCount

    • getWaitingChildrenCount(): Promise<number>

    • Returns the number of jobs in waiting-children status.

      -

      Returns Promise<number>

    getWaitingCount

    • getWaitingCount(): Promise<number>

    • Returns the number of jobs in waiting or paused statuses.

      -

      Returns Promise<number>

    getWorkers

    • getWorkers(): Promise<{
          [index: string]: string;
      }[]>

    • Get the worker list related to the queue. i.e. all the known +

    Returns Promise<JobBase[]>

    getWaitingChildrenCount

    • getWaitingChildrenCount(): Promise<number>

    • Returns the number of jobs in waiting-children status.

      +

      Returns Promise<number>

    getWaitingCount

    • getWaitingCount(): Promise<number>

    • Returns the number of jobs in waiting or paused statuses.

      +

      Returns Promise<number>

    getWorkers

    • getWorkers(): Promise<{
          [index: string]: string;
      }[]>

    • Get the worker list related to the queue. i.e. all the known workers that are available to process jobs for this queue. Note: GCP does not support SETNAME, so this call will not work

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

      • Returns an array with workers info.
      -

    getWorkersCount

    getWorkersCount

    • getWorkersCount(): Promise<number>

    • Returns the current count of workers for the queue.

      getWorkersCount(): Promise

      -

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +

      Returns Promise<number>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    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 008a0aec95..a3e9a2e410 100644 --- a/classes/v5.QueueKeys.html +++ b/classes/v5.QueueKeys.html @@ -1,6 +1,6 @@ -QueueKeys | bullmq - v5.30.1

    Class QueueKeys

    Constructors

    constructor +QueueKeys | bullmq - v5.31.0

    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 b4ca672062..42ea6b4ace 100644 --- a/classes/v5.RateLimitError.html +++ b/classes/v5.RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | bullmq - v5.30.1

    Class RateLimitError

    RateLimitError

    +RateLimitError | bullmq - v5.31.0

    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 0a97f2a67c..59411b004a 100644 --- a/classes/v5.RedisConnection.html +++ b/classes/v5.RedisConnection.html @@ -1,4 +1,4 @@ -RedisConnection | bullmq - v5.30.1

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection

    Constructors

    constructor +RedisConnection | bullmq - v5.31.0

    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 65601a7046..13c3f0b67a 100644 --- a/classes/v5.Repeat.html +++ b/classes/v5.Repeat.html @@ -1,7 +1,7 @@ -Repeat | bullmq - v5.30.1

    Class Repeat

    QueueBase

    +Repeat | bullmq - v5.31.0

    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 @@ -21,17 +21,17 @@ trace updateRepeatableJob 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

    • 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

    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>

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

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

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    updateRepeatableJob

    • updateRepeatableJob<T, R, N>(name, data, opts, __namedParameters): Promise<Job<T, R, N>>

    • Type Parameters

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

      Parameters

      • name: N
      • data: T
      • opts: JobsOptions
      • __namedParameters: {
            override: boolean;
        }
        • override: boolean

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

    waitUntilReady

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional srcPropagationMetadata: string

    • Returns Promise<T | Promise<T>>

    updateRepeatableJob

    • updateRepeatableJob<T, R, N>(name, data, opts, __namedParameters): Promise<Job<T, R, N>>

    • Type Parameters

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

      Parameters

      • name: N
      • data: T
      • opts: JobsOptions
      • __namedParameters: {
            override: boolean;
        }
        • override: boolean

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

    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 290d89dae3..7fe045dec6 100644 --- a/classes/v5.Scripts.html +++ b/classes/v5.Scripts.html @@ -1,4 +1,4 @@ -Scripts | bullmq - v5.30.1

    Class Scripts

    Constructors

    constructor +Scripts | bullmq - v5.31.0

    Class Scripts

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    Methods

    addJob addJobScheduler @@ -49,19 +49,19 @@ updateJobSchedulerNextMillis updateProgress updateRepeatableJobMillis -

    Constructors

    constructor

    Properties

    moveToFinishedKeys

    moveToFinishedKeys: string[]

    Methods

    addJob

    addJobScheduler

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

      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

    addJobScheduler

    addLog

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

    • Parameters

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

      Returns Promise<number>

    addRepeatableJob

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

    • Parameters

      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

    execCommand

    • execCommand(client, commandName, args): any

    • Parameters

      • client: ChainableCommander | RedisClient
      • commandName: string
      • args: any[]

      Returns any

    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

    execCommand

    • execCommand(client, commandName, args): any

    • Parameters

      • client: ChainableCommander | RedisClient
      • commandName: string
      • args: any[]

      Returns any

    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.

      @@ -69,8 +69,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>

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<number>

    • Parameters

      • jobSchedulerId: string

      Returns Promise<number>

    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>

    removeJobScheduler

    • removeJobScheduler(jobSchedulerId): Promise<number>

    • Parameters

      • jobSchedulerId: string

      Returns Promise<number>

    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: @@ -78,4 +78,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

    updateJobSchedulerNextMillis

    • updateJobSchedulerNextMillis(client, jobSchedulerId, nextMillis): Promise<number>

    • Parameters

      • client: RedisClient
      • jobSchedulerId: string
      • nextMillis: number

      Returns Promise<number>

    updateProgress

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

    • Parameters

      • jobId: string
      • progress: number | object

      Returns Promise<void>

    updateRepeatableJobMillis

    • updateRepeatableJobMillis(client, customKey, nextMillis, legacyCustomKey): Promise<string>

    • Parameters

      • client: RedisClient
      • customKey: string
      • nextMillis: number
      • legacyCustomKey: string

      Returns Promise<string>

    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

    updateJobSchedulerNextMillis

    • updateJobSchedulerNextMillis(client, jobSchedulerId, nextMillis): Promise<number>

    • Parameters

      • client: RedisClient
      • jobSchedulerId: string
      • nextMillis: number

      Returns Promise<number>

    updateProgress

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

    • Parameters

      • jobId: string
      • progress: number | object

      Returns Promise<void>

    updateRepeatableJobMillis

    • updateRepeatableJobMillis(client, customKey, nextMillis, legacyCustomKey): Promise<string>

    • Parameters

      • client: RedisClient
      • customKey: string
      • nextMillis: number
      • legacyCustomKey: string

      Returns Promise<string>

    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 6b6a535d4b..19bcccdf0d 100644 --- a/classes/v5.UnrecoverableError.html +++ b/classes/v5.UnrecoverableError.html @@ -1,5 +1,5 @@ -UnrecoverableError | bullmq - v5.30.1

    Class UnrecoverableError

    UnrecoverableError

    +UnrecoverableError | bullmq - v5.31.0

    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 7fa4d038a4..99902deeac 100644 --- a/classes/v5.WaitingChildrenError.html +++ b/classes/v5.WaitingChildrenError.html @@ -1,5 +1,5 @@ -WaitingChildrenError | bullmq - v5.30.1

    Class WaitingChildrenError

    WaitingChildrenError

    +WaitingChildrenError | bullmq - v5.31.0

    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 9d4f0ce11d..7b5f331ff0 100644 --- a/classes/v5.Worker.html +++ b/classes/v5.Worker.html @@ -1,7 +1,7 @@ -Worker | bullmq - v5.30.1

    Class Worker<DataType, ResultType, NameType>

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

    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 @@ -34,33 +34,33 @@ trace 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

    jobScheduler

    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

    jobScheduler

    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. When using telemetry, be mindful that it can interfere with the proper closure of spans, potentially preventing them from being exported.

      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>

      Deprecated

      This method is deprecated and will be removed in v6. Use queue.rateLimit method instead.

      -

    resume

    • resume(): void

    • Resumes processing of this worker (if paused).

      -

      Returns void

    run

    startStalledCheckTimer

    • startStalledCheckTimer(): Promise<void>

    • Manually starts the stalled checker. +

    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 @@ -68,11 +68,11 @@ 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

      -

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      +

    trace

    • trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): Promise<T | Promise<T>>

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

        code to wrap with telemetry

        -
          • (span?, dstPropagationMetadata?): T | Promise<T>

          • Parameters

            • Optional span: Span<any>
            • Optional dstPropagationMetadata: string

            Returns T | Promise<T>

      • Optional srcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    waitUntilReady

    • waitUntilReady(): Promise<RedisClient>

    • Waits until the worker is ready to start processing jobs. +

        • (span?, dstPropagationMetadata?): T | Promise<T>

        • Parameters

          • Optional span: Span<any>
          • Optional dstPropagationMetadata: string

          Returns T | Promise<T>

    • Optional srcPropagationMetadata: string

    Returns Promise<T | Promise<T>>

    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 2a9ad1d02b..69253df4d5 100644 --- a/enums/v1.ChildCommand.html +++ b/enums/v1.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.30.1

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.31.0

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

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.31.0

    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 b3ef1f3918..a285d7d40e 100644 --- a/enums/v1.ErrorCode.html +++ b/enums/v1.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.30.1

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.31.0

    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 acc75d938a..b6781248f3 100644 --- a/enums/v1.MetricsTime.html +++ b/enums/v1.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.30.1

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.31.0

    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 fd100fd1b7..d6b2278b1f 100644 --- a/enums/v1.ParentCommand.html +++ b/enums/v1.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.30.1

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.31.0

    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 9e59100e5e..1d55a58b66 100644 --- a/enums/v2.ChildCommand.html +++ b/enums/v2.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.30.1

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.31.0

    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 eb8956c880..b5f09eeabe 100644 --- a/enums/v2.ClientType.html +++ b/enums/v2.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.30.1

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.31.0

    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 65b915c878..255729544f 100644 --- a/enums/v2.ErrorCode.html +++ b/enums/v2.ErrorCode.html @@ -1,6 +1,6 @@ -ErrorCode | bullmq - v5.30.1

    Enumeration ErrorCode

    Enumeration Members

    JobLockNotExist +ErrorCode | bullmq - v5.31.0

    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 b006a70321..c8de56f346 100644 --- a/enums/v2.MetricsTime.html +++ b/enums/v2.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.30.1

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.31.0

    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 12e635a83d..861cfeca3d 100644 --- a/enums/v2.ParentCommand.html +++ b/enums/v2.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.30.1

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.31.0

    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 c0ebd73b3a..03a637bd63 100644 --- a/enums/v3.ChildCommand.html +++ b/enums/v3.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.30.1

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.31.0

    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 35214dc348..03780058be 100644 --- a/enums/v3.ClientType.html +++ b/enums/v3.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.30.1

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.31.0

    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 0961cec16f..68430461b3 100644 --- a/enums/v3.ErrorCode.html +++ b/enums/v3.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.30.1

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.31.0

    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 9a32957629..524beb52ac 100644 --- a/enums/v3.MetricsTime.html +++ b/enums/v3.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.30.1

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.31.0

    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 e5ec6286e3..daca24c454 100644 --- a/enums/v3.ParentCommand.html +++ b/enums/v3.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.30.1

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.31.0

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

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.31.0

    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 5c8614ce27..b68659fb40 100644 --- a/enums/v4.ClientType.html +++ b/enums/v4.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.30.1

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.31.0

    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 79ed8a5a53..2156ec04b4 100644 --- a/enums/v4.ErrorCode.html +++ b/enums/v4.ErrorCode.html @@ -1,7 +1,7 @@ -ErrorCode | bullmq - v5.30.1

    Enumeration ErrorCode

    Enumeration Members

    JobLockMismatch +ErrorCode | bullmq - v5.31.0

    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 ba6bdbfd85..a1587c307c 100644 --- a/enums/v4.MetricsTime.html +++ b/enums/v4.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.30.1

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.31.0

    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 29102d6e23..b5ddefc0d6 100644 --- a/enums/v4.ParentCommand.html +++ b/enums/v4.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.30.1

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.31.0

    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 13eb6cb07b..b0a6ab7098 100644 --- a/enums/v5.ChildCommand.html +++ b/enums/v5.ChildCommand.html @@ -1,4 +1,4 @@ -ChildCommand | bullmq - v5.30.1

    Enumeration ChildCommand

    Enumeration Members

    Init +ChildCommand | bullmq - v5.31.0

    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 3a471aad08..7122c89f7f 100644 --- a/enums/v5.ClientType.html +++ b/enums/v5.ClientType.html @@ -1,3 +1,3 @@ -ClientType | bullmq - v5.30.1

    Enumeration ClientType

    Enumeration Members

    blocking +ClientType | bullmq - v5.31.0

    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 5dd99f54ec..b1aa694a7c 100644 --- a/enums/v5.ErrorCode.html +++ b/enums/v5.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | bullmq - v5.30.1

    Enumeration ErrorCode

    Enumeration Members

    JobBelongsToJobScheduler +ErrorCode | bullmq - v5.31.0

    Enumeration ErrorCode

    Enumeration Members

    JobBelongsToJobScheduler JobLockMismatch JobLockNotExist JobNotExist @@ -6,4 +6,4 @@ JobPendingDependencies ParentJobCannotBeReplaced ParentJobNotExist -

    Enumeration Members

    JobBelongsToJobScheduler

    JobBelongsToJobScheduler: -8

    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

    JobBelongsToJobScheduler

    JobBelongsToJobScheduler: -8

    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 ac0f6e1e83..5d48a2ae04 100644 --- a/enums/v5.MetricsTime.html +++ b/enums/v5.MetricsTime.html @@ -1,4 +1,4 @@ -MetricsTime | bullmq - v5.30.1

    Enumeration MetricsTime

    Enumeration Members

    FIFTEEN_MINUTES +MetricsTime | bullmq - v5.31.0

    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 e8f9c2ad74..bf487b3a08 100644 --- a/enums/v5.ParentCommand.html +++ b/enums/v5.ParentCommand.html @@ -1,4 +1,4 @@ -ParentCommand | bullmq - v5.30.1

    Enumeration ParentCommand

    Enumeration Members

    Completed +ParentCommand | bullmq - v5.31.0

    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.SpanKind.html b/enums/v5.SpanKind.html index efe65433c4..5beef924ed 100644 --- a/enums/v5.SpanKind.html +++ b/enums/v5.SpanKind.html @@ -1,6 +1,6 @@ -SpanKind | bullmq - v5.30.1

    Enumeration SpanKind

    Enumeration Members

    CLIENT +SpanKind | bullmq - v5.31.0

    Enumeration SpanKind

    Enumeration Members

    CLIENT CONSUMER INTERNAL PRODUCER SERVER -

    Enumeration Members

    CLIENT

    CLIENT: 2

    CONSUMER

    CONSUMER: 4

    INTERNAL

    INTERNAL: 0

    PRODUCER

    PRODUCER: 3

    SERVER

    SERVER: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CLIENT

    CLIENT: 2

    CONSUMER

    CONSUMER: 4

    INTERNAL

    INTERNAL: 0

    PRODUCER

    PRODUCER: 3

    SERVER

    SERVER: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/v5.TelemetryAttributes.html b/enums/v5.TelemetryAttributes.html index 22263e7b01..c3a6fd3011 100644 --- a/enums/v5.TelemetryAttributes.html +++ b/enums/v5.TelemetryAttributes.html @@ -1,4 +1,4 @@ -TelemetryAttributes | bullmq - v5.30.1

    Enumeration TelemetryAttributes

    Enumeration Members

    BulkCount +TelemetryAttributes | bullmq - v5.31.0

    Enumeration TelemetryAttributes

    Enumeration Members

    BulkCount BulkNames DeduplicationKey FlowName @@ -31,4 +31,4 @@ WorkerOptions WorkerRateLimit WorkerStalledJobs -

    Enumeration Members

    BulkCount

    BulkCount: "bullmq.job.bulk.count"

    BulkNames

    BulkNames: "bullmq.job.bulk.names"

    DeduplicationKey

    DeduplicationKey: "bullmq.job.deduplication.key"

    FlowName

    FlowName: "bullmq.flow.name"

    JobFailedReason

    JobFailedReason: "bullmq.job.failed.reason"

    JobFinishedTimestamp

    JobFinishedTimestamp: "bullmq.job.finished.timestamp"

    JobId

    JobId: "bullmq.job.id"

    JobIds

    JobIds: "bullmq.job.ids"

    JobKey

    JobKey: "bullmq.job.key"

    JobName

    JobName: "bullmq.job.name"

    JobOptions

    JobOptions: "bullmq.job.options"

    JobProcessedTimestamp

    JobProcessedTimestamp: "bullmq.job.processed.timestamp"

    JobProgress

    JobProgress: "bullmq.job.progress"

    JobResult

    JobResult: "bullmq.job.result"

    JobSchedulerId

    JobSchedulerId: "bullmq.job.scheduler.id"

    JobType

    JobType: "bullmq.job.type"

    QueueCleanLimit

    QueueCleanLimit: "bullmq.queue.clean.limit"

    QueueDrainDelay

    QueueDrainDelay: "bullmq.queue.drain.delay"

    QueueEventMaxLength

    QueueEventMaxLength: "bullmq.queue.event.max.length"

    QueueGrace

    QueueGrace: "bullmq.queue.grace"

    QueueName

    QueueName: "bullmq.queue.name"

    QueueOperation

    QueueOperation: "bullmq.queue.operation"

    QueueOptions

    QueueOptions: "bullmq.queue.options"

    QueueRateLimit

    QueueRateLimit: "bullmq.queue.rate.limit"

    WorkerDoNotWaitActive

    WorkerDoNotWaitActive: "bullmq.worker.do.not.wait.active"

    WorkerFailedJobs

    WorkerFailedJobs: "bullmq.worker.failed.jobs"

    WorkerForceClose

    WorkerForceClose: "bullmq.worker.force.close"

    WorkerId

    WorkerId: "bullmq.worker.id"

    WorkerJobsToExtendLocks

    WorkerJobsToExtendLocks: "bullmq.worker.jobs.to.extend.locks"

    WorkerName

    WorkerName: "bullmq.worker.name"

    WorkerOptions

    WorkerOptions: "bullmq.worker.options"

    WorkerRateLimit

    WorkerRateLimit: "bullmq.worker.rate.limit"

    WorkerStalledJobs

    WorkerStalledJobs: "bullmq.worker.stalled.jobs"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    BulkCount

    BulkCount: "bullmq.job.bulk.count"

    BulkNames

    BulkNames: "bullmq.job.bulk.names"

    DeduplicationKey

    DeduplicationKey: "bullmq.job.deduplication.key"

    FlowName

    FlowName: "bullmq.flow.name"

    JobFailedReason

    JobFailedReason: "bullmq.job.failed.reason"

    JobFinishedTimestamp

    JobFinishedTimestamp: "bullmq.job.finished.timestamp"

    JobId

    JobId: "bullmq.job.id"

    JobIds

    JobIds: "bullmq.job.ids"

    JobKey

    JobKey: "bullmq.job.key"

    JobName

    JobName: "bullmq.job.name"

    JobOptions

    JobOptions: "bullmq.job.options"

    JobProcessedTimestamp

    JobProcessedTimestamp: "bullmq.job.processed.timestamp"

    JobProgress

    JobProgress: "bullmq.job.progress"

    JobResult

    JobResult: "bullmq.job.result"

    JobSchedulerId

    JobSchedulerId: "bullmq.job.scheduler.id"

    JobType

    JobType: "bullmq.job.type"

    QueueCleanLimit

    QueueCleanLimit: "bullmq.queue.clean.limit"

    QueueDrainDelay

    QueueDrainDelay: "bullmq.queue.drain.delay"

    QueueEventMaxLength

    QueueEventMaxLength: "bullmq.queue.event.max.length"

    QueueGrace

    QueueGrace: "bullmq.queue.grace"

    QueueName

    QueueName: "bullmq.queue.name"

    QueueOperation

    QueueOperation: "bullmq.queue.operation"

    QueueOptions

    QueueOptions: "bullmq.queue.options"

    QueueRateLimit

    QueueRateLimit: "bullmq.queue.rate.limit"

    WorkerDoNotWaitActive

    WorkerDoNotWaitActive: "bullmq.worker.do.not.wait.active"

    WorkerFailedJobs

    WorkerFailedJobs: "bullmq.worker.failed.jobs"

    WorkerForceClose

    WorkerForceClose: "bullmq.worker.force.close"

    WorkerId

    WorkerId: "bullmq.worker.id"

    WorkerJobsToExtendLocks

    WorkerJobsToExtendLocks: "bullmq.worker.jobs.to.extend.locks"

    WorkerName

    WorkerName: "bullmq.worker.name"

    WorkerOptions

    WorkerOptions: "bullmq.worker.options"

    WorkerRateLimit

    WorkerRateLimit: "bullmq.worker.rate.limit"

    WorkerStalledJobs

    WorkerStalledJobs: "bullmq.worker.stalled.jobs"

    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 4184858284..a249c3107e 100644 --- a/functions/v1.array2obj.html +++ b/functions/v1.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.30.1

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

    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 f70652da8e..66a4fd9147 100644 --- a/functions/v1.asyncSend.html +++ b/functions/v1.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.30.1

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

    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 bff0202428..0992fd5f81 100644 --- a/functions/v1.childSend.html +++ b/functions/v1.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.30.1

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 d155d1c54e..3c5f58d9e3 100644 --- a/functions/v1.delay.html +++ b/functions/v1.delay.html @@ -1 +1 @@ -delay | bullmq - v5.30.1

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

    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 c9f098880b..28b10202d6 100644 --- a/functions/v1.getNextMillis.html +++ b/functions/v1.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.30.1

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 07bef2172c..fc5c7da4f8 100644 --- a/functions/v1.getParentKey.html +++ b/functions/v1.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.30.1

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

    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 5c930b503b..2f4c91715a 100644 --- a/functions/v1.isEmpty.html +++ b/functions/v1.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.30.1

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

    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 5cdb81e05f..8657aee344 100644 --- a/functions/v1.isNotConnectionError.html +++ b/functions/v1.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.30.1

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

    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 633dea95c1..22571fb38d 100644 --- a/functions/v1.isRedisCluster.html +++ b/functions/v1.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.30.1

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

    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 91d0944864..c173c0c0db 100644 --- a/functions/v1.isRedisInstance.html +++ b/functions/v1.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.30.1

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

    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 db678d1c7f..e816d55f94 100644 --- a/functions/v1.isRedisVersionLowerThan.html +++ b/functions/v1.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.30.1

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

    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 06eb32d615..c871bac35b 100644 --- a/functions/v1.jobIdForGroup.html +++ b/functions/v1.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.30.1

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 a12c1138d4..b70a4d2f74 100644 --- a/functions/v1.killAsync.html +++ b/functions/v1.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.30.1

    Function killAsync

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

    • Sends a kill signal to a child resolving when the child has exited, +killAsync | bullmq - v5.31.0

      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 b0b0aae113..99562d0364 100644 --- a/functions/v1.lengthInUtf8Bytes.html +++ b/functions/v1.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.30.1

    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 b9b20f544b..187aa0af33 100644 --- a/functions/v1.parentSend.html +++ b/functions/v1.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.30.1

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

    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 f558713f32..207e1fd617 100644 --- a/functions/v1.raw2jobData.html +++ b/functions/v1.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.30.1

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 2adf1ad50e..d2eff6133b 100644 --- a/functions/v1.removeAllQueueData.html +++ b/functions/v1.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.30.1

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

    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 03c19d3e08..06138200a9 100644 --- a/functions/v1.tryCatch.html +++ b/functions/v1.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.30.1

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

    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 cc87093361..6185d81c37 100644 --- a/functions/v2.array2obj.html +++ b/functions/v2.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.30.1

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

    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 91507494f7..2ac648c784 100644 --- a/functions/v2.asyncSend.html +++ b/functions/v2.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.30.1

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

    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 6f25a204d3..540bd18713 100644 --- a/functions/v2.childSend.html +++ b/functions/v2.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.30.1

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 3abb025448..8eddf69405 100644 --- a/functions/v2.delay.html +++ b/functions/v2.delay.html @@ -1 +1 @@ -delay | bullmq - v5.30.1

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

    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 158b6c577e..b4fe97c31a 100644 --- a/functions/v2.getNextMillis.html +++ b/functions/v2.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.30.1

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 8493df9ab6..6f7ee63df5 100644 --- a/functions/v2.getParentKey.html +++ b/functions/v2.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.30.1

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

    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 99c03bfe08..24a3f83371 100644 --- a/functions/v2.isEmpty.html +++ b/functions/v2.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.30.1

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

    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 302cff9b5a..58230eb54a 100644 --- a/functions/v2.isNotConnectionError.html +++ b/functions/v2.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.30.1

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

    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 410692ddbe..ff4fae5a3e 100644 --- a/functions/v2.isRedisCluster.html +++ b/functions/v2.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.30.1

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

    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 0f1896d2e5..a181cbc8cc 100644 --- a/functions/v2.isRedisInstance.html +++ b/functions/v2.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.30.1

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

    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 c27814e8ba..0a3167dd3e 100644 --- a/functions/v2.isRedisVersionLowerThan.html +++ b/functions/v2.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.30.1

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

    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 c248d67d2a..2fb429a24b 100644 --- a/functions/v2.jobIdForGroup.html +++ b/functions/v2.jobIdForGroup.html @@ -1 +1 @@ -jobIdForGroup | bullmq - v5.30.1

    Function jobIdForGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 dd3ed5df51..7404694622 100644 --- a/functions/v2.killAsync.html +++ b/functions/v2.killAsync.html @@ -1,3 +1,3 @@ -killAsync | bullmq - v5.30.1

    Function killAsync

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

    • Sends a kill signal to a child resolving when the child has exited, +killAsync | bullmq - v5.31.0

      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 60164710b9..413c7e23f0 100644 --- a/functions/v2.lengthInUtf8Bytes.html +++ b/functions/v2.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.30.1

    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 458ea7b3ec..28da29c997 100644 --- a/functions/v2.parentSend.html +++ b/functions/v2.parentSend.html @@ -1 +1 @@ -parentSend | bullmq - v5.30.1

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

    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 14922cf313..a5c4c2b409 100644 --- a/functions/v2.raw2jobData.html +++ b/functions/v2.raw2jobData.html @@ -1 +1 @@ -raw2jobData | bullmq - v5.30.1

    Function raw2jobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 09ba0d5b39..c90376d55d 100644 --- a/functions/v2.removeAllQueueData.html +++ b/functions/v2.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.30.1

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

    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 4f01ead908..02ed1a93ad 100644 --- a/functions/v2.tryCatch.html +++ b/functions/v2.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.30.1

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

    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 e16eb02aee..2884201d5c 100644 --- a/functions/v3.array2obj.html +++ b/functions/v3.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.30.1

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

    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 116dcdf77d..66c5b0fcc9 100644 --- a/functions/v3.asyncSend.html +++ b/functions/v3.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.30.1

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

    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 356dd1a2fd..58c66211d9 100644 --- a/functions/v3.childSend.html +++ b/functions/v3.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.30.1

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 3e2630d21f..820480b6ad 100644 --- a/functions/v3.delay.html +++ b/functions/v3.delay.html @@ -1 +1 @@ -delay | bullmq - v5.30.1

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

    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 6425ee5959..b0c42b134f 100644 --- a/functions/v3.errorToJSON.html +++ b/functions/v3.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.30.1

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

    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 c7b4df76df..9939faaa3a 100644 --- a/functions/v3.getNextMillis.html +++ b/functions/v3.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.30.1

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 da765cf58d..72607e7dd3 100644 --- a/functions/v3.getParentKey.html +++ b/functions/v3.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.30.1

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

    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 f8e325674b..c6f06e189c 100644 --- a/functions/v3.isEmpty.html +++ b/functions/v3.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.30.1

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

    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 061602eeb4..fd7b91187f 100644 --- a/functions/v3.isNotConnectionError.html +++ b/functions/v3.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.30.1

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

    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 f2061720ef..865df1dc15 100644 --- a/functions/v3.isRedisCluster.html +++ b/functions/v3.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.30.1

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

    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 be8ff033f0..ad364ecf6f 100644 --- a/functions/v3.isRedisInstance.html +++ b/functions/v3.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.30.1

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

    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 e0081adfb7..bc32a96663 100644 --- a/functions/v3.isRedisVersionLowerThan.html +++ b/functions/v3.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.30.1

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

    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 9adb755eb4..29c9cd54fc 100644 --- a/functions/v3.lengthInUtf8Bytes.html +++ b/functions/v3.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.30.1

    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 18d8b595a7..e06e927bc9 100644 --- a/functions/v3.parseObjectValues.html +++ b/functions/v3.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.30.1

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

    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 226d56579b..5856f2ba0c 100644 --- a/functions/v3.raw2NextJobData.html +++ b/functions/v3.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.30.1

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 13310f5362..35efc4ae9a 100644 --- a/functions/v3.removeAllQueueData.html +++ b/functions/v3.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.30.1

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

    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 f672c75798..80266549cd 100644 --- a/functions/v3.tryCatch.html +++ b/functions/v3.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.30.1

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

    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 057207cc01..e817ee4fca 100644 --- a/functions/v4.array2obj.html +++ b/functions/v4.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.30.1

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

    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 66deb55ecc..ac45a098cb 100644 --- a/functions/v4.asyncSend.html +++ b/functions/v4.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.30.1

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

    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 e39262c01e..4b25ebb484 100644 --- a/functions/v4.childSend.html +++ b/functions/v4.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.30.1

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 439db09346..9da53df1fc 100644 --- a/functions/v4.decreaseMaxListeners.html +++ b/functions/v4.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.30.1

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

    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 e45ea3d408..6c92707b00 100644 --- a/functions/v4.delay.html +++ b/functions/v4.delay.html @@ -1 +1 @@ -delay | bullmq - v5.30.1

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

    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 b889b80152..2693631c75 100644 --- a/functions/v4.errorToJSON.html +++ b/functions/v4.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.30.1

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

    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 1bd194f50e..23b0c32c9f 100644 --- a/functions/v4.getNextMillis.html +++ b/functions/v4.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.30.1

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 07f438ddb6..1370429be9 100644 --- a/functions/v4.getParentKey.html +++ b/functions/v4.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.30.1

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

    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 4ad46ecc89..081a6ab22e 100644 --- a/functions/v4.increaseMaxListeners.html +++ b/functions/v4.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.30.1

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

    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 937bbfe818..40823bdd9a 100644 --- a/functions/v4.isEmpty.html +++ b/functions/v4.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.30.1

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

    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 af435e7a10..748721186a 100644 --- a/functions/v4.isNotConnectionError.html +++ b/functions/v4.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.30.1

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

    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 2f8cf73671..9b490235c1 100644 --- a/functions/v4.isRedisCluster.html +++ b/functions/v4.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.30.1

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

    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 e7cbac600e..5c218928fe 100644 --- a/functions/v4.isRedisInstance.html +++ b/functions/v4.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.30.1

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

    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 b1a725374f..eeb13774da 100644 --- a/functions/v4.isRedisVersionLowerThan.html +++ b/functions/v4.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.30.1

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

    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 00363e2b18..fa261f0557 100644 --- a/functions/v4.lengthInUtf8Bytes.html +++ b/functions/v4.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.30.1

    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 15b13502ec..066e1c68d6 100644 --- a/functions/v4.parseObjectValues.html +++ b/functions/v4.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.30.1

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

    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 733866b7ea..f72704cff8 100644 --- a/functions/v4.raw2NextJobData.html +++ b/functions/v4.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.30.1

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 5a3f90bbd1..f19441d2e4 100644 --- a/functions/v4.removeAllQueueData.html +++ b/functions/v4.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.30.1

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

    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 b352104b7f..f66a5b1397 100644 --- a/functions/v4.tryCatch.html +++ b/functions/v4.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.30.1

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

    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 d2dfbf7970..d29c2eb7d7 100644 --- a/functions/v5.array2obj.html +++ b/functions/v5.array2obj.html @@ -1 +1 @@ -array2obj | bullmq - v5.30.1

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

    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 c4a7318c08..46f2af5322 100644 --- a/functions/v5.asyncSend.html +++ b/functions/v5.asyncSend.html @@ -1 +1 @@ -asyncSend | bullmq - v5.30.1

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

    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 dbb1e7dae4..29deb75aa2 100644 --- a/functions/v5.childSend.html +++ b/functions/v5.childSend.html @@ -1 +1 @@ -childSend | bullmq - v5.30.1

    Function childSend

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 796ea55557..fb164adda5 100644 --- a/functions/v5.decreaseMaxListeners.html +++ b/functions/v5.decreaseMaxListeners.html @@ -1 +1 @@ -decreaseMaxListeners | bullmq - v5.30.1

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

    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.defaultRepeatStrategy.html b/functions/v5.defaultRepeatStrategy.html index 2b428eb6ba..aeb8dbb5f6 100644 --- a/functions/v5.defaultRepeatStrategy.html +++ b/functions/v5.defaultRepeatStrategy.html @@ -1 +1 @@ -defaultRepeatStrategy | bullmq - v5.30.1

    Function defaultRepeatStrategy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +defaultRepeatStrategy | bullmq - v5.31.0

    Function defaultRepeatStrategy

    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 31cd58c761..9168a99400 100644 --- a/functions/v5.delay.html +++ b/functions/v5.delay.html @@ -1 +1 @@ -delay | bullmq - v5.30.1

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

    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 00df77573d..36be2b8fe3 100644 --- a/functions/v5.errorToJSON.html +++ b/functions/v5.errorToJSON.html @@ -1 +1 @@ -errorToJSON | bullmq - v5.30.1

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

    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 a3701a38ce..8ca372f6b0 100644 --- a/functions/v5.getNextMillis.html +++ b/functions/v5.getNextMillis.html @@ -1 +1 @@ -getNextMillis | bullmq - v5.30.1

    Function getNextMillis

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 ffb0ced055..797df31809 100644 --- a/functions/v5.getParentKey.html +++ b/functions/v5.getParentKey.html @@ -1 +1 @@ -getParentKey | bullmq - v5.30.1

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

    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 a96ebdea64..082e1cfb54 100644 --- a/functions/v5.increaseMaxListeners.html +++ b/functions/v5.increaseMaxListeners.html @@ -1 +1 @@ -increaseMaxListeners | bullmq - v5.30.1

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

    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 550bffd999..6e945914df 100644 --- a/functions/v5.invertObject.html +++ b/functions/v5.invertObject.html @@ -1 +1 @@ -invertObject | bullmq - v5.30.1

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

    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 e563a79c0b..f88c3c7b0e 100644 --- a/functions/v5.isEmpty.html +++ b/functions/v5.isEmpty.html @@ -1 +1 @@ -isEmpty | bullmq - v5.30.1

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

    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 9658e06b36..46cc6ad433 100644 --- a/functions/v5.isNotConnectionError.html +++ b/functions/v5.isNotConnectionError.html @@ -1 +1 @@ -isNotConnectionError | bullmq - v5.30.1

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

    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 c186e2715f..5055e04643 100644 --- a/functions/v5.isRedisCluster.html +++ b/functions/v5.isRedisCluster.html @@ -1 +1 @@ -isRedisCluster | bullmq - v5.30.1

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

    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 06a1dd9aeb..1d446d8ed7 100644 --- a/functions/v5.isRedisInstance.html +++ b/functions/v5.isRedisInstance.html @@ -1 +1 @@ -isRedisInstance | bullmq - v5.30.1

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

    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 05a1fb97c0..0b93ce55ec 100644 --- a/functions/v5.isRedisVersionLowerThan.html +++ b/functions/v5.isRedisVersionLowerThan.html @@ -1 +1 @@ -isRedisVersionLowerThan | bullmq - v5.30.1

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

    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 37f7ee89a9..8fbdf4a346 100644 --- a/functions/v5.lengthInUtf8Bytes.html +++ b/functions/v5.lengthInUtf8Bytes.html @@ -1,3 +1,3 @@ -lengthInUtf8Bytes | bullmq - v5.30.1

    Function lengthInUtf8Bytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.optsAsJSON.html b/functions/v5.optsAsJSON.html index e23d6ef2fb..c7da65e199 100644 --- a/functions/v5.optsAsJSON.html +++ b/functions/v5.optsAsJSON.html @@ -1 +1 @@ -optsAsJSON | bullmq - v5.30.1

    Function optsAsJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +optsAsJSON | bullmq - v5.31.0

    Function optsAsJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/v5.optsFromJSON.html b/functions/v5.optsFromJSON.html index db3b2568aa..9ee825e1af 100644 --- a/functions/v5.optsFromJSON.html +++ b/functions/v5.optsFromJSON.html @@ -1 +1 @@ -optsFromJSON | bullmq - v5.30.1

    Function optsFromJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +optsFromJSON | bullmq - v5.31.0

    Function optsFromJSON

    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 b8ea8f50fe..ed2b9cd9f3 100644 --- a/functions/v5.parseObjectValues.html +++ b/functions/v5.parseObjectValues.html @@ -1 +1 @@ -parseObjectValues | bullmq - v5.30.1

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

    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 737bebb6e5..43c045e438 100644 --- a/functions/v5.raw2NextJobData.html +++ b/functions/v5.raw2NextJobData.html @@ -1 +1 @@ -raw2NextJobData | bullmq - v5.30.1

    Function raw2NextJobData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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 d00b3188f7..b50c2f4d8f 100644 --- a/functions/v5.removeAllQueueData.html +++ b/functions/v5.removeAllQueueData.html @@ -1 +1 @@ -removeAllQueueData | bullmq - v5.30.1

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

    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.removeUndefinedFields.html b/functions/v5.removeUndefinedFields.html index a7d9e0ed7b..a0a7fc2dae 100644 --- a/functions/v5.removeUndefinedFields.html +++ b/functions/v5.removeUndefinedFields.html @@ -1 +1 @@ -removeUndefinedFields | bullmq - v5.30.1

    Function removeUndefinedFields

    • removeUndefinedFields<T>(obj): T

    • Type Parameters

      • T extends Record<string, any>

      Parameters

      • obj: Record<string, any>

      Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +removeUndefinedFields | bullmq - v5.31.0

    Function removeUndefinedFields

    • removeUndefinedFields<T>(obj): T

    • Type Parameters

      • T extends Record<string, any>

      Parameters

      • obj: Record<string, any>

      Returns T

    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 2007c71b98..112b9d000c 100644 --- a/functions/v5.toString.html +++ b/functions/v5.toString.html @@ -1 +1 @@ -toString | bullmq - v5.30.1

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

    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.trace.html b/functions/v5.trace.html index 542b854593..8df679362d 100644 --- a/functions/v5.trace.html +++ b/functions/v5.trace.html @@ -1,8 +1,8 @@ -trace | bullmq - v5.30.1

    Function trace

    • trace<T>(telemetry, spanKind, queueName, operation, destination, callback, srcPropagationMetadata?): Promise<T>

    • Wraps the code with telemetry and provides a span for configuration.

      +trace | bullmq - v5.31.0

      Function trace

      • trace<T>(telemetry, spanKind, queueName, operation, destination, callback, srcPropagationMetadata?): Promise<T>

      • Wraps the code with telemetry and provides a span for configuration.

        Type Parameters

        • T

        Parameters

        • telemetry: {
              contextManager: ContextManager<any>;
              tracer: Tracer<any>;
          }

          telemetry configuration. If undefined, the callback will be executed without telemetry.

        • spanKind: SpanKind

          kind of the span: Producer, Consumer, Internal

        • queueName: string

          queue name

        • operation: string

          operation name (such as add, process, etc)

        • destination: string

          destination name (normally the queue name)

        • callback: ((span?, dstPropagationMetadata?) => T | Promise<T>)

          code to wrap with telemetry

          -
            • (span?, dstPropagationMetadata?): T | Promise<T>

            • Parameters

              • Optional span: Span<any>
              • Optional dstPropagationMetadata: string

              Returns T | Promise<T>

        • Optional srcPropagationMetadata: string

        Returns Promise<T>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +
        • (span?, dstPropagationMetadata?): T | Promise<T>

        • Parameters

          • Optional span: Span<any>
          • Optional dstPropagationMetadata: string

          Returns T | Promise<T>

    • Optional srcPropagationMetadata: string

    Returns Promise<T>

    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 1a4d75a1db..0b60344685 100644 --- a/functions/v5.tryCatch.html +++ b/functions/v5.tryCatch.html @@ -1 +1 @@ -tryCatch | bullmq - v5.30.1

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

    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 6ac8ecf0a6..688a26964c 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -bullmq - v5.30.1

    bullmq - v5.30.1

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    bullmq - v5.31.0

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 18b7a38d13..c2877c0816 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -bullmq - v5.30.1

    bullmq - v5.30.1

    +bullmq - v5.31.0

    bullmq - v5.31.0



    @@ -346,4 +346,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 4110b23fb3..6f66fae05a 100644 --- a/interfaces/v1.AddChildrenOpts.html +++ b/interfaces/v1.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.30.1

    Interface AddChildrenOpts

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

    Properties

    multi +AddChildrenOpts | bullmq - v5.31.0

    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 17b91eac14..4c0bf6e5e4 100644 --- a/interfaces/v1.AddNodeOpts.html +++ b/interfaces/v1.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.30.1

    Interface AddNodeOpts

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

    Properties

    multi +AddNodeOpts | bullmq - v5.31.0

    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 d55d993ceb..e8ad011237 100644 --- a/interfaces/v1.AdvancedOptions.html +++ b/interfaces/v1.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.30.1

    Interface AdvancedOptions

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

    Hierarchy (view full)

    Properties

    backoffStrategies? +AdvancedOptions | bullmq - v5.31.0

    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 0c5142ce0a..dd4461cce9 100644 --- a/interfaces/v1.AdvancedRepeatOptions.html +++ b/interfaces/v1.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.30.1

      Interface AdvancedRepeatOptions

      interface AdvancedRepeatOptions {
          repeatStrategy?: RepeatStrategy;
      }

      Hierarchy (view full)

      Properties

      repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.31.0

      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 e00f50fabb..2814043016 100644 --- a/interfaces/v1.BackoffOptions.html +++ b/interfaces/v1.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.30.1

      Interface BackoffOptions

      Settings for backing off failed jobs.

      +BackoffOptions | bullmq - v5.31.0

      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 25dbfb5995..c73216a30e 100644 --- a/interfaces/v1.BaseJobOptions.html +++ b/interfaces/v1.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.30.1

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

      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 b42f881959..a5de9141a3 100644 --- a/interfaces/v1.ChildMessage.html +++ b/interfaces/v1.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.30.1

      Interface ChildMessage

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

      Properties

      cmd +ChildMessage | bullmq - v5.31.0

      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 bb2b72c472..a07a76e93b 100644 --- a/interfaces/v1.ChildProcessExt.html +++ b/interfaces/v1.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.30.1

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

      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 f986786f6e..c83be2c29e 100644 --- a/interfaces/v1.Command.html +++ b/interfaces/v1.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.30.1

      Interface Command

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

      Properties

      name +Command | bullmq - v5.31.0

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

      Interface DependenciesOpts

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

      Properties

      processed? +DependenciesOpts | bullmq - v5.31.0

      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 5d9acbf27c..ec034ab312 100644 --- a/interfaces/v1.FlowJob.html +++ b/interfaces/v1.FlowJob.html @@ -1,7 +1,7 @@ -FlowJob | bullmq - v5.30.1

      Interface FlowJob

      interface FlowJob {
          children?: FlowJob[];
          data?: any;
          name: string;
          opts?: Omit<JobsOptions, "repeat" | "parent">;
          prefix?: string;
          queueName: string;
      }

      Properties

      children? +FlowJob | bullmq - v5.31.0

      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 12b548665c..7154eea86e 100644 --- a/interfaces/v1.FlowOpts.html +++ b/interfaces/v1.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.30.1

      Interface FlowOpts

      interface FlowOpts {
          queuesOptions: FlowQueuesOpts;
      }

      Properties

      queuesOptions +FlowOpts | bullmq - v5.31.0

      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 bac438dda4..438f896a39 100644 --- a/interfaces/v1.FlowProducerListener.html +++ b/interfaces/v1.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.30.1

      Interface FlowProducerListener

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

      Hierarchy (view full)

      Properties

      error +FlowProducerListener | bullmq - v5.31.0

      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 d323f9af2b..286f94e9b5 100644 --- a/interfaces/v1.GetNextJobOptions.html +++ b/interfaces/v1.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.30.1

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

      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 26e24a2a7c..dfc4cef2db 100644 --- a/interfaces/v1.IConnection.html +++ b/interfaces/v1.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.30.1

      Interface IConnection

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

      Hierarchy

      • EventEmitter
        • IConnection

      Properties

      client +IConnection | bullmq - v5.31.0

      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 d6b1c439ad..738b560181 100644 --- a/interfaces/v1.IoredisListener.html +++ b/interfaces/v1.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.30.1

      Interface IoredisListener

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

      Hierarchy (view full)

      Properties

      ioredis:close +IoredisListener | bullmq - v5.31.0

      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 8d4e587772..acb7f07062 100644 --- a/interfaces/v1.JobInformation3.html +++ b/interfaces/v1.JobInformation3.html @@ -1,8 +1,8 @@ -JobInformation3 | bullmq - v5.30.1

      Interface JobInformation3

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

      Properties

      cron +JobInformation3 | bullmq - v5.31.0

      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 9feecc7b90..f6af5df45b 100644 --- a/interfaces/v1.JobJson.html +++ b/interfaces/v1.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.30.1

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

      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 a3df8678eb..d683119d88 100644 --- a/interfaces/v1.JobJsonRaw.html +++ b/interfaces/v1.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.30.1

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

      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 782fb482f5..b1474e6e83 100644 --- a/interfaces/v1.JobNode.html +++ b/interfaces/v1.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.30.1

      Interface JobNode

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

      Properties

      children? +JobNode | bullmq - v5.31.0

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

      Interface JobPromise3

      interface JobPromise3 {
          cancel(): void;
      }

      Methods

      cancel +JobPromise3 | bullmq - v5.31.0

      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 390246d161..731b1728ae 100644 --- a/interfaces/v1.JobsOptions.html +++ b/interfaces/v1.JobsOptions.html @@ -1,4 +1,4 @@ -JobsOptions | bullmq - v5.30.1

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

      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 74003b5042..7908d47a84 100644 --- a/interfaces/v1.KeepJobs.html +++ b/interfaces/v1.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.30.1

      Interface KeepJobs

      KeepJobs

      +KeepJobs | bullmq - v5.31.0

      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 9870e4e169..2383ca67d8 100644 --- a/interfaces/v1.Metrics.html +++ b/interfaces/v1.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.30.1

      Interface Metrics

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

      Properties

      count +Metrics | bullmq - v5.31.0

      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 856fc779f9..0ae682a03c 100644 --- a/interfaces/v1.MetricsOptions.html +++ b/interfaces/v1.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.30.1

      Interface MetricsOptions

      interface MetricsOptions {
          maxDataPoints?: number;
      }

      Properties

      maxDataPoints? +MetricsOptions | bullmq - v5.31.0

      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 a7ebac2106..76d85be653 100644 --- a/interfaces/v1.MoveToWaitingChildrenOpts.html +++ b/interfaces/v1.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.30.1

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

      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 516872fb43..5fe2586d66 100644 --- a/interfaces/v1.NodeOpts.html +++ b/interfaces/v1.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.30.1

      Interface NodeOpts

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

      Properties

      depth? +NodeOpts | bullmq - v5.31.0

      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 1d2d48b5cf..91380eccb6 100644 --- a/interfaces/v1.ObliterateOpts.html +++ b/interfaces/v1.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.30.1

      Interface ObliterateOpts

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

      Properties

      count? +ObliterateOpts | bullmq - v5.31.0

      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 929ce7fa84..63e2c8efaf 100644 --- a/interfaces/v1.Parent.html +++ b/interfaces/v1.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.30.1

      Interface Parent<T>

      Describes the parent for a Job.

      +Parent | bullmq - v5.31.0

      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 e434e7f724..9fecbef20d 100644 --- a/interfaces/v1.ParentKeys.html +++ b/interfaces/v1.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.30.1

      Interface ParentKeys

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

      Properties

      id +ParentKeys | bullmq - v5.31.0

      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 c67c42cbac..d6220330be 100644 --- a/interfaces/v1.ParentMessage.html +++ b/interfaces/v1.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.30.1

      Interface ParentMessage

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

      Properties

      cmd +ParentMessage | bullmq - v5.31.0

      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 2c2d9c9c5b..f8c5270815 100644 --- a/interfaces/v1.QueueBaseOptions.html +++ b/interfaces/v1.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.30.1

      Interface QueueBaseOptions

      Base Queue options

      +QueueBaseOptions | bullmq - v5.31.0

      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 d466c2a547..ae87cabf00 100644 --- a/interfaces/v1.QueueEventsListener.html +++ b/interfaces/v1.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.30.1

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

      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 c23b521dd4..abd223040d 100644 --- a/interfaces/v1.QueueEventsOptions.html +++ b/interfaces/v1.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.30.1

      Interface QueueEventsOptions

      Options for QueueEvents

      +QueueEventsOptions | bullmq - v5.31.0

      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 260d1b4def..46ef83b0c0 100644 --- a/interfaces/v1.QueueListener.html +++ b/interfaces/v1.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.30.1

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

      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 1d87a52569..3b908e1dda 100644 --- a/interfaces/v1.QueueOptions.html +++ b/interfaces/v1.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.30.1

      Interface QueueOptions

      Options for the Queue class.

      +QueueOptions | bullmq - v5.31.0

      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 c3939db3ec..59946354a0 100644 --- a/interfaces/v1.QueueSchedulerListener.html +++ b/interfaces/v1.QueueSchedulerListener.html @@ -1,4 +1,4 @@ -QueueSchedulerListener | bullmq - v5.30.1

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

      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 7b82a944d4..9307220fc1 100644 --- a/interfaces/v1.QueueSchedulerOptions.html +++ b/interfaces/v1.QueueSchedulerOptions.html @@ -1,4 +1,4 @@ -QueueSchedulerOptions | bullmq - v5.30.1

      Interface QueueSchedulerOptions

      Options for customizing the behaviour of the scheduler.

      +QueueSchedulerOptions | bullmq - v5.31.0

      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 2b6d487470..10b61c88d0 100644 --- a/interfaces/v1.RateLimiterOptions.html +++ b/interfaces/v1.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.30.1

      Interface RateLimiterOptions

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

      Properties

      duration +RateLimiterOptions | bullmq - v5.31.0

      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 0991712f9f..f01d1dd7c5 100644 --- a/interfaces/v1.RepeatBaseOptions.html +++ b/interfaces/v1.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.30.1

      Interface RepeatBaseOptions

      Options for the Repeat class.

      +RepeatBaseOptions | bullmq - v5.31.0

      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 32db5fe39a..067a7ca740 100644 --- a/interfaces/v1.RepeatOptions.html +++ b/interfaces/v1.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.30.1

      Interface RepeatOptions

      Settings for repeatable jobs

      +RepeatOptions | bullmq - v5.31.0

      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 e77044620b..f8f4e236b4 100644 --- a/interfaces/v1.SandboxedJob.html +++ b/interfaces/v1.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.30.1

      Interface SandboxedJob<T, R>

      See

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

      +SandboxedJob | bullmq - v5.31.0

      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 36fdeac901..546a40d299 100644 --- a/interfaces/v1.ScriptMetadata.html +++ b/interfaces/v1.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.30.1

      Interface ScriptMetadata

      Script metadata

      +ScriptMetadata | bullmq - v5.31.0

      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 abab5dd599..045175f945 100644 --- a/interfaces/v1.Strategies.html +++ b/interfaces/v1.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.30.1

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

      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 c17ba1f16e..647a6ae847 100644 --- a/interfaces/v1.WorkerListener.html +++ b/interfaces/v1.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.30.1

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

      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 a46aca8c4f..263a84ed9d 100644 --- a/interfaces/v1.WorkerOptions.html +++ b/interfaces/v1.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.30.1

      Interface WorkerOptions

      Base Queue options

      +WorkerOptions | bullmq - v5.31.0

      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 a342aee84f..401c92f5c6 100644 --- a/interfaces/v2.AddChildrenOpts.html +++ b/interfaces/v2.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.30.1

      Interface AddChildrenOpts

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

      Properties

      multi +AddChildrenOpts | bullmq - v5.31.0

      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 4ce60f276b..d5f5c6181a 100644 --- a/interfaces/v2.AddNodeOpts.html +++ b/interfaces/v2.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.30.1

      Interface AddNodeOpts

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

      Properties

      multi +AddNodeOpts | bullmq - v5.31.0

      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 d65703c463..0e0c17d095 100644 --- a/interfaces/v2.AdvancedOptions.html +++ b/interfaces/v2.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.30.1

      Interface AdvancedOptions

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

      Hierarchy (view full)

      Properties

      backoffStrategies? +AdvancedOptions | bullmq - v5.31.0

      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 7f35e73839..20afb39289 100644 --- a/interfaces/v2.AdvancedRepeatOptions.html +++ b/interfaces/v2.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.30.1

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.31.0

        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 79d237c575..c975b44285 100644 --- a/interfaces/v2.BackoffOptions.html +++ b/interfaces/v2.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.30.1

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.31.0

        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 d3659f3df1..8500290d4f 100644 --- a/interfaces/v2.BaseJobOptions.html +++ b/interfaces/v2.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.30.1

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

        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 5810b9ef7b..913d9bb597 100644 --- a/interfaces/v2.ChildMessage.html +++ b/interfaces/v2.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.30.1

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.31.0

        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 aa020f8d40..0fd2c6c1bd 100644 --- a/interfaces/v2.ChildProcessExt.html +++ b/interfaces/v2.ChildProcessExt.html @@ -1,2 +1,2 @@ -ChildProcessExt | bullmq - v5.30.1

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

        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 d2e560f46f..2a32f41761 100644 --- a/interfaces/v2.Command.html +++ b/interfaces/v2.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.30.1

        Interface Command

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

        Properties

        name +Command | bullmq - v5.31.0

        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 4978e0dd15..b980130d72 100644 --- a/interfaces/v2.DefaultJobOptions.html +++ b/interfaces/v2.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.30.1

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

        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 4bad06b367..71a257ce66 100644 --- a/interfaces/v2.DependenciesOpts.html +++ b/interfaces/v2.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.30.1

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.31.0

        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 267b36b2cd..419f7240e4 100644 --- a/interfaces/v2.FlowOpts.html +++ b/interfaces/v2.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.30.1

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.31.0

        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 8c73f166a2..5f3fe08ed8 100644 --- a/interfaces/v2.FlowProducerListener.html +++ b/interfaces/v2.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.30.1

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.31.0

        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 7233c59c6d..354fd8a9d4 100644 --- a/interfaces/v2.GetNextJobOptions.html +++ b/interfaces/v2.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.30.1

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

        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 f538d94f3e..44e6cd207a 100644 --- a/interfaces/v2.IConnection.html +++ b/interfaces/v2.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.30.1

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.31.0

        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 6360594778..77d8ec8e70 100644 --- a/interfaces/v2.IoredisListener.html +++ b/interfaces/v2.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.30.1

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.31.0

        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 40cd10450d..67a1871bce 100644 --- a/interfaces/v2.JobJson.html +++ b/interfaces/v2.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.30.1

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

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

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

        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 7f9f0cbf2c..148b305806 100644 --- a/interfaces/v2.JobNode.html +++ b/interfaces/v2.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.30.1

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.31.0

        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 921e255611..612248604d 100644 --- a/interfaces/v2.KeepJobs.html +++ b/interfaces/v2.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.30.1

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.31.0

        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 7d968f4e16..4928ad5167 100644 --- a/interfaces/v2.Metrics.html +++ b/interfaces/v2.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.30.1

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.31.0

        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 a958b07b3c..1137a07ad0 100644 --- a/interfaces/v2.MetricsOptions.html +++ b/interfaces/v2.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.30.1

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.31.0

        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 d00d37dd58..edc579c630 100644 --- a/interfaces/v2.MoveToWaitingChildrenOpts.html +++ b/interfaces/v2.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.30.1

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

        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 a3be8b1625..445c429d2f 100644 --- a/interfaces/v2.NodeOpts.html +++ b/interfaces/v2.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.30.1

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.31.0

        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 bbe5f3b5a0..c05cdf082d 100644 --- a/interfaces/v2.ObliterateOpts.html +++ b/interfaces/v2.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.30.1

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.31.0

        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 bba13c06ad..db9910e945 100644 --- a/interfaces/v2.Parent.html +++ b/interfaces/v2.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.30.1

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.31.0

        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 cbd86d24d0..7cb3d5e2cd 100644 --- a/interfaces/v2.ParentKeys.html +++ b/interfaces/v2.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.30.1

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.31.0

        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 2d387aab7e..2f755335d1 100644 --- a/interfaces/v2.ParentMessage.html +++ b/interfaces/v2.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.30.1

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.31.0

        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 152c3b0d42..d1f08ae489 100644 --- a/interfaces/v2.QueueBaseOptions.html +++ b/interfaces/v2.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.30.1

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.31.0

        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 89a2a5b935..1510742ebc 100644 --- a/interfaces/v2.QueueEventsListener.html +++ b/interfaces/v2.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.30.1

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

        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 e90fa641e3..45d0f3b1ca 100644 --- a/interfaces/v2.QueueEventsOptions.html +++ b/interfaces/v2.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.30.1

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.31.0

        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 6db55c74a5..864fb76e25 100644 --- a/interfaces/v2.QueueListener.html +++ b/interfaces/v2.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.30.1

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

        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 a2ab9b631a..8fbc83ea85 100644 --- a/interfaces/v2.QueueOptions.html +++ b/interfaces/v2.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.30.1

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.31.0

        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 a0171f4b45..340145bad0 100644 --- a/interfaces/v2.RateLimiterOptions.html +++ b/interfaces/v2.RateLimiterOptions.html @@ -1,4 +1,4 @@ -RateLimiterOptions | bullmq - v5.30.1

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.31.0

        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 57eb5370c0..67c6ec4ad9 100644 --- a/interfaces/v2.RawCommand.html +++ b/interfaces/v2.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.30.1

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.31.0

        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 8b9c58b3d2..fd979fd961 100644 --- a/interfaces/v2.RepeatBaseOptions.html +++ b/interfaces/v2.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.30.1

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.31.0

        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 35b36e48c5..17044eef5c 100644 --- a/interfaces/v2.RepeatOptions.html +++ b/interfaces/v2.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.30.1

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.31.0

        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 8ca88cf531..b7b4f14123 100644 --- a/interfaces/v2.SandboxedJob.html +++ b/interfaces/v2.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.30.1

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.31.0

        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 995ec63d9a..d67890316d 100644 --- a/interfaces/v2.ScriptMetadata.html +++ b/interfaces/v2.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.30.1

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.31.0

        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 ffe8c86eab..b7db58798f 100644 --- a/interfaces/v2.Strategies.html +++ b/interfaces/v2.Strategies.html @@ -1 +1 @@ -Strategies | bullmq - v5.30.1

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

        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 2bed298dd3..8f28861d99 100644 --- a/interfaces/v2.WorkerListener.html +++ b/interfaces/v2.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.30.1

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

        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 25e1c93718..a09a76839d 100644 --- a/interfaces/v2.WorkerOptions.html +++ b/interfaces/v2.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.30.1

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.31.0

        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 69c1b9779a..2b86d1524d 100644 --- a/interfaces/v3.AddChildrenOpts.html +++ b/interfaces/v3.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.30.1

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.31.0

        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 0cd0c22f13..337cdb3f48 100644 --- a/interfaces/v3.AddNodeOpts.html +++ b/interfaces/v3.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.30.1

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.31.0

        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 e2ce450f41..4eeef3b235 100644 --- a/interfaces/v3.AdvancedOptions.html +++ b/interfaces/v3.AdvancedOptions.html @@ -1,5 +1,5 @@ -AdvancedOptions | bullmq - v5.30.1

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.31.0

        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 26a6722e68..f2d08fc179 100644 --- a/interfaces/v3.AdvancedRepeatOptions.html +++ b/interfaces/v3.AdvancedRepeatOptions.html @@ -1,3 +1,3 @@ -AdvancedRepeatOptions | bullmq - v5.30.1

        Interface AdvancedRepeatOptions

        interface AdvancedRepeatOptions {
            repeatStrategy?: RepeatStrategy;
        }

        Hierarchy (view full)

        Properties

        repeatStrategy? +AdvancedRepeatOptions | bullmq - v5.31.0

        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 275059147a..23bf4c071a 100644 --- a/interfaces/v3.BackoffOptions.html +++ b/interfaces/v3.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.30.1

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.31.0

        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 b79494b389..c9c8de7e50 100644 --- a/interfaces/v3.BaseJobOptions.html +++ b/interfaces/v3.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.30.1

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

        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 f5586f621a..28261f5490 100644 --- a/interfaces/v3.BaseOptions.html +++ b/interfaces/v3.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.30.1

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

        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 b477ee4ad7..d0977e33ae 100644 --- a/interfaces/v3.BuiltInStrategies.html +++ b/interfaces/v3.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.30.1

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

        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 16d8979388..75bd3f2f23 100644 --- a/interfaces/v3.ChildMessage.html +++ b/interfaces/v3.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.30.1

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.31.0

        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 719ba2a007..cd8edaabab 100644 --- a/interfaces/v3.Command.html +++ b/interfaces/v3.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.30.1

        Interface Command

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

        Properties

        name +Command | bullmq - v5.31.0

        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 b6a069a817..5a085fee7a 100644 --- a/interfaces/v3.DefaultJobOptions.html +++ b/interfaces/v3.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.30.1

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

        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 3782b96e8c..225801daf0 100644 --- a/interfaces/v3.DependenciesOpts.html +++ b/interfaces/v3.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.30.1

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.31.0

        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 9512d8b130..7e8c4e29a1 100644 --- a/interfaces/v3.FlowJobBase.html +++ b/interfaces/v3.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.30.1

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

        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 33a2182460..ce6d05a473 100644 --- a/interfaces/v3.FlowOpts.html +++ b/interfaces/v3.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.30.1

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.31.0

        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 d01ca47636..b6d69ab70f 100644 --- a/interfaces/v3.FlowProducerListener.html +++ b/interfaces/v3.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.30.1

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.31.0

        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 2ff76aa62a..fa3f76651c 100644 --- a/interfaces/v3.GetNextJobOptions.html +++ b/interfaces/v3.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.30.1

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

        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 246f878237..2344c327be 100644 --- a/interfaces/v3.IConnection.html +++ b/interfaces/v3.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.30.1

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.31.0

        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 33dac48221..3c15972c09 100644 --- a/interfaces/v3.IoredisListener.html +++ b/interfaces/v3.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.30.1

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.31.0

        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 951481770a..3da7499cd9 100644 --- a/interfaces/v3.JobJson.html +++ b/interfaces/v3.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.30.1

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

        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 02e8a18371..5162c09f08 100644 --- a/interfaces/v3.JobJsonRaw.html +++ b/interfaces/v3.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.30.1

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

        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 8831f6f474..71efd29d77 100644 --- a/interfaces/v3.JobNode.html +++ b/interfaces/v3.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.30.1

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.31.0

        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 d56e4afb7d..5a29ed7027 100644 --- a/interfaces/v3.KeepJobs.html +++ b/interfaces/v3.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.30.1

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.31.0

        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 10db96c3af..2fb76dbfa6 100644 --- a/interfaces/v3.Metrics.html +++ b/interfaces/v3.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.30.1

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.31.0

        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 260b155d43..3fbe7cafb7 100644 --- a/interfaces/v3.MetricsOptions.html +++ b/interfaces/v3.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.30.1

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.31.0

        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 0e484d5f62..06cf1d0d01 100644 --- a/interfaces/v3.MinimalJob.html +++ b/interfaces/v3.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.30.1

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.31.0

        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 72fec261cb..27d9144fb3 100644 --- a/interfaces/v3.MoveToWaitingChildrenOpts.html +++ b/interfaces/v3.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.30.1

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

        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 eaf7421ffb..448a37f2e2 100644 --- a/interfaces/v3.NodeOpts.html +++ b/interfaces/v3.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.30.1

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.31.0

        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 789e7ad4fc..31661eb29f 100644 --- a/interfaces/v3.ObliterateOpts.html +++ b/interfaces/v3.ObliterateOpts.html @@ -1,7 +1,7 @@ -ObliterateOpts | bullmq - v5.30.1

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.31.0

        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 c7f779c16b..c068116cbf 100644 --- a/interfaces/v3.Parent.html +++ b/interfaces/v3.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.30.1

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.31.0

        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 64e9cc8d8a..d87827f812 100644 --- a/interfaces/v3.ParentKeys.html +++ b/interfaces/v3.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.30.1

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.31.0

        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 c87e67adf9..14aa0e0af2 100644 --- a/interfaces/v3.ParentMessage.html +++ b/interfaces/v3.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.30.1

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.31.0

        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 1cf4a84010..45e4d3acff 100644 --- a/interfaces/v3.QueueBaseOptions.html +++ b/interfaces/v3.QueueBaseOptions.html @@ -1,4 +1,4 @@ -QueueBaseOptions | bullmq - v5.30.1

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.31.0

        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 26dc136784..2b4e34171b 100644 --- a/interfaces/v3.QueueEventsListener.html +++ b/interfaces/v3.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.30.1

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

        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 e1424b7c84..89eeb95c4c 100644 --- a/interfaces/v3.QueueEventsOptions.html +++ b/interfaces/v3.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.30.1

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.31.0

        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 78d51a988b..48e74c819f 100644 --- a/interfaces/v3.QueueListener.html +++ b/interfaces/v3.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.30.1

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

        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 170079cd0e..60e6a29474 100644 --- a/interfaces/v3.QueueOptions.html +++ b/interfaces/v3.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.30.1

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.31.0

        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 29f72ff5f6..c69a36eb7f 100644 --- a/interfaces/v3.RateLimiterOptions.html +++ b/interfaces/v3.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.30.1

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.31.0

        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 c87782d5a5..4842d6817f 100644 --- a/interfaces/v3.RawCommand.html +++ b/interfaces/v3.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.30.1

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.31.0

        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 7436a8feb9..32cf961324 100644 --- a/interfaces/v3.RepeatBaseOptions.html +++ b/interfaces/v3.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.30.1

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.31.0

        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 8d3b685248..63faa8e5a0 100644 --- a/interfaces/v3.RepeatOptions.html +++ b/interfaces/v3.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.30.1

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.31.0

        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 ffd2ca79d6..24e1a2cd62 100644 --- a/interfaces/v3.SandboxedJob.html +++ b/interfaces/v3.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.30.1

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.31.0

        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 c1918c92f6..12ebcbd377 100644 --- a/interfaces/v3.ScriptMetadata.html +++ b/interfaces/v3.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.30.1

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.31.0

        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 625390076e..d5004eb975 100644 --- a/interfaces/v3.WorkerListener.html +++ b/interfaces/v3.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.30.1

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

        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 5cf5e1b14b..cdbd5a03be 100644 --- a/interfaces/v3.WorkerOptions.html +++ b/interfaces/v3.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.30.1

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.31.0

        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 9e4ec63679..60eaa06d0c 100644 --- a/interfaces/v4.AddChildrenOpts.html +++ b/interfaces/v4.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.30.1

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.31.0

        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 87c89cd73f..029f2f6377 100644 --- a/interfaces/v4.AddNodeOpts.html +++ b/interfaces/v4.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.30.1

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.31.0

        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 6b52e48f45..040b042825 100644 --- a/interfaces/v4.AdvancedOptions.html +++ b/interfaces/v4.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.30.1

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.31.0

        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 1e21af6adc..53176bd7f0 100644 --- a/interfaces/v4.AdvancedRepeatOptions.html +++ b/interfaces/v4.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.30.1

        Interface AdvancedRepeatOptions

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

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.31.0

        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 13abf7a199..15d7909c1b 100644 --- a/interfaces/v4.BackoffOptions.html +++ b/interfaces/v4.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.30.1

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.31.0

        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 692852d551..0d05b4298d 100644 --- a/interfaces/v4.BaseJobOptions.html +++ b/interfaces/v4.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.30.1

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

        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 b91353cfd1..d1b4b53a21 100644 --- a/interfaces/v4.BaseOptions.html +++ b/interfaces/v4.BaseOptions.html @@ -1,2 +1,2 @@ -BaseOptions | bullmq - v5.30.1

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

        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 6172b500f3..aabae829a8 100644 --- a/interfaces/v4.BuiltInStrategies.html +++ b/interfaces/v4.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.30.1

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

        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 780a65297b..d866c53492 100644 --- a/interfaces/v4.ChildMessage.html +++ b/interfaces/v4.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.30.1

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.31.0

        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 9eb4f8e3e7..697065cd97 100644 --- a/interfaces/v4.Command.html +++ b/interfaces/v4.Command.html @@ -1,3 +1,3 @@ -Command | bullmq - v5.30.1

        Interface Command

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

        Properties

        name +Command | bullmq - v5.31.0

        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 ed209adf2f..2bc8076409 100644 --- a/interfaces/v4.DefaultJobOptions.html +++ b/interfaces/v4.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.30.1

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

        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 54c5521fdc..8b6d3b08f0 100644 --- a/interfaces/v4.DependenciesOpts.html +++ b/interfaces/v4.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.30.1

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.31.0

        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 3196e707cf..f0a7df3c29 100644 --- a/interfaces/v4.FlowJobBase.html +++ b/interfaces/v4.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.30.1

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

        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 b5cbe9a289..f03368cdcc 100644 --- a/interfaces/v4.FlowOpts.html +++ b/interfaces/v4.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.30.1

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.31.0

        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 7c92587bcb..3830274b8f 100644 --- a/interfaces/v4.FlowProducerListener.html +++ b/interfaces/v4.FlowProducerListener.html @@ -1,7 +1,7 @@ -FlowProducerListener | bullmq - v5.30.1

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.31.0

        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 e3c8c46bab..67e21e006d 100644 --- a/interfaces/v4.GetNextJobOptions.html +++ b/interfaces/v4.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.30.1

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

        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 8c4e37dcdf..a0b64b8346 100644 --- a/interfaces/v4.IConnection.html +++ b/interfaces/v4.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.30.1

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.31.0

        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 f3d24352b9..179809ddac 100644 --- a/interfaces/v4.IoredisListener.html +++ b/interfaces/v4.IoredisListener.html @@ -1,4 +1,4 @@ -IoredisListener | bullmq - v5.30.1

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.31.0

        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 37a6d47da0..f0f92815dc 100644 --- a/interfaces/v4.JobJson.html +++ b/interfaces/v4.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.30.1

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

        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 25bcc4db4a..7c3b177d8d 100644 --- a/interfaces/v4.JobJsonRaw.html +++ b/interfaces/v4.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.30.1

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

        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 5a775973ec..4f63141538 100644 --- a/interfaces/v4.JobNode.html +++ b/interfaces/v4.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.30.1

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.31.0

        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 66b053df13..e594c6facb 100644 --- a/interfaces/v4.KeepJobs.html +++ b/interfaces/v4.KeepJobs.html @@ -1,4 +1,4 @@ -KeepJobs | bullmq - v5.30.1

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.31.0

        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 b0b75623f4..e4c75de0db 100644 --- a/interfaces/v4.Metrics.html +++ b/interfaces/v4.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.30.1

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.31.0

        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 f5d68a5087..8ebe002976 100644 --- a/interfaces/v4.MetricsOptions.html +++ b/interfaces/v4.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.30.1

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.31.0

        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 5340cc9d44..6899b086c9 100644 --- a/interfaces/v4.MinimalJob.html +++ b/interfaces/v4.MinimalJob.html @@ -1,4 +1,4 @@ -MinimalJob | bullmq - v5.30.1

        Interface MinimalJob<DataType, ReturnType, NameType>

        MinimalJob

        +MinimalJob | bullmq - v5.31.0

        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 61f5a45c7c..7b23ac97ff 100644 --- a/interfaces/v4.MoveToWaitingChildrenOpts.html +++ b/interfaces/v4.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.30.1

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

        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 54a30dbea6..6ad424e75c 100644 --- a/interfaces/v4.NodeOpts.html +++ b/interfaces/v4.NodeOpts.html @@ -1,4 +1,4 @@ -NodeOpts | bullmq - v5.30.1

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.31.0

        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 20aeed7a41..ef80a77ec3 100644 --- a/interfaces/v4.ObliterateOpts.html +++ b/interfaces/v4.ObliterateOpts.html @@ -1,4 +1,4 @@ -ObliterateOpts | bullmq - v5.30.1

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.31.0

        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 f6f3ee6a3b..69cbc55527 100644 --- a/interfaces/v4.Parent.html +++ b/interfaces/v4.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.30.1

        Interface Parent<T>

        Describes the parent for a Job.

        +Parent | bullmq - v5.31.0

        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 deaea3eef1..ea90258de9 100644 --- a/interfaces/v4.ParentKeys.html +++ b/interfaces/v4.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.30.1

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.31.0

        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 f6d07016c2..cb9331e3e1 100644 --- a/interfaces/v4.ParentMessage.html +++ b/interfaces/v4.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.30.1

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.31.0

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

        Interface QueueBaseOptions

        Base Queue options

        +QueueBaseOptions | bullmq - v5.31.0

        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 a53cb5f320..7bb777aafb 100644 --- a/interfaces/v4.QueueEventsListener.html +++ b/interfaces/v4.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.30.1

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

        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 43d090f272..e4c7bbbb94 100644 --- a/interfaces/v4.QueueEventsOptions.html +++ b/interfaces/v4.QueueEventsOptions.html @@ -1,4 +1,4 @@ -QueueEventsOptions | bullmq - v5.30.1

        Interface QueueEventsOptions

        Options for QueueEvents

        +QueueEventsOptions | bullmq - v5.31.0

        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 8c844c330d..38e7f3e83a 100644 --- a/interfaces/v4.QueueListener.html +++ b/interfaces/v4.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.30.1

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

        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 f99311aa36..629471a7d4 100644 --- a/interfaces/v4.QueueOptions.html +++ b/interfaces/v4.QueueOptions.html @@ -1,4 +1,4 @@ -QueueOptions | bullmq - v5.30.1

        Interface QueueOptions

        Options for the Queue class.

        +QueueOptions | bullmq - v5.31.0

        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 a8127b284d..6b57fe9906 100644 --- a/interfaces/v4.RateLimiterOptions.html +++ b/interfaces/v4.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.30.1

        Interface RateLimiterOptions

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

        Properties

        duration +RateLimiterOptions | bullmq - v5.31.0

        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 fbf812b2b5..0f4f3693d0 100644 --- a/interfaces/v4.RawCommand.html +++ b/interfaces/v4.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.30.1

        Interface RawCommand

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

        Properties

        content +RawCommand | bullmq - v5.31.0

        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 1174f44cf2..25142a464b 100644 --- a/interfaces/v4.RepeatBaseOptions.html +++ b/interfaces/v4.RepeatBaseOptions.html @@ -1,4 +1,4 @@ -RepeatBaseOptions | bullmq - v5.30.1

        Interface RepeatBaseOptions

        Options for the Repeat class.

        +RepeatBaseOptions | bullmq - v5.31.0

        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 1da71824b6..ac2069ebe6 100644 --- a/interfaces/v4.RepeatOptions.html +++ b/interfaces/v4.RepeatOptions.html @@ -1,4 +1,4 @@ -RepeatOptions | bullmq - v5.30.1

        Interface RepeatOptions

        Settings for repeatable jobs

        +RepeatOptions | bullmq - v5.31.0

        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 9b6610c0e5..0ace311c05 100644 --- a/interfaces/v4.SandboxedJob.html +++ b/interfaces/v4.SandboxedJob.html @@ -1,4 +1,4 @@ -SandboxedJob | bullmq - v5.30.1

        Interface SandboxedJob<T, R>

        See

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

        +SandboxedJob | bullmq - v5.31.0

        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 29fa601ca2..2d44c47b14 100644 --- a/interfaces/v4.ScriptMetadata.html +++ b/interfaces/v4.ScriptMetadata.html @@ -1,4 +1,4 @@ -ScriptMetadata | bullmq - v5.30.1

        Interface ScriptMetadata

        Script metadata

        +ScriptMetadata | bullmq - v5.31.0

        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 11c314f327..26b433d67d 100644 --- a/interfaces/v4.WorkerListener.html +++ b/interfaces/v4.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.30.1

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

        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 8111df290c..ff70b6b248 100644 --- a/interfaces/v4.WorkerOptions.html +++ b/interfaces/v4.WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | bullmq - v5.30.1

        Interface WorkerOptions

        Base Queue options

        +WorkerOptions | bullmq - v5.31.0

        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 3439581856..f7d058428c 100644 --- a/interfaces/v5.AddChildrenOpts.html +++ b/interfaces/v5.AddChildrenOpts.html @@ -1,5 +1,5 @@ -AddChildrenOpts | bullmq - v5.30.1

        Interface AddChildrenOpts

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

        Properties

        multi +AddChildrenOpts | bullmq - v5.31.0

        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 842857b870..a8714005a6 100644 --- a/interfaces/v5.AddNodeOpts.html +++ b/interfaces/v5.AddNodeOpts.html @@ -1,6 +1,6 @@ -AddNodeOpts | bullmq - v5.30.1

        Interface AddNodeOpts

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

        Properties

        multi +AddNodeOpts | bullmq - v5.31.0

        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 76fd5403a3..339eb53944 100644 --- a/interfaces/v5.AdvancedOptions.html +++ b/interfaces/v5.AdvancedOptions.html @@ -1,8 +1,8 @@ -AdvancedOptions | bullmq - v5.30.1

        Interface AdvancedOptions

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

        Hierarchy (view full)

        Properties

        backoffStrategy? +AdvancedOptions | bullmq - v5.31.0

        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 f54c52a5ad..a38399c560 100644 --- a/interfaces/v5.AdvancedRepeatOptions.html +++ b/interfaces/v5.AdvancedRepeatOptions.html @@ -1,6 +1,6 @@ -AdvancedRepeatOptions | bullmq - v5.30.1

        Interface AdvancedRepeatOptions

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

        Hierarchy (view full)

        Properties

        repeatKeyHashAlgorithm? +AdvancedRepeatOptions | bullmq - v5.31.0

        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.Attributes.html b/interfaces/v5.Attributes.html index 1745ea98af..d7a231f462 100644 --- a/interfaces/v5.Attributes.html +++ b/interfaces/v5.Attributes.html @@ -1 +1 @@ -Attributes | bullmq - v5.30.1

        Interface Attributes

        interface Attributes {
            [attribute: string]: AttributeValue | undefined;
        }

        Indexable

        [attribute: string]: AttributeValue | undefined

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Attributes | bullmq - v5.31.0

        Interface Attributes

        interface Attributes {
            [attribute: string]: AttributeValue | undefined;
        }

        Indexable

        [attribute: string]: AttributeValue | undefined

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.BackoffOptions.html b/interfaces/v5.BackoffOptions.html index a57500f6dc..52e8dc279f 100644 --- a/interfaces/v5.BackoffOptions.html +++ b/interfaces/v5.BackoffOptions.html @@ -1,7 +1,7 @@ -BackoffOptions | bullmq - v5.30.1

        Interface BackoffOptions

        Settings for backing off failed jobs.

        +BackoffOptions | bullmq - v5.31.0

        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 8800a12041..8f90ca0adc 100644 --- a/interfaces/v5.BaseJobOptions.html +++ b/interfaces/v5.BaseJobOptions.html @@ -1,4 +1,4 @@ -BaseJobOptions | bullmq - v5.30.1

        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;
            telemetryMetadata?: string;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? +BaseJobOptions | bullmq - v5.31.0

        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;
            telemetryMetadata?: string;
            timestamp?: number;
        }

        Hierarchy (view full)

        Properties

        attempts? backoff? delay? jobId? @@ -18,44 +18,44 @@

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

        Default Value

        0
        -

        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 telemetryMetadata

        telemetryMetadata?: string

        TelemetryMetadata, provide for context propagation.

        -

        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 telemetryMetadata

        telemetryMetadata?: string

        TelemetryMetadata, provide for context propagation.

        +

        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 871fd7d192..c161841a83 100644 --- a/interfaces/v5.BaseOptions.html +++ b/interfaces/v5.BaseOptions.html @@ -1,3 +1,3 @@ -BaseOptions | bullmq - v5.30.1

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
            url?: string;
        }

        Properties

        skipVersionCheck? +BaseOptions | bullmq - v5.31.0

        Interface BaseOptions

        interface BaseOptions {
            skipVersionCheck?: boolean;
            url?: string;
        }

        Properties

        skipVersionCheck? url? -

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Optional url

        url?: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional skipVersionCheck

        skipVersionCheck?: boolean

        Optional url

        url?: string

        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 ceabc99eb1..8b123f3435 100644 --- a/interfaces/v5.BuiltInStrategies.html +++ b/interfaces/v5.BuiltInStrategies.html @@ -1 +1 @@ -BuiltInStrategies | bullmq - v5.30.1

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

        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 abe6be49ef..48fd52ef1e 100644 --- a/interfaces/v5.ChildMessage.html +++ b/interfaces/v5.ChildMessage.html @@ -1,4 +1,4 @@ -ChildMessage | bullmq - v5.30.1

        Interface ChildMessage

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

        Properties

        cmd +ChildMessage | bullmq - v5.31.0

        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.ContextManager.html b/interfaces/v5.ContextManager.html index e07c2eab88..a9db44a99d 100644 --- a/interfaces/v5.ContextManager.html +++ b/interfaces/v5.ContextManager.html @@ -1,15 +1,15 @@ -ContextManager | bullmq - v5.30.1

        Interface ContextManager<Context>

        Context manager interface

        +ContextManager | bullmq - v5.31.0

        Interface ContextManager<Context>

        Context manager interface

        The context manager is responsible for managing the context and propagating it across the application.

        -
        interface ContextManager<Context> {
            active(): Context;
            fromMetadata(activeContext, metadata): Context;
            getMetadata(context): string;
            with<A>(context, fn): ReturnType<A>;
        }

        Type Parameters

        • Context = any

        Methods

        active +
        interface ContextManager<Context> {
            active(): Context;
            fromMetadata(activeContext, metadata): Context;
            getMetadata(context): string;
            with<A>(context, fn): ReturnType<A>;
        }

        Type Parameters

        • Context = any

        Methods

        active fromMetadata getMetadata with

        Methods

        active

        fromMetadata

        fromMetadata

        • fromMetadata(activeContext, metadata): Context

        • Creates a new context from a serialized version effectively linking the new context to the parent context.

          -

          Parameters

          • activeContext: Context
          • metadata: string

          Returns Context

        getMetadata

        getMetadata

        • getMetadata(context): string

        • Returns a serialized version of the current context. The metadata is the mechanism used to propagate the context across a distributed application.

          -

          Parameters

          Returns string

        with

        • with<A>(context, fn): ReturnType<A>

        • Creates a new context and sets it as active for the fn passed as last argument

          -

          Type Parameters

          • A extends ((...args) => any)

          Parameters

          Returns ReturnType<A>

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns string

        with

        • with<A>(context, fn): ReturnType<A>

        • Creates a new context and sets it as active for the fn passed as last argument

          +

          Type Parameters

          • A extends ((...args) => any)

          Parameters

          Returns ReturnType<A>

        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 13cc426285..dd3afdd655 100644 --- a/interfaces/v5.DebounceOptions.html +++ b/interfaces/v5.DebounceOptions.html @@ -1,6 +1,6 @@ -DebounceOptions | bullmq - v5.30.1

        Interface DebounceOptions

        Debounce options

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

        Properties

        id +DebounceOptions | bullmq - v5.31.0

        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 f7295862a6..185973954b 100644 --- a/interfaces/v5.DefaultJobOptions.html +++ b/interfaces/v5.DefaultJobOptions.html @@ -1,4 +1,4 @@ -DefaultJobOptions | bullmq - v5.30.1

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

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

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

        Optional priority

        priority?: number

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

        Default Value

        0
        -

        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 99b2ae795e..37ffd3b521 100644 --- a/interfaces/v5.DependenciesOpts.html +++ b/interfaces/v5.DependenciesOpts.html @@ -1,3 +1,3 @@ -DependenciesOpts | bullmq - v5.30.1

        Interface DependenciesOpts

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

        Properties

        processed? +DependenciesOpts | bullmq - v5.31.0

        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 4ae23b9c79..f38db7a0c7 100644 --- a/interfaces/v5.FlowJobBase.html +++ b/interfaces/v5.FlowJobBase.html @@ -1,7 +1,7 @@ -FlowJobBase | bullmq - v5.30.1

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

        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 7059a92588..0665ecfdbf 100644 --- a/interfaces/v5.FlowOpts.html +++ b/interfaces/v5.FlowOpts.html @@ -1,3 +1,3 @@ -FlowOpts | bullmq - v5.30.1

        Interface FlowOpts

        interface FlowOpts {
            queuesOptions: FlowQueuesOpts;
        }

        Properties

        queuesOptions +FlowOpts | bullmq - v5.31.0

        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 388a554aa1..929f6a27d4 100644 --- a/interfaces/v5.FlowProducerListener.html +++ b/interfaces/v5.FlowProducerListener.html @@ -1,11 +1,11 @@ -FlowProducerListener | bullmq - v5.30.1

        Interface FlowProducerListener

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

        Hierarchy (view full)

        Properties

        error +FlowProducerListener | bullmq - v5.31.0

        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 8d105c5cdf..e0dc68cc82 100644 --- a/interfaces/v5.GetNextJobOptions.html +++ b/interfaces/v5.GetNextJobOptions.html @@ -1,2 +1,2 @@ -GetNextJobOptions | bullmq - v5.30.1

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

        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 4d955aa913..3aee33765b 100644 --- a/interfaces/v5.IConnection.html +++ b/interfaces/v5.IConnection.html @@ -1,3 +1,3 @@ -IConnection | bullmq - v5.30.1

        Interface IConnection

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

        Hierarchy

        • EventEmitter
          • IConnection

        Properties

        client +IConnection | bullmq - v5.31.0

        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 0a2c8a656c..b1df331989 100644 --- a/interfaces/v5.IoredisListener.html +++ b/interfaces/v5.IoredisListener.html @@ -1,6 +1,6 @@ -IoredisListener | bullmq - v5.30.1

        Interface IoredisListener

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

        Hierarchy (view full)

        Properties

        ioredis:close +IoredisListener | bullmq - v5.31.0

        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 870c611e69..1ff2f23390 100644 --- a/interfaces/v5.JobJson.html +++ b/interfaces/v5.JobJson.html @@ -1,4 +1,4 @@ -JobJson | bullmq - v5.30.1

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            attemptsStarted: number;
            data: string;
            debounceId?: string;
            deduplicationId?: 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.31.0

        Interface JobJson

        interface JobJson {
            attemptsMade: number;
            attemptsStarted: number;
            data: string;
            debounceId?: string;
            deduplicationId?: 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? @@ -17,4 +17,4 @@ returnvalue stacktrace timestamp -

        Properties

        attemptsMade

        attemptsMade: number

        attemptsStarted

        attemptsStarted: number

        data

        data: string

        Optional debounceId

        debounceId?: string

        Optional deduplicationId

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

        Optional deduplicationId

        deduplicationId?: 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 73cf87ace5..8046d9d32e 100644 --- a/interfaces/v5.JobJsonRaw.html +++ b/interfaces/v5.JobJsonRaw.html @@ -1,4 +1,4 @@ -JobJsonRaw | bullmq - v5.30.1

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

        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 52aa3c1d4c..f9be2017c3 100644 --- a/interfaces/v5.JobNode.html +++ b/interfaces/v5.JobNode.html @@ -1,3 +1,3 @@ -JobNode | bullmq - v5.30.1

        Interface JobNode

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

        Properties

        children? +JobNode | bullmq - v5.31.0

        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.JobSchedulerJson.html b/interfaces/v5.JobSchedulerJson.html index 50c6ab69c0..293a81d520 100644 --- a/interfaces/v5.JobSchedulerJson.html +++ b/interfaces/v5.JobSchedulerJson.html @@ -1,4 +1,4 @@ -JobSchedulerJson | bullmq - v5.30.1

        Interface JobSchedulerJson<D>

        interface JobSchedulerJson<D> {
            endDate: number;
            every?: string;
            id?: string;
            key: string;
            name: string;
            next?: number;
            pattern: string;
            template?: JobSchedulerTemplateJson<D>;
            tz: string;
        }

        Type Parameters

        • D = any

        Properties

        endDate +JobSchedulerJson | bullmq - v5.31.0

        Interface JobSchedulerJson<D>

        interface JobSchedulerJson<D> {
            endDate: number;
            every?: string;
            id?: string;
            key: string;
            name: string;
            next?: number;
            pattern: string;
            template?: JobSchedulerTemplateJson<D>;
            tz: string;
        }

        Type Parameters

        • D = any

        Properties

        endDate every? id? key @@ -7,4 +7,4 @@ pattern template? tz -

        Properties

        endDate

        endDate: number

        Optional every

        every?: string

        Optional id

        id?: string

        key

        key: string

        name

        name: string

        Optional next

        next?: number

        pattern

        pattern: string

        Optional template

        template?: JobSchedulerTemplateJson<D>

        tz

        tz: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        endDate

        endDate: number

        Optional every

        every?: string

        Optional id

        id?: string

        key

        key: string

        name

        name: string

        Optional next

        next?: number

        pattern

        pattern: string

        Optional template

        template?: JobSchedulerTemplateJson<D>

        tz

        tz: string

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/v5.JobSchedulerTemplateJson.html b/interfaces/v5.JobSchedulerTemplateJson.html index c7cbe479a2..4d18bfbe55 100644 --- a/interfaces/v5.JobSchedulerTemplateJson.html +++ b/interfaces/v5.JobSchedulerTemplateJson.html @@ -1,3 +1,3 @@ -JobSchedulerTemplateJson | bullmq - v5.30.1

        Interface JobSchedulerTemplateJson<D>

        interface JobSchedulerTemplateJson<D> {
            data?: D;
            opts?: Omit<JobsOptions, "repeat" | "jobId" | "delay">;
        }

        Type Parameters

        • D = any

        Properties

        data? +JobSchedulerTemplateJson | bullmq - v5.31.0

        Interface JobSchedulerTemplateJson<D>

        interface JobSchedulerTemplateJson<D> {
            data?: D;
            opts?: Omit<JobsOptions, "repeat" | "jobId" | "delay">;
        }

        Type Parameters

        • D = any

        Properties

        data? opts? -

        Properties

        Optional data

        data?: D

        Optional opts

        opts?: Omit<JobsOptions, "repeat" | "jobId" | "delay">

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        Optional data

        data?: D

        Optional opts

        opts?: Omit<JobsOptions, "repeat" | "jobId" | "delay">

        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 41c4ca0d6b..9af90d384d 100644 --- a/interfaces/v5.KeepJobs.html +++ b/interfaces/v5.KeepJobs.html @@ -1,9 +1,9 @@ -KeepJobs | bullmq - v5.30.1

        Interface KeepJobs

        KeepJobs

        +KeepJobs | bullmq - v5.31.0

        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 3eb677dbe4..46dde75cf2 100644 --- a/interfaces/v5.Metrics.html +++ b/interfaces/v5.Metrics.html @@ -1,4 +1,4 @@ -Metrics | bullmq - v5.30.1

        Interface Metrics

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

        Properties

        count +Metrics | bullmq - v5.31.0

        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 d83908c5a0..711093ccb6 100644 --- a/interfaces/v5.MetricsOptions.html +++ b/interfaces/v5.MetricsOptions.html @@ -1,5 +1,5 @@ -MetricsOptions | bullmq - v5.30.1

        Interface MetricsOptions

        interface MetricsOptions {
            maxDataPoints?: number;
        }

        Properties

        maxDataPoints? +MetricsOptions | bullmq - v5.31.0

        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 4243e47c33..f13c518f3b 100644 --- a/interfaces/v5.MinimalJob.html +++ b/interfaces/v5.MinimalJob.html @@ -1,5 +1,5 @@ -MinimalJob | bullmq - v5.30.1

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

        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 41d369dab4..a461600bc6 100644 --- a/interfaces/v5.MoveToDelayedOpts.html +++ b/interfaces/v5.MoveToDelayedOpts.html @@ -1,2 +1,2 @@ -MoveToDelayedOpts | bullmq - v5.30.1

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

        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 f47dfb1b65..01a397d75f 100644 --- a/interfaces/v5.MoveToWaitingChildrenOpts.html +++ b/interfaces/v5.MoveToWaitingChildrenOpts.html @@ -1,2 +1,2 @@ -MoveToWaitingChildrenOpts | bullmq - v5.30.1

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

        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 7935ab7895..c0858e9047 100644 --- a/interfaces/v5.NodeOpts.html +++ b/interfaces/v5.NodeOpts.html @@ -1,11 +1,11 @@ -NodeOpts | bullmq - v5.30.1

        Interface NodeOpts

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

        Properties

        depth? +NodeOpts | bullmq - v5.31.0

        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 784a423c79..b20fab4250 100644 --- a/interfaces/v5.ObliterateOpts.html +++ b/interfaces/v5.ObliterateOpts.html @@ -1,9 +1,9 @@ -ObliterateOpts | bullmq - v5.30.1

        Interface ObliterateOpts

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

        Properties

        count? +ObliterateOpts | bullmq - v5.31.0

        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 f0812b3d80..6e229a720e 100644 --- a/interfaces/v5.Parent.html +++ b/interfaces/v5.Parent.html @@ -1,7 +1,7 @@ -Parent | bullmq - v5.30.1

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

        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 094a8db815..a691ab8c81 100644 --- a/interfaces/v5.ParentKeys.html +++ b/interfaces/v5.ParentKeys.html @@ -1,3 +1,3 @@ -ParentKeys | bullmq - v5.30.1

        Interface ParentKeys

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

        Properties

        id +ParentKeys | bullmq - v5.31.0

        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 f7c30c0c13..83100a47d0 100644 --- a/interfaces/v5.ParentMessage.html +++ b/interfaces/v5.ParentMessage.html @@ -1,5 +1,5 @@ -ParentMessage | bullmq - v5.30.1

        Interface ParentMessage

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

        Properties

        cmd +ParentMessage | bullmq - v5.31.0

        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 65d24a6616..8ec3a0f88d 100644 --- a/interfaces/v5.QueueBaseOptions.html +++ b/interfaces/v5.QueueBaseOptions.html @@ -1,14 +1,14 @@ -QueueBaseOptions | bullmq - v5.30.1

        Interface QueueBaseOptions

        Base Queue options

        -
        interface QueueBaseOptions {
            blockingConnection?: boolean;
            connection: ConnectionOptions;
            prefix?: string;
            skipVersionCheck?: boolean;
            telemetry?: Telemetry<any>;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? +QueueBaseOptions | bullmq - v5.31.0

        Interface QueueBaseOptions

        Base Queue options

        +
        interface QueueBaseOptions {
            blockingConnection?: boolean;
            connection: ConnectionOptions;
            prefix?: string;
            skipVersionCheck?: boolean;
            telemetry?: Telemetry<any>;
        }

        Hierarchy (view full)

        Properties

        blockingConnection? connection prefix? skipVersionCheck? telemetry?

        Properties

        Optional blockingConnection

        blockingConnection?: boolean

        Denotes commands should retry indefinitely.

        -

        Deprecated

        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.

        +

        Deprecated

        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
        -

        Optional telemetry

        telemetry?: Telemetry<any>

        Telemetry client

        -

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Optional telemetry

        telemetry?: Telemetry<any>

        Telemetry client

        +

        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 26af8b041a..e8f8a53328 100644 --- a/interfaces/v5.QueueEventsListener.html +++ b/interfaces/v5.QueueEventsListener.html @@ -1,4 +1,4 @@ -QueueEventsListener | bullmq - v5.30.1

        Interface QueueEventsListener

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

        Interface QueueEventsListener

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

        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.

        Type declaration

          • (args, id): void

          • Listen to 'debounced' event.

            Parameters

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

            Returns void

            Deprecated

            use deduplicated event

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

        Deprecated

        use deduplicated event

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

        -

        deduplicated

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

        Listen to 'deduplicated' event.

        +

        deduplicated

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

        Listen to 'deduplicated' event.

        This event is triggered when a job is deduplicated because deduplicatedId still existed.

        Type declaration

          • (args, id): void

          • Listen to 'deduplicated' event.

            This event is triggered when a job is deduplicated because deduplicatedId still existed.

            -

            Parameters

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

            Returns void

        delayed

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

        Listen to 'delayed' event.

        +

        Parameters

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

        @@ -56,27 +56,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 @@ -86,21 +86,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.

                @@ -108,12 +108,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 73491bfae2..cb743a3dac 100644 --- a/interfaces/v5.QueueEventsOptions.html +++ b/interfaces/v5.QueueEventsOptions.html @@ -1,5 +1,5 @@ -QueueEventsOptions | bullmq - v5.30.1

                Interface QueueEventsOptions

                Options for QueueEvents

                -
                interface QueueEventsOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    blockingTimeout?: number;
                    connection: ConnectionOptions;
                    lastEventId?: string;
                    prefix?: string;
                    skipVersionCheck?: boolean;
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                autorun? +QueueEventsOptions | bullmq - v5.31.0

                Interface QueueEventsOptions

                Options for QueueEvents

                +
                interface QueueEventsOptions {
                    autorun?: boolean;
                    blockingConnection?: boolean;
                    blockingTimeout?: number;
                    connection: ConnectionOptions;
                    lastEventId?: string;
                    prefix?: string;
                    skipVersionCheck?: boolean;
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                autorun? blockingConnection? blockingTimeout? connection @@ -8,15 +8,15 @@ skipVersionCheck? telemetry?

                Properties

                Optional autorun

                autorun?: boolean

                Condition to start listening to events at instance creation.

                -

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Deprecated

                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.

                +

                Deprecated

                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
                -

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                +

                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 802d469009..5356dcfb9f 100644 --- a/interfaces/v5.QueueListener.html +++ b/interfaces/v5.QueueListener.html @@ -1,4 +1,4 @@ -QueueListener | bullmq - v5.30.1

                Interface QueueListener<JobBase>

                interface QueueListener<JobBase> {
                    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

                Hierarchy (view full)

                Properties

                cleaned +QueueListener | bullmq - v5.31.0

                Interface QueueListener<JobBase>

                interface QueueListener<JobBase> {
                    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

                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

                    • job: JobBase
                    • progress: number | object

                    Returns void

                removed

                removed: ((job) => void)

                Listen to 'removed' event.

                +

                Parameters

                • job: JobBase
                • progress: number | object

                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 17569c0b18..ead04a26b3 100644 --- a/interfaces/v5.QueueOptions.html +++ b/interfaces/v5.QueueOptions.html @@ -1,5 +1,5 @@ -QueueOptions | bullmq - v5.30.1

                Interface QueueOptions

                Options for the Queue class.

                -
                interface QueueOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    defaultJobOptions?: DefaultJobOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipMetasUpdate?: boolean;
                    skipVersionCheck?: boolean;
                    streams?: {
                        events: {
                            maxLen: number;
                        };
                    };
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? +QueueOptions | bullmq - v5.31.0

                Interface QueueOptions

                Options for the Queue class.

                +
                interface QueueOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    defaultJobOptions?: DefaultJobOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipMetasUpdate?: boolean;
                    skipVersionCheck?: boolean;
                    streams?: {
                        events: {
                            maxLen: number;
                        };
                    };
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? connection defaultJobOptions? prefix? @@ -9,19 +9,19 @@ streams? telemetry?

                Properties

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Deprecated

                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

                Advanced options for the repeatable jobs.

                -

                Optional skipMetasUpdate

                skipMetasUpdate?: boolean

                Skip Meta update.

                +

                Deprecated

                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

                Advanced options for the repeatable jobs.

                +

                Optional skipMetasUpdate

                skipMetasUpdate?: boolean

                Skip Meta update.

                If true, the queue will not update the metadata of the queue. Useful for read-only systems that do should not update the metadata.

                Default Value

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

                    -

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                +

                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 417564b0e2..b1a89a7710 100644 --- a/interfaces/v5.RateLimiterOptions.html +++ b/interfaces/v5.RateLimiterOptions.html @@ -1,7 +1,7 @@ -RateLimiterOptions | bullmq - v5.30.1

                Interface RateLimiterOptions

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

                Properties

                duration +RateLimiterOptions | bullmq - v5.31.0

                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 8e89e9c13b..137b8e289e 100644 --- a/interfaces/v5.RawCommand.html +++ b/interfaces/v5.RawCommand.html @@ -1,4 +1,4 @@ -RawCommand | bullmq - v5.30.1

                Interface RawCommand

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

                Properties

                content +RawCommand | bullmq - v5.31.0

                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 2070f4abd4..bda77c2cd7 100644 --- a/interfaces/v5.RepeatBaseOptions.html +++ b/interfaces/v5.RepeatBaseOptions.html @@ -1,15 +1,15 @@ -RepeatBaseOptions | bullmq - v5.30.1

                Interface RepeatBaseOptions

                Options for the Repeat class.

                -
                interface RepeatBaseOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? +RepeatBaseOptions | bullmq - v5.31.0

                Interface RepeatBaseOptions

                Options for the Repeat class.

                +
                interface RepeatBaseOptions {
                    blockingConnection?: boolean;
                    connection: ConnectionOptions;
                    prefix?: string;
                    settings?: AdvancedRepeatOptions;
                    skipVersionCheck?: boolean;
                    telemetry?: Telemetry<any>;
                }

                Hierarchy (view full)

                Properties

                blockingConnection? connection prefix? settings? skipVersionCheck? telemetry?

                Properties

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Deprecated

                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.

                +

                Deprecated

                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
                -

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                -

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry client

                +

                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 5fdb1b153a..b7758f7cbb 100644 --- a/interfaces/v5.RepeatOptions.html +++ b/interfaces/v5.RepeatOptions.html @@ -1,6 +1,6 @@ -RepeatOptions | bullmq - v5.30.1

                Interface RepeatOptions

                Settings for repeatable jobs

                +RepeatOptions | bullmq - v5.31.0

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

                Internal property to store de job id

                -

                Deprecated

                Optional key

                key?: string

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

                Optional jobId

                jobId?: string

                Internal property to store de job id

                +

                Deprecated

                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

                Internal property to store the offset to apply to the next iteration.

                -

                Deprecated

                Optional pattern

                pattern?: string

                A repeat pattern

                -

                Optional prevMillis

                prevMillis?: number

                Internal property to store the previous time the job was executed.

                -

                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

                Internal property to store the offset to apply to the next iteration.

                +

                Deprecated

                Optional pattern

                pattern?: string

                A repeat pattern

                +

                Optional prevMillis

                prevMillis?: number

                Internal property to store the previous time the job was executed.

                +

                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 7675e4397c..0505468679 100644 --- a/interfaces/v5.SandboxedJob.html +++ b/interfaces/v5.SandboxedJob.html @@ -1,5 +1,5 @@ -SandboxedJob | bullmq - v5.30.1

                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;
                    deduplicationId?: 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.31.0

                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;
                    deduplicationId?: 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? @@ -25,4 +25,4 @@ timestamp updateData updateProgress -

                Properties

                attemptsMade

                attemptsMade: number

                attemptsStarted

                attemptsStarted: number

                data

                data: T

                Optional debounceId

                debounceId?: string

                Optional deduplicationId

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

                Optional deduplicationId

                deduplicationId?: 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.SandboxedOptions.html b/interfaces/v5.SandboxedOptions.html index c2d5f002c3..14d73a2c7b 100644 --- a/interfaces/v5.SandboxedOptions.html +++ b/interfaces/v5.SandboxedOptions.html @@ -1,4 +1,4 @@ -SandboxedOptions | bullmq - v5.30.1

                Interface SandboxedOptions

                interface SandboxedOptions {
                    useWorkerThreads?: boolean;
                    workerForkOptions?: ForkOptions;
                    workerThreadsOptions?: WorkerOptions;
                }

                Hierarchy (view full)

                Properties

                useWorkerThreads? +SandboxedOptions | bullmq - v5.31.0

                Interface SandboxedOptions

                interface SandboxedOptions {
                    useWorkerThreads?: boolean;
                    workerForkOptions?: ForkOptions;
                    workerThreadsOptions?: WorkerOptions;
                }

                Hierarchy (view full)

                Properties

                useWorkerThreads? workerForkOptions? workerThreadsOptions?

                Properties

                Optional useWorkerThreads

                useWorkerThreads?: boolean

                Use Worker Threads instead of Child Processes. @@ -6,12 +6,12 @@ a file for the processor argument.

                Default

                false
                -

                Optional workerForkOptions

                workerForkOptions?: ForkOptions

                Support passing Worker Fork Options. +

                Optional workerForkOptions

                workerForkOptions?: ForkOptions

                Support passing Worker Fork Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as false (default value).

                See

                https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options

                -

                Optional workerThreadsOptions

                workerThreadsOptions?: WorkerOptions

                Support passing Worker Threads Options. +

                Optional workerThreadsOptions

                workerThreadsOptions?: WorkerOptions

                Support passing Worker Threads Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as true.

                See

                https://nodejs.org/api/worker_threads.html#new-workerfilename-options

                -

                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.Span.html b/interfaces/v5.Span.html index 67085e9300..e30cdc8589 100644 --- a/interfaces/v5.Span.html +++ b/interfaces/v5.Span.html @@ -1,16 +1,16 @@ -Span | bullmq - v5.30.1

                Interface Span<Context>

                Span interface

                -
                interface Span<Context> {
                    addEvent(name, attributes?): void;
                    end(): void;
                    recordException(exception, time?): void;
                    setAttribute(key, value): void;
                    setAttributes(attributes): void;
                    setSpanOnContext(ctx): Context;
                }

                Type Parameters

                • Context = any

                Methods

                addEvent +Span | bullmq - v5.31.0

                Interface Span<Context>

                Span interface

                +
                interface Span<Context> {
                    addEvent(name, attributes?): void;
                    end(): void;
                    recordException(exception, time?): void;
                    setAttribute(key, value): void;
                    setAttributes(attributes): void;
                    setSpanOnContext(ctx): Context;
                }

                Type Parameters

                • Context = any

                Methods

                addEvent end recordException setAttribute setAttributes setSpanOnContext

                Methods

                addEvent

                end

                end

                • end(): void

                • end ends the span.

                  Note: spans must be ended so that they can be exported.

                  -

                  Returns void

                recordException

                setAttribute

                setAttributes

                setSpanOnContext

                recordException

                setAttribute

                setAttributes

                setSpanOnContext

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Parameters

                Returns Context

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.SpanOptions.html b/interfaces/v5.SpanOptions.html index bbc8ac76ff..8ec18bd32a 100644 --- a/interfaces/v5.SpanOptions.html +++ b/interfaces/v5.SpanOptions.html @@ -1,2 +1,2 @@ -SpanOptions | bullmq - v5.30.1

                Interface SpanOptions

                interface SpanOptions {
                    kind: SpanKind;
                }

                Properties

                kind -

                Properties

                kind

                kind: SpanKind

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +SpanOptions | bullmq - v5.31.0

                Interface SpanOptions

                interface SpanOptions {
                    kind: SpanKind;
                }

                Properties

                kind +

                Properties

                kind

                kind: SpanKind

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file diff --git a/interfaces/v5.Telemetry.html b/interfaces/v5.Telemetry.html index fdf26ddf67..669b4a1152 100644 --- a/interfaces/v5.Telemetry.html +++ b/interfaces/v5.Telemetry.html @@ -1,13 +1,13 @@ -Telemetry | bullmq - v5.30.1

                Interface Telemetry<Context>

                Telemetry interface

                +Telemetry | bullmq - v5.31.0

                Interface Telemetry<Context>

                Telemetry interface

                This interface allows third-party libraries to integrate their own telemetry system. The interface is heavily inspired by OpenTelemetry but it's not limited to it.

                -
                interface Telemetry<Context> {
                    contextManager: ContextManager<any>;
                    tracer: Tracer<Context>;
                }

                Type Parameters

                • Context = any

                Properties

                contextManager +
                interface Telemetry<Context> {
                    contextManager: ContextManager<any>;
                    tracer: Tracer<Context>;
                }

                Type Parameters

                • Context = any

                Properties

                contextManager tracer

                Properties

                contextManager

                contextManager: ContextManager<any>

                Context manager instance

                The context manager is responsible for managing the context and propagating it across the application.

                -

                tracer

                tracer: Tracer<Context>

                Tracer instance

                +

                tracer

                tracer: Tracer<Context>

                Tracer instance

                The tracer is responsible for creating spans and propagating the context across the application.

                -

                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.Tracer.html b/interfaces/v5.Tracer.html index 509ef8c1be..224ec09aba 100644 --- a/interfaces/v5.Tracer.html +++ b/interfaces/v5.Tracer.html @@ -1,6 +1,6 @@ -Tracer | bullmq - v5.30.1

                Interface Tracer<Context>

                Tracer interface

                -
                interface Tracer<Context> {
                    startSpan(name, options?, context?): Span<any>;
                }

                Type Parameters

                • Context = any

                Methods

                startSpan +Tracer | bullmq - v5.31.0

                Interface Tracer<Context>

                Tracer interface

                +
                interface Tracer<Context> {
                    startSpan(name, options?, context?): Span<any>;
                }

                Type Parameters

                • Context = any

                Methods

                startSpan

                Methods

                startSpan

                • startSpan(name, options?, context?): Span<any>

                • startSpan creates a new Span with the given name and options on an optional context. If the context is not provided, the current active context should be used.

                  -

                  Parameters

                  Returns Span<any>

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Parameters

                Returns Span<any>

                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 4b6278b778..36c1230839 100644 --- a/interfaces/v5.WorkerListener.html +++ b/interfaces/v5.WorkerListener.html @@ -1,4 +1,4 @@ -WorkerListener | bullmq - v5.30.1

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

                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 b4a7a36192..c6cab5fe60 100644 --- a/interfaces/v5.WorkerOptions.html +++ b/interfaces/v5.WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | bullmq - v5.30.1

                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;
                    telemetry?: Telemetry<any>;
                    useWorkerThreads?: boolean;
                    workerForkOptions?: ForkOptions;
                    workerThreadsOptions?: WorkerOptions;
                }

                Hierarchy (view full)

                Properties

                autorun? +WorkerOptions | bullmq - v5.31.0

                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;
                    telemetry?: Telemetry<any>;
                    useWorkerThreads?: boolean;
                    workerForkOptions?: ForkOptions;
                    workerThreadsOptions?: WorkerOptions;
                }

                Hierarchy (view full)

                Properties

                autorun? blockingConnection? concurrency? connection @@ -26,76 +26,76 @@

                Properties

                Optional autorun

                autorun?: boolean

                Condition to start processor at instance creation.

                Default

                true
                -

                Optional blockingConnection

                blockingConnection?: boolean

                Denotes commands should retry indefinitely.

                -

                Deprecated

                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.

                +

                Deprecated

                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 telemetry

                telemetry?: Telemetry<any>

                Telemetry Addon

                -

                Optional useWorkerThreads

                useWorkerThreads?: boolean

                Use Worker Threads instead of Child Processes. +

                Optional telemetry

                telemetry?: Telemetry<any>

                Telemetry Addon

                +

                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
                -

                Optional workerForkOptions

                workerForkOptions?: ForkOptions

                Support passing Worker Fork Options. +

                Optional workerForkOptions

                workerForkOptions?: ForkOptions

                Support passing Worker Fork Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as false (default value).

                See

                https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options

                -

                Optional workerThreadsOptions

                workerThreadsOptions?: WorkerOptions

                Support passing Worker Threads Options. +

                Optional workerThreadsOptions

                workerThreadsOptions?: WorkerOptions

                Support passing Worker Threads Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as true.

                See

                https://nodejs.org/api/worker_threads.html#new-workerfilename-options

                -

                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 7f4d25a0b3..2acba4cfef 100644 --- a/modules/v1.html +++ b/modules/v1.html @@ -1,4 +1,4 @@ -v1 | bullmq - v5.30.1

                Module v1

                Enumerations

                ChildCommand +v1 | bullmq - v5.31.0

                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 43f8057a7b..d7f0ef6c6c 100644 --- a/modules/v2.html +++ b/modules/v2.html @@ -1,4 +1,4 @@ -v2 | bullmq - v5.30.1

                Module v2

                Enumerations

                ChildCommand +v2 | bullmq - v5.31.0

                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 68cf474974..f6caf8d554 100644 --- a/modules/v3.html +++ b/modules/v3.html @@ -1,4 +1,4 @@ -v3 | bullmq - v5.30.1

                Module v3

                Enumerations

                ChildCommand +v3 | bullmq - v5.31.0

                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 3849b6c761..77d7b6482b 100644 --- a/modules/v4.html +++ b/modules/v4.html @@ -1,4 +1,4 @@ -v4 | bullmq - v5.30.1

                Module v4

                Index

                Enumerations

                ChildCommand +v4 | bullmq - v5.31.0

                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 7b560e82c3..53abf42ee8 100644 --- a/modules/v5.html +++ b/modules/v5.html @@ -1,4 +1,4 @@ -v5 | bullmq - v5.30.1

                Module v5

                Index

                Enumerations

                ChildCommand +v5 | bullmq - v5.31.0

                Module v5

                Index

                Enumerations

                ChildCommand ClientType ErrorCode MetricsTime @@ -145,4 +145,4 @@ toString trace 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 0073a479dd..b1258ca4d7 100644 --- a/types/v4.BackoffStrategy.html +++ b/types/v4.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.30.1

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

                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 f9e9109d0a..d7ea1d8265 100644 --- a/types/v4.BulkJobOptions.html +++ b/types/v4.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.30.1

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 534560960d..bd0539a1e6 100644 --- a/types/v4.ClusterOptions.html +++ b/types/v4.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.30.1

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 e5a3b11df3..0d4bb55516 100644 --- a/types/v4.ConnectionOptions.html +++ b/types/v4.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.30.1

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

                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 7d385c6540..81d61d107b 100644 --- a/types/v4.EntryId.html +++ b/types/v4.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.30.1

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 74dff7227e..f712c7be4b 100644 --- a/types/v4.EntryRaw.html +++ b/types/v4.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.30.1

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 a527097e90..2d898b0ae3 100644 --- a/types/v4.FinishedPropValAttribute.html +++ b/types/v4.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.30.1

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 2c05c3bae3..de31d4143c 100644 --- a/types/v4.FinishedStatus.html +++ b/types/v4.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.30.1

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 aa212dbe44..719eb9f0e0 100644 --- a/types/v4.FlowChildJob.html +++ b/types/v4.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.30.1

                Type alias FlowChildJob

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 1c68ce156c..e6b52d71d7 100644 --- a/types/v4.FlowJob.html +++ b/types/v4.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.30.1

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 c6f8735aac..31322ff9b7 100644 --- a/types/v4.FlowQueuesOpts.html +++ b/types/v4.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.30.1

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

                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 1f86c1bbbc..d7ede01fa6 100644 --- a/types/v4.JobData.html +++ b/types/v4.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.30.1

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 e1e5db407a..e6b0b4efe5 100644 --- a/types/v4.JobJsonSandbox.html +++ b/types/v4.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.30.1

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

                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 d3a8e225eb..90fd0437c5 100644 --- a/types/v4.JobState.html +++ b/types/v4.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.30.1

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

                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 abfb61a972..b8ebb96990 100644 --- a/types/v4.JobType.html +++ b/types/v4.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.30.1

                Type alias JobType

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

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

                Type alias JobsOptions

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

                Type declaration

                • Optional failParentOnFailure?: boolean

                  If true, moves parent to failed.

                  +JobsOptions | bullmq - v5.31.0

                  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 055be92d5d..a33dea444f 100644 --- a/types/v4.KeysMap.html +++ b/types/v4.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.30.1

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 80ef540aa9..4f44473743 100644 --- a/types/v4.MinimalQueue.html +++ b/types/v4.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.30.1

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

                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 f803953d28..dbd671d533 100644 --- a/types/v4.ParentOpts.html +++ b/types/v4.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.30.1

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

                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 32aea62039..dcf7e2461e 100644 --- a/types/v4.Processor.html +++ b/types/v4.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.30.1

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

                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 428fd67781..f6082c60bd 100644 --- a/types/v4.RedisClient.html +++ b/types/v4.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.30.1

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 cc3812a1e7..1943e20edc 100644 --- a/types/v4.RedisJobOptions.html +++ b/types/v4.RedisJobOptions.html @@ -1,5 +1,5 @@ -RedisJobOptions | bullmq - v5.30.1

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

                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 37970d1153..14d7773b93 100644 --- a/types/v4.RedisOptions.html +++ b/types/v4.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.30.1

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 92b44245ff..2979a5eee8 100644 --- a/types/v4.RepeatStrategy.html +++ b/types/v4.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.30.1

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

                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 e5676d1b2b..5e57737f81 100644 --- a/types/v4.RepeatableJob.html +++ b/types/v4.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.30.1

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

                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 73a0ce6a33..a1a1268a58 100644 --- a/types/v4.SandboxedJobProcessor.html +++ b/types/v4.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.30.1

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

                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 26b73f1a54..054eeac5dd 100644 --- a/types/v4.StreamName.html +++ b/types/v4.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.30.1

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 2f6cc8bf58..5c2771c71e 100644 --- a/types/v4.StreamReadRaw.html +++ b/types/v4.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.30.1

                Type alias StreamReadRaw

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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.AttributeValue.html b/types/v5.AttributeValue.html index 69d5ba446e..b415517897 100644 --- a/types/v5.AttributeValue.html +++ b/types/v5.AttributeValue.html @@ -1 +1 @@ -AttributeValue | bullmq - v5.30.1

                Type alias AttributeValue

                AttributeValue: string | number | boolean | (null | undefined | string)[] | (null | undefined | number)[] | (null | undefined | boolean)[]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +AttributeValue | bullmq - v5.31.0

                Type alias AttributeValue

                AttributeValue: string | number | boolean | (null | undefined | string)[] | (null | undefined | number)[] | (null | undefined | boolean)[]

                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 ed1ea9d453..e9e831c7dd 100644 --- a/types/v5.BackoffStrategy.html +++ b/types/v5.BackoffStrategy.html @@ -1 +1 @@ -BackoffStrategy | bullmq - v5.30.1

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

                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 218451d9a4..49e0cf22dd 100644 --- a/types/v5.BulkJobOptions.html +++ b/types/v5.BulkJobOptions.html @@ -1 +1 @@ -BulkJobOptions | bullmq - v5.30.1

                Type alias BulkJobOptions

                BulkJobOptions: Omit<JobsOptions, "repeat">

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 17010867dc..9d033f3e35 100644 --- a/types/v5.ClusterOptions.html +++ b/types/v5.ClusterOptions.html @@ -1 +1 @@ -ClusterOptions | bullmq - v5.30.1

                Type alias ClusterOptions

                ClusterOptions: IORedis.ClusterOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 a3473fc35c..3b22f213df 100644 --- a/types/v5.ConnectionOptions.html +++ b/types/v5.ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | bullmq - v5.30.1

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

                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 53d7c92466..6918bbc463 100644 --- a/types/v5.EntryId.html +++ b/types/v5.EntryId.html @@ -1 +1 @@ -EntryId | bullmq - v5.30.1

                Type alias EntryId

                EntryId: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 a949400439..541eb2c3c7 100644 --- a/types/v5.EntryRaw.html +++ b/types/v5.EntryRaw.html @@ -1 +1 @@ -EntryRaw | bullmq - v5.30.1

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                Type alias EntryRaw

                EntryRaw: [EntryId, string[]]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.Exception.html b/types/v5.Exception.html index 93af3784d4..29153eba46 100644 --- a/types/v5.Exception.html +++ b/types/v5.Exception.html @@ -1 +1 @@ -Exception | bullmq - v5.30.1

                Type alias Exception

                Exception: string | ExceptionType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +Exception | bullmq - v5.31.0

                Type alias Exception

                Exception: string | ExceptionType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/v5.ExceptionType.html b/types/v5.ExceptionType.html index 205fabeeb9..2f00deecc2 100644 --- a/types/v5.ExceptionType.html +++ b/types/v5.ExceptionType.html @@ -1 +1 @@ -ExceptionType | bullmq - v5.30.1

                Type alias ExceptionType

                ExceptionType: CodeException | MessageException | NameException

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +ExceptionType | bullmq - v5.31.0

                Type alias ExceptionType

                ExceptionType: CodeException | MessageException | NameException

                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 0dcec2b68a..e1e98f5249 100644 --- a/types/v5.FinishedPropValAttribute.html +++ b/types/v5.FinishedPropValAttribute.html @@ -1 +1 @@ -FinishedPropValAttribute | bullmq - v5.30.1

                Type alias FinishedPropValAttribute

                FinishedPropValAttribute: "returnvalue" | "failedReason"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 2a988db5be..eec5055b61 100644 --- a/types/v5.FinishedStatus.html +++ b/types/v5.FinishedStatus.html @@ -1 +1 @@ -FinishedStatus | bullmq - v5.30.1

                Type alias FinishedStatus

                FinishedStatus: "completed" | "failed"

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 aba7ac0c7a..5b69de3ddc 100644 --- a/types/v5.FlowChildJob.html +++ b/types/v5.FlowChildJob.html @@ -1 +1 @@ -FlowChildJob | bullmq - v5.30.1

                Type alias FlowChildJob

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 30acfe211f..b97098c4d9 100644 --- a/types/v5.FlowJob.html +++ b/types/v5.FlowJob.html @@ -1 +1 @@ -FlowJob | bullmq - v5.30.1

                Type alias FlowJob

                FlowJob: FlowJobBase<JobsOptions>

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 d6d5ad99b3..4e745d9fc7 100644 --- a/types/v5.FlowQueuesOpts.html +++ b/types/v5.FlowQueuesOpts.html @@ -1 +1 @@ -FlowQueuesOpts | bullmq - v5.30.1

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

                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 63c3881a11..7433b3b01d 100644 --- a/types/v5.JobData.html +++ b/types/v5.JobData.html @@ -1 +1 @@ -JobData | bullmq - v5.30.1

                Type alias JobData

                JobData: [JobJsonRaw | number, string?]

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 4dd4e86b8b..267acf7053 100644 --- a/types/v5.JobJsonSandbox.html +++ b/types/v5.JobJsonSandbox.html @@ -1 +1 @@ -JobJsonSandbox | bullmq - v5.30.1

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

                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 b7c3480b54..ca57c827ec 100644 --- a/types/v5.JobState.html +++ b/types/v5.JobState.html @@ -1 +1 @@ -JobState | bullmq - v5.30.1

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

                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 0fd9c0b4d1..24a6e107ec 100644 --- a/types/v5.JobType.html +++ b/types/v5.JobType.html @@ -1 +1 @@ -JobType | bullmq - v5.30.1

                Type alias JobType

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 6f2946c950..6431a6478f 100644 --- a/types/v5.JobsOptions.html +++ b/types/v5.JobsOptions.html @@ -1,7 +1,7 @@ -JobsOptions | bullmq - v5.30.1

                Type alias JobsOptions

                JobsOptions: BaseJobOptions & {
                    debounce?: DebounceOptions;
                    deduplication?: DebounceOptions;
                    failParentOnFailure?: boolean;
                    ignoreDependencyOnFailure?: boolean;
                    removeDependencyOnFailure?: boolean;
                }

                Type declaration

                • Optional debounce?: DebounceOptions

                  Debounce options.

                  +JobsOptions | bullmq - v5.31.0

                  Type alias JobsOptions

                  JobsOptions: BaseJobOptions & {
                      debounce?: DebounceOptions;
                      deduplication?: DebounceOptions;
                      failParentOnFailure?: boolean;
                      ignoreDependencyOnFailure?: boolean;
                      removeDependencyOnFailure?: boolean;
                  }

                  Type declaration

                  • Optional debounce?: DebounceOptions

                    Debounce options.

                    Deprecated

                    use deduplication option

                  • Optional deduplication?: DebounceOptions

                    Deduplication 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 e1e64a9be1..e2aa5e3259 100644 --- a/types/v5.KeysMap.html +++ b/types/v5.KeysMap.html @@ -1 +1 @@ -KeysMap | bullmq - v5.30.1

                Type alias KeysMap

                KeysMap: {
                    [index in string]: string
                }

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 17ff09b12c..0af0e62191 100644 --- a/types/v5.MinimalQueue.html +++ b/types/v5.MinimalQueue.html @@ -1 +1 @@ -MinimalQueue | bullmq - v5.30.1

                Type alias MinimalQueue

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                Type alias MinimalQueue

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

                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 8197d907bc..bfd3a14687 100644 --- a/types/v5.ParentOpts.html +++ b/types/v5.ParentOpts.html @@ -1 +1 @@ -ParentOpts | bullmq - v5.30.1

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

                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 fce6ac4a54..6d4358cfb2 100644 --- a/types/v5.Processor.html +++ b/types/v5.Processor.html @@ -1,2 +1,2 @@ -Processor | bullmq - v5.30.1

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

                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 04a1273cd0..363d8a1770 100644 --- a/types/v5.RedisClient.html +++ b/types/v5.RedisClient.html @@ -1 +1 @@ -RedisClient | bullmq - v5.30.1

                Type alias RedisClient

                RedisClient: Redis | Cluster

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 b35820b228..02ee8cf83d 100644 --- a/types/v5.RedisJobOptions.html +++ b/types/v5.RedisJobOptions.html @@ -1,8 +1,8 @@ -RedisJobOptions | bullmq - v5.30.1

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    deid?: string;
                    fpof?: boolean;
                    idof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                    tm?: string;
                }

                These fields are the ones stored in Redis with smaller keys for compactness.

                +RedisJobOptions | bullmq - v5.31.0

                Type alias RedisJobOptions

                RedisJobOptions: BaseJobOptions & {
                    deid?: string;
                    fpof?: boolean;
                    idof?: boolean;
                    kl?: number;
                    rdof?: boolean;
                    tm?: string;
                }

                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.

                • Optional tm?: string

                  TelemetryMetadata, provide for context propagation.

                  -

                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 909b1d7fca..2b0b9903eb 100644 --- a/types/v5.RedisOptions.html +++ b/types/v5.RedisOptions.html @@ -1 +1 @@ -RedisOptions | bullmq - v5.30.1

                Type alias RedisOptions

                RedisOptions: IORedis.RedisOptions & BaseOptions

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 869bfdf2db..52c7391f87 100644 --- a/types/v5.RepeatStrategy.html +++ b/types/v5.RepeatStrategy.html @@ -1 +1 @@ -RepeatStrategy | bullmq - v5.30.1

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

                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 d2ecb3da41..dbb89150ff 100644 --- a/types/v5.RepeatableJob.html +++ b/types/v5.RepeatableJob.html @@ -1 +1 @@ -RepeatableJob | bullmq - v5.30.1

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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
                • Optional 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 52991fa119..4a7aef66aa 100644 --- a/types/v5.RepeatableOptions.html +++ b/types/v5.RepeatableOptions.html @@ -1 +1 @@ -RepeatableOptions | bullmq - v5.30.1

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

                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 6d37c775f8..e775280f5d 100644 --- a/types/v5.SandboxedJobProcessor.html +++ b/types/v5.SandboxedJobProcessor.html @@ -1,2 +1,2 @@ -SandboxedJobProcessor | bullmq - v5.30.1

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

                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 f71d4da752..a5135c2704 100644 --- a/types/v5.StreamName.html +++ b/types/v5.StreamName.html @@ -1 +1 @@ -StreamName | bullmq - v5.30.1

                Type alias StreamName

                StreamName: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 d76f697056..d2c364337c 100644 --- a/types/v5.StreamReadRaw.html +++ b/types/v5.StreamReadRaw.html @@ -1 +1 @@ -StreamReadRaw | bullmq - v5.30.1

                Type alias StreamReadRaw

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

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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.Time.html b/types/v5.Time.html index 343d2bb278..7921e77c5c 100644 --- a/types/v5.Time.html +++ b/types/v5.Time.html @@ -1 +1 @@ -Time | bullmq - v5.30.1

                Type alias Time

                Time: HighResolutionTime | number | Date

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +Time | bullmq - v5.31.0

                Type alias Time

                Time: HighResolutionTime | number | Date

                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 47eea0f79f..f153b4ec5f 100644 --- a/variables/v1.DELAY_TIME_1.html +++ b/variables/v1.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.30.1

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

                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 6e47725887..1b8444cbde 100644 --- a/variables/v1.DELAY_TIME_5.html +++ b/variables/v1.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.30.1

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

                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 42d114d94f..0dcfe492d0 100644 --- a/variables/v1.QUEUE_EVENT_SUFFIX.html +++ b/variables/v1.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.30.1

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

                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 092001fb0b..c8ada41df0 100644 --- a/variables/v1.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v1.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.30.1

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

                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 5f325129ef..25612ff2d2 100644 --- a/variables/v1.WORKER_SUFFIX.html +++ b/variables/v1.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.30.1

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.31.0

                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 f42ab9de25..8d1a5f2d35 100644 --- a/variables/v1.clientCommandMessageReg.html +++ b/variables/v1.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.30.1

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 7f8b7d0665..3a71c551c9 100644 --- a/variables/v1.errorObject.html +++ b/variables/v1.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.30.1

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

                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 643fc7a72c..cb6a9bc9b8 100644 --- a/variables/v1.scriptLoader-1.html +++ b/variables/v1.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.30.1

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.31.0

                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 4d525d1b53..b2598f1036 100644 --- a/variables/v2.DELAY_TIME_1.html +++ b/variables/v2.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.30.1

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

                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 a2978a14c0..e5c31a3c09 100644 --- a/variables/v2.DELAY_TIME_5.html +++ b/variables/v2.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.30.1

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

                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 11cdbf7f1f..27bf7c9f71 100644 --- a/variables/v2.QUEUE_EVENT_SUFFIX.html +++ b/variables/v2.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.30.1

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

                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 6ea197e06f..096f472f8c 100644 --- a/variables/v2.QUEUE_SCHEDULER_SUFFIX.html +++ b/variables/v2.QUEUE_SCHEDULER_SUFFIX.html @@ -1 +1 @@ -QUEUE_SCHEDULER_SUFFIX | bullmq - v5.30.1

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

                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 f19dbabca4..7a38d08d3c 100644 --- a/variables/v2.WORKER_SUFFIX.html +++ b/variables/v2.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.30.1

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.31.0

                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 18980222c2..82e5cb030e 100644 --- a/variables/v2.clientCommandMessageReg.html +++ b/variables/v2.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.30.1

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 ac2ee8b6ec..aac1b80a1f 100644 --- a/variables/v2.errorObject.html +++ b/variables/v2.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.30.1

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

                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 073d24d735..01d501a31e 100644 --- a/variables/v2.scriptLoader-1.html +++ b/variables/v2.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.30.1

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.31.0

                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 d4179a498a..d21a294a11 100644 --- a/variables/v3.DELAY_TIME_1.html +++ b/variables/v3.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.30.1

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

                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 8361c7d62d..5bcac59151 100644 --- a/variables/v3.DELAY_TIME_5.html +++ b/variables/v3.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.30.1

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

                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 dfa0e37dd5..14643489bb 100644 --- a/variables/v3.QUEUE_EVENT_SUFFIX.html +++ b/variables/v3.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.30.1

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

                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 8f73a98aa4..dda51fe42d 100644 --- a/variables/v3.WORKER_SUFFIX.html +++ b/variables/v3.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.30.1

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.31.0

                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 35337e5685..84e4244664 100644 --- a/variables/v3.clientCommandMessageReg.html +++ b/variables/v3.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.30.1

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 6ece1cec4a..7e48454ed5 100644 --- a/variables/v3.errorObject.html +++ b/variables/v3.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.30.1

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

                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 aec35459d6..ef092108d2 100644 --- a/variables/v3.scriptLoader-1.html +++ b/variables/v3.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.30.1

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.31.0

                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 adf49af654..0463b1722c 100644 --- a/variables/v4.DELAY_TIME_1.html +++ b/variables/v4.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.30.1

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

                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 54f0dfd542..6319b2b96a 100644 --- a/variables/v4.DELAY_TIME_5.html +++ b/variables/v4.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.30.1

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

                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 eea9626909..60257df66a 100644 --- a/variables/v4.PRIORITY_LIMIT.html +++ b/variables/v4.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.30.1

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 8a404ae80b..2a7d678f6c 100644 --- a/variables/v4.QUEUE_EVENT_SUFFIX.html +++ b/variables/v4.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.30.1

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

                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 2ebe603e77..6ae1b3201b 100644 --- a/variables/v4.RATE_LIMIT_ERROR.html +++ b/variables/v4.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.30.1

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

                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 d2188ab4eb..72bf725896 100644 --- a/variables/v4.WORKER_SUFFIX.html +++ b/variables/v4.WORKER_SUFFIX.html @@ -1 +1 @@ -WORKER_SUFFIX | bullmq - v5.30.1

                Variable WORKER_SUFFIXConst

                WORKER_SUFFIX: "" = ''

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WORKER_SUFFIX | bullmq - v5.31.0

                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 110ff91bf7..10e53cceae 100644 --- a/variables/v4.clientCommandMessageReg.html +++ b/variables/v4.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.30.1

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 2e586074d0..4baac8ebc0 100644 --- a/variables/v4.errorObject.html +++ b/variables/v4.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.30.1

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

                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 24a5d2a32d..715c7c637d 100644 --- a/variables/v4.scriptLoader-1.html +++ b/variables/v4.scriptLoader-1.html @@ -1 +1 @@ -scriptLoader | bullmq - v5.30.1

                Variable scriptLoaderConst

                scriptLoader: ScriptLoader = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +scriptLoader | bullmq - v5.31.0

                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 5af578b851..2695feb322 100644 --- a/variables/v5.DELAY_TIME_1.html +++ b/variables/v5.DELAY_TIME_1.html @@ -1 +1 @@ -DELAY_TIME_1 | bullmq - v5.30.1

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

                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 d3a543d5ec..8d2bdf8f06 100644 --- a/variables/v5.DELAY_TIME_5.html +++ b/variables/v5.DELAY_TIME_5.html @@ -1 +1 @@ -DELAY_TIME_5 | bullmq - v5.30.1

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

                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 e131068f4b..e2c242963d 100644 --- a/variables/v5.PRIORITY_LIMIT.html +++ b/variables/v5.PRIORITY_LIMIT.html @@ -1 +1 @@ -PRIORITY_LIMIT | bullmq - v5.30.1

                Variable PRIORITY_LIMITConst

                PRIORITY_LIMIT: number = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 443dec94ee..f147433fba 100644 --- a/variables/v5.QUEUE_EVENT_SUFFIX.html +++ b/variables/v5.QUEUE_EVENT_SUFFIX.html @@ -1 +1 @@ -QUEUE_EVENT_SUFFIX | bullmq - v5.30.1

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

                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 a0ef90bd39..264876c08f 100644 --- a/variables/v5.RATE_LIMIT_ERROR.html +++ b/variables/v5.RATE_LIMIT_ERROR.html @@ -1 +1 @@ -RATE_LIMIT_ERROR | bullmq - v5.30.1

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

                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 af803fca34..2fc765d0b5 100644 --- a/variables/v5.clientCommandMessageReg.html +++ b/variables/v5.clientCommandMessageReg.html @@ -1 +1 @@ -clientCommandMessageReg | bullmq - v5.30.1

                Variable clientCommandMessageRegConst

                clientCommandMessageReg: RegExp = ...

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                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 10b6d5dc2e..89900ac759 100644 --- a/variables/v5.errorObject.html +++ b/variables/v5.errorObject.html @@ -1 +1 @@ -errorObject | bullmq - v5.30.1

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

                Variable errorObjectConst

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

                Type declaration

                • [index: string]: any

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file