bullmq 4.0.0-beta.2 → 4.0.0

package/dist/esm/interfaces/minimal-job.d.ts

@@ -0,0 +1,129 @@
+import { JobsOptions, JobJsonSandbox } from '../types';
+import { JobJson } from './job-json';
+import { ParentKeys } from './parent';
+export type BulkJobOptions = Omit<JobsOptions, 'repeat'>;
+export interface MoveToWaitingChildrenOpts {
+    child?: {
+        id: string;
+        queue: string;
+    };
+}
+export interface DependenciesOpts {
+    processed?: {
+        cursor?: number;
+        count?: number;
+    };
+    unprocessed?: {
+        cursor?: number;
+        count?: number;
+    };
+}
+/**
+ * MinimalJob
+ */
+export interface MinimalJob<DataType = any, ReturnType = any, NameType extends string = string> {
+    /**
+     * The name of the Job
+     */
+    name: NameType;
+    /**
+     * The payload for this job.
+     */
+    data: DataType;
+    /**
+     * The options object for this job.
+     */
+    opts: JobsOptions;
+    id?: string;
+    /**
+     * The progress a job has performed so far.
+     * @defaultValue 0
+     */
+    progress: number | object;
+    /**
+     * The value returned by the processor when processing this job.
+     * @defaultValue null
+     */
+    returnvalue: ReturnType;
+    /**
+     * Stacktrace for the error (for failed jobs).
+     * @defaultValue null
+     */
+    stacktrace: string[];
+    /**
+     * An amount of milliseconds to wait until this job can be processed.
+     * @defaultValue 0
+     */
+    delay: number;
+    /**
+     * Timestamp when the job was created (unless overridden with job options).
+     */
+    timestamp: number;
+    /**
+     * Number of attempts after the job has failed.
+     * @defaultValue 0
+     */
+    attemptsMade: number;
+    /**
+     * Reason for failing.
+     */
+    failedReason: string;
+    /**
+     * Timestamp for when the job finished (completed or failed).
+     */
+    finishedOn?: number;
+    /**
+     * Timestamp for when the job was processed.
+     */
+    processedOn?: number;
+    /**
+     * Fully qualified key (including the queue prefix) pointing to the parent of this job.
+     */
+    parentKey?: string;
+    /**
+     * Object that contains parentId (id) and parent queueKey.
+     */
+    parent?: ParentKeys;
+    /**
+     * Base repeat job key.
+     */
+    repeatJobKey?: string;
+    /**
+     * Prepares a job to be serialized for storage in Redis.
+     * @returns
+     */
+    asJSON(): JobJson;
+    /**
+     * Prepares a job to be passed to Sandbox.
+     * @returns
+     */
+    asJSONSandbox(): JobJsonSandbox;
+    /**
+     * Updates a job's data
+     *
+     * @param data - the data that will replace the current jobs data.
+     */
+    updateData(data: DataType): Promise<void>;
+    /**
+     * Updates a job's progress
+     *
+     * @param progress - number or object to be saved as progress.
+     */
+    updateProgress(progress: number | object): Promise<void>;
+    /**
+     * Logs one row of log data.
+     *
+     * @param logRow - string with log data to be logged.
+     */
+    log(logRow: string): Promise<number>;
+    get queueName(): string;
+    /**
+     * @returns the prefix that is used.
+     */
+    get prefix(): string;
+    /**
+     * @returns it includes the prefix, the namespace separator :, and queue name.
+     * @see https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+     */
+    get queueQualifiedName(): string;
+}

package/dist/esm/interfaces/minimal-job.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=minimal-job.js.map

package/dist/esm/interfaces/minimal-job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimal-job.js","sourceRoot":"","sources":["../../../src/interfaces/minimal-job.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/parent-command.d.ts

@@ -0,0 +1,10 @@
+export declare enum ParentCommand {
+    Completed = 0,
+    Error = 1,
+    Failed = 2,
+    InitFailed = 3,
+    InitCompleted = 4,
+    Log = 5,
+    Progress = 6,
+    Update = 7
+}

package/dist/esm/interfaces/parent-command.js

@@ -0,0 +1,12 @@
+export var ParentCommand;
+(function (ParentCommand) {
+    ParentCommand[ParentCommand["Completed"] = 0] = "Completed";
+    ParentCommand[ParentCommand["Error"] = 1] = "Error";
+    ParentCommand[ParentCommand["Failed"] = 2] = "Failed";
+    ParentCommand[ParentCommand["InitFailed"] = 3] = "InitFailed";
+    ParentCommand[ParentCommand["InitCompleted"] = 4] = "InitCompleted";
+    ParentCommand[ParentCommand["Log"] = 5] = "Log";
+    ParentCommand[ParentCommand["Progress"] = 6] = "Progress";
+    ParentCommand[ParentCommand["Update"] = 7] = "Update";
+})(ParentCommand || (ParentCommand = {}));
+//# sourceMappingURL=parent-command.js.map

package/dist/esm/interfaces/parent-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parent-command.js","sourceRoot":"","sources":["../../../src/interfaces/parent-command.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACvB,2DAAS,CAAA;IACT,mDAAK,CAAA;IACL,qDAAM,CAAA;IACN,6DAAU,CAAA;IACV,mEAAa,CAAA;IACb,+CAAG,CAAA;IACH,yDAAQ,CAAA;IACR,qDAAM,CAAA;AACR,CAAC,EATW,aAAa,KAAb,aAAa,QASxB"}

package/dist/esm/interfaces/parent-message.d.ts

@@ -0,0 +1,8 @@
+import { ChildCommand } from './child-command';
+import { JobJson } from './job-json';
+export interface ParentMessage {
+    cmd: ChildCommand;
+    value?: any;
+    err?: Error;
+    job?: JobJson;
+}

package/dist/esm/interfaces/parent-message.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parent-message.js.map

package/dist/esm/interfaces/parent-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parent-message.js","sourceRoot":"","sources":["../../../src/interfaces/parent-message.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/parent.d.ts

@@ -0,0 +1,20 @@
+import { JobsOptions } from '../types';
+/**
+ * Describes the parent for a Job.
+ */
+export interface Parent<T> {
+    name: string;
+    prefix?: string;
+    queue?: string;
+    data?: T;
+    opts?: JobsOptions;
+}
+export interface ParentKeys {
+    id: string;
+    queueKey: string;
+}
+export type ParentOpts = {
+    waitChildrenKey?: string;
+    parentDependenciesKey?: string;
+    parentKey?: string;
+};

package/dist/esm/interfaces/parent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parent.js.map

package/dist/esm/interfaces/parent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parent.js","sourceRoot":"","sources":["../../../src/interfaces/parent.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/queue-options.d.ts

@@ -0,0 +1,74 @@
+import { AdvancedRepeatOptions } from './advanced-options';
+import { DefaultJobOptions } from './base-job-options';
+import { ConnectionOptions } from './redis-options';
+export declare enum ClientType {
+    blocking = "blocking",
+    normal = "normal"
+}
+/**
+ * Base Queue options
+ */
+export interface QueueBaseOptions {
+    /**
+     * Options for connecting to a Redis instance.
+     */
+    connection?: ConnectionOptions;
+    /**
+     * Specify if the connection is shared.
+     */
+    sharedConnection?: boolean;
+    /**
+     * Denotes commands should retry indefinitely.
+     */
+    blockingConnection?: boolean;
+    /**
+     * Prefix for all queue keys.
+     */
+    prefix?: string;
+}
+/**
+ * Options for the Queue class.
+ */
+export interface QueueOptions extends QueueBaseOptions {
+    defaultJobOptions?: DefaultJobOptions;
+    /**
+     * Options for the streams used internally in BullMQ.
+     */
+    streams?: {
+        /**
+         * Options for the events stream.
+         */
+        events: {
+            /**
+             * Max approximated length for streams. Default is 10 000 events.
+             */
+            maxLen: number;
+        };
+    };
+    settings?: AdvancedRepeatOptions;
+}
+/**
+ * Options for the Repeat class.
+ */
+export interface RepeatBaseOptions extends QueueBaseOptions {
+    settings?: AdvancedRepeatOptions;
+}
+/**
+ * Options for QueueEvents
+ */
+export interface QueueEventsOptions extends QueueBaseOptions {
+    /**
+     * Condition to start listening to events at instance creation.
+     */
+    autorun?: boolean;
+    /**
+     * Last event Id. If provided it is possible to continue
+     * consuming events from a known Id instead of from the last
+     * produced event.
+     */
+    lastEventId?: string;
+    /**
+     * Timeout for the blocking XREAD call to the events stream.
+     */
+    blockingTimeout?: number;
+}

package/dist/esm/interfaces/queue-options.js

@@ -0,0 +1,6 @@
+export var ClientType;
+(function (ClientType) {
+    ClientType["blocking"] = "blocking";
+    ClientType["normal"] = "normal";
+})(ClientType || (ClientType = {}));
+//# sourceMappingURL=queue-options.js.map

package/dist/esm/interfaces/queue-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue-options.js","sourceRoot":"","sources":["../../../src/interfaces/queue-options.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB"}

package/dist/esm/interfaces/rate-limiter-options.d.ts

@@ -0,0 +1,12 @@
+export interface RateLimiterOptions {
+    /**
+     * Max number of jobs to process in the time period
+     * specified in `duration`.
+     */
+    max: number;
+    /**
+     * Time in milliseconds. During this time, a maximum
+     * of `max` jobs will be processed.
+     */
+    duration: number;
+}

package/dist/esm/interfaces/rate-limiter-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rate-limiter-options.js.map

package/dist/esm/interfaces/rate-limiter-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-options.js","sourceRoot":"","sources":["../../../src/interfaces/rate-limiter-options.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/redis-options.d.ts

@@ -0,0 +1,7 @@
+import type * as IORedis from 'ioredis';
+export interface BaseOptions {
+    skipVersionCheck?: boolean;
+}
+export type RedisOptions = IORedis.RedisOptions & BaseOptions;
+export type ClusterOptions = IORedis.ClusterOptions & BaseOptions;
+export type ConnectionOptions = RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster;

package/dist/esm/interfaces/redis-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=redis-options.js.map

package/dist/esm/interfaces/redis-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-options.js","sourceRoot":"","sources":["../../../src/interfaces/redis-options.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/redis-streams.d.ts

@@ -0,0 +1,4 @@
+export type StreamName = string;
+export type EntryId = string;
+export type EntryRaw = [EntryId, string[]];
+export type StreamReadRaw = [StreamName, EntryRaw[]][] | null | undefined;

package/dist/esm/interfaces/redis-streams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=redis-streams.js.map

package/dist/esm/interfaces/redis-streams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-streams.js","sourceRoot":"","sources":["../../../src/interfaces/redis-streams.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/repeat-options.d.ts

@@ -0,0 +1,33 @@
+import { ParserOptions } from 'cron-parser';
+/**
+ * Settings for repeatable jobs
+ *
+ * @see {@link https://docs.bullmq.io/guide/jobs/repeatable}
+ */
+export interface RepeatOptions extends Omit<ParserOptions, 'iterator'> {
+    /**
+     * A repeat pattern
+     */
+    pattern?: string;
+    /**
+     * Number of times the job should repeat at max.
+     */
+    limit?: number;
+    /**
+     * Repeat after this amount of milliseconds
+     * (`pattern` setting cannot be used together with this setting.)
+     */
+    every?: number;
+    /**
+     * Repeated job should start right now
+     * ( work only with every settings)
+     */
+    immediately?: boolean;
+    /**
+     * The start value for the repeat iteration count.
+     */
+    count?: number;
+    prevMillis?: number;
+    offset?: number;
+    jobId?: string;
+}

package/dist/esm/interfaces/repeat-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=repeat-options.js.map

package/dist/esm/interfaces/repeat-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repeat-options.js","sourceRoot":"","sources":["../../../src/interfaces/repeat-options.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/sandboxed-job-processor.d.ts

@@ -0,0 +1,5 @@
+import { SandboxedJob } from './sandboxed-job';
+/**
+ * @see {@link https://docs.bullmq.io/guide/workers/sandboxed-processors}
+ */
+export type SandboxedJobProcessor<T = any, R = any> = ((job: SandboxedJob<T, R>) => R | PromiseLike<R>) | ((job: SandboxedJob<T, R>, callback: (error: unknown, result: R) => void) => void);

package/dist/esm/interfaces/sandboxed-job-processor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sandboxed-job-processor.js.map

package/dist/esm/interfaces/sandboxed-job-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandboxed-job-processor.js","sourceRoot":"","sources":["../../../src/interfaces/sandboxed-job-processor.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/sandboxed-job.d.ts

@@ -0,0 +1,13 @@
+import { JobsOptions } from '../types';
+import { JobJson } from './job-json';
+/**
+ * @see {@link https://docs.bullmq.io/guide/workers/sandboxed-processors}
+ */
+export interface SandboxedJob<T = any, R = any> extends Omit<JobJson, 'data' | 'opts' | 'progress' | 'returnValue'> {
+    data: T;
+    opts: JobsOptions;
+    updateProgress: (value: object | number) => Promise<void>;
+    log: (row: any) => void;
+    updateData: (data: any) => Promise<void>;
+    returnValue: R;
+}

package/dist/esm/interfaces/sandboxed-job.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sandboxed-job.js.map

package/dist/esm/interfaces/sandboxed-job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandboxed-job.js","sourceRoot":"","sources":["../../../src/interfaces/sandboxed-job.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/worker-options.d.ts

@@ -0,0 +1,123 @@
+import { Job } from '../classes/job';
+import { AdvancedOptions } from './advanced-options';
+import { QueueBaseOptions } from './queue-options';
+import { RateLimiterOptions } from './rate-limiter-options';
+import { MetricsOptions } from './metrics-options';
+import { KeepJobs } from './keep-jobs';
+/**
+ * An async function that receives `Job`s and handles them.
+ */
+export type Processor<T = any, R = any, N extends string = string> = (job: Job<T, R, N>, token?: string) => Promise<R>;
+export interface WorkerOptions extends QueueBaseOptions {
+    /**
+     * Condition to start processor at instance creation.
+     *
+     * @default true
+     */
+    autorun?: boolean;
+    /**
+     * Amount of jobs that a single worker is allowed to work on
+     * in parallel.
+     *
+     * @default 1
+     * @see {@link https://docs.bullmq.io/guide/workers/concurrency}
+     */
+    concurrency?: number;
+    /**
+     * Enable rate limiter
+     * @see {@link https://docs.bullmq.io/guide/rate-limiting}
+     */
+    limiter?: RateLimiterOptions;
+    /**
+     * Enable collect metrics.
+     * @see {@link https://docs.bullmq.io/guide/metrics}
+     */
+    metrics?: MetricsOptions;
+    /**
+     * 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
+     */
+    maxStalledCount?: number;
+    /**
+     * Number of milliseconds between stallness checks.
+     *
+     * @default 30000
+     */
+    stalledInterval?: number;
+    /**
+     * You can provide an object specifying max
+     * age and/or count to keep.
+     * Default behavior is to keep the job in the completed set.
+     */
+    removeOnComplete?: 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.
+     */
+    removeOnFail?: KeepJobs;
+    /**
+     *  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
+     */
+    skipStalledCheck?: 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
+     */
+    skipLockRenewal?: boolean;
+    /**
+     *
+     * Number of seconds to long poll for jobs when the queue is empty.
+     *
+     * @default 5
+     */
+    drainDelay?: 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
+     */
+    lockDuration?: 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.
+     */
+    lockRenewTime?: number;
+    /**
+     * This is an internal option that should not be modified.
+     *
+     * @default 15000
+     */
+    runRetryDelay?: number;
+    /**
+     * More advanced options.
+     */
+    settings?: AdvancedOptions;
+    /**
+     * Use Worker Threads instead of Child Processes.
+     * Note: This option can only be used when specifying
+     * a file for the processor argument.
+     *
+     * @default false
+     */
+    useWorkerThreads?: boolean;
+}
+export interface GetNextJobOptions {
+    block?: boolean;
+}

package/dist/esm/interfaces/worker-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker-options.js.map

package/dist/esm/interfaces/worker-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-options.js","sourceRoot":"","sources":["../../../src/interfaces/worker-options.ts"],"names":[],"mappings":""}

package/dist/esm/scripts/addJob-9.d.ts

@@ -0,0 +1,5 @@
+export declare const addJob: {
+    name: string;
+    content: string;
+    keys: number;
+};