bullmq 3.6.0 → 3.6.2

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

@@ -1,20 +0,0 @@
-import { JobsOptions } from '../types';
-import { QueueOptions } from './queue-options';
-interface FlowJobBase<T> {
-    name: string;
-    queueName: string;
-    data?: any;
-    prefix?: string;
-    opts?: Omit<T, 'repeat'>;
-    children?: FlowChildJob[];
-}
-export type FlowChildJob = FlowJobBase<Omit<JobsOptions, 'parent'>>;
-export type FlowJob = FlowJobBase<JobsOptions>;
-export type FlowQueuesOpts = Record<string, Omit<QueueOptions, 'connection' | 'prefix'>>;
-export interface FlowOpts {
-    /**
-     * Map of options for Queue classes.
-     */
-    queuesOptions: FlowQueuesOpts;
-}
-export {};

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

@@ -1,24 +0,0 @@
-export * from './advanced-options';
-export * from './backoff-options';
-export * from './base-job-options';
-export * from './child-command';
-export * from './child-message';
-export * from './connection';
-export * from './flow-job';
-export * from './ioredis-events';
-export * from './job-json';
-export * from './keep-jobs';
-export * from './metrics-options';
-export * from './metrics';
-export * from './minimal-job';
-export * from './parent-command';
-export * from './parent-message';
-export * from './parent';
-export * from './queue-options';
-export * from './rate-limiter-options';
-export * from './redis-options';
-export * from './redis-streams';
-export * from './repeat-options';
-export * from './sandboxed-job-processor';
-export * from './sandboxed-job';
-export * from './worker-options';

package/dist/esm/interfaces/ioredis-events.d.ts

@@ -1,8 +0,0 @@
-export interface IoredisListener {
-    /**
-     * Listen to 'ioredis:close' event.
-     *
-     * This event is triggered when ioredis is closed.
-     */
-    'ioredis:close': () => void;
-}

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

@@ -1,37 +0,0 @@
-import { RedisJobOptions } from '../types';
-import { ParentKeys } from './parent';
-export interface JobJson {
-    id: string;
-    name: string;
-    data: string;
-    opts: RedisJobOptions;
-    progress: number | object;
-    attemptsMade: number;
-    finishedOn?: number;
-    processedOn?: number;
-    timestamp: number;
-    failedReason: string;
-    stacktrace: string;
-    returnvalue: string;
-    parent?: ParentKeys;
-    parentKey?: string;
-    repeatJobKey?: string;
-}
-export interface JobJsonRaw {
-    id: string;
-    name: string;
-    data: string;
-    delay: string;
-    opts: string;
-    progress: string;
-    attemptsMade: string;
-    finishedOn?: string;
-    processedOn?: string;
-    timestamp: string;
-    failedReason: string;
-    stacktrace: string[];
-    returnvalue: string;
-    parentKey?: string;
-    parent?: string;
-    rjk?: string;
-}

package/dist/esm/interfaces/keep-jobs.d.ts

@@ -1,17 +0,0 @@
-/**
- * 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.
- */
-export interface KeepJobs {
-    /**
-     * Maximum age in seconds for job to be kept.
-     */
-    age?: number;
-    /**
-     * Maximum count of jobs to be kept.
-     */
-    count?: number;
-}

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

@@ -1,12 +0,0 @@
-/**
- *
- *
- */
-export interface MetricsOptions {
-    /**
-     * Enable gathering metrics for finished jobs.
-     * Output refers to all finished jobs, completed or
-     * failed.
-     */
-    maxDataPoints?: number;
-}

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

@@ -1,9 +0,0 @@
-export interface Metrics {
-    meta: {
-        count: number;
-        prevTS: number;
-        prevCount: number;
-    };
-    data: number[];
-    count: number;
-}

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

@@ -1,129 +0,0 @@
-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.
-     */
-    update(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/parent-command.d.ts

@@ -1,10 +0,0 @@
-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-message.d.ts

@@ -1,8 +0,0 @@
-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.d.ts

@@ -1,20 +0,0 @@
-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/queue-options.d.ts

@@ -1,74 +0,0 @@
-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/rate-limiter-options.d.ts

@@ -1,12 +0,0 @@
-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/redis-options.d.ts

@@ -1,8 +0,0 @@
-import type * as IORedis from 'ioredis';
-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;
-export {};

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

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

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

@@ -1,33 +0,0 @@
-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/sandboxed-job-processor.d.ts

@@ -1,5 +0,0 @@
-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.d.ts

@@ -1,13 +0,0 @@
-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;
-    update: (data: any) => Promise<void>;
-    returnValue: R;
-}

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

@@ -1,51 +0,0 @@
-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';
-/**
- * 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.
-     */
-    autorun?: boolean;
-    /**
-     * Amount of jobs that a single worker is allowed to work on
-     * in parallel.
-     *
-     * @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`.
-     */
-    maxStalledCount?: number;
-    /**
-     * Number of milliseconds between stallness checks.
-     */
-    stalledInterval?: number;
-    skipDelayCheck?: boolean;
-    drainDelay?: number;
-    lockDuration?: number;
-    lockRenewTime?: number;
-    runRetryDelay?: number;
-    settings?: AdvancedOptions;
-}
-export interface GetNextJobOptions {
-    block?: boolean;
-}

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

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

package/dist/esm/scripts/changeDelay-3.d.ts

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

package/dist/esm/scripts/cleanJobsInSet-2.d.ts

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

package/dist/esm/scripts/drain-4.d.ts

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

package/dist/esm/scripts/extendLock-2.d.ts

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

package/dist/esm/scripts/getCounts-1.d.ts

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

package/dist/esm/scripts/getRanges-1.d.ts

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

package/dist/esm/scripts/getState-7.d.ts

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

package/dist/esm/scripts/getStateV2-7.d.ts

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

package/dist/esm/scripts/index.d.ts

@@ -1,29 +0,0 @@
-export * from './addJob-8';
-export * from './changeDelay-3';
-export * from './cleanJobsInSet-2';
-export * from './drain-4';
-export * from './extendLock-2';
-export * from './getCounts-1';
-export * from './getRanges-1';
-export * from './getState-7';
-export * from './getStateV2-7';
-export * from './isFinished-3';
-export * from './isJobInList-1';
-export * from './moveJobFromActiveToWait-4';
-export * from './moveStalledJobsToWait-8';
-export * from './moveToActive-9';
-export * from './moveToDelayed-8';
-export * from './moveToFinished-12';
-export * from './moveToWaitingChildren-4';
-export * from './obliterate-2';
-export * from './pause-4';
-export * from './promote-6';
-export * from './releaseLock-1';
-export * from './removeJob-1';
-export * from './removeRepeatable-2';
-export * from './reprocessJob-4';
-export * from './retryJob-8';
-export * from './retryJobs-6';
-export * from './takeLock-1';
-export * from './updateData-1';
-export * from './updateProgress-2';

package/dist/esm/scripts/isFinished-3.d.ts

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

package/dist/esm/scripts/isJobInList-1.d.ts

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

package/dist/esm/scripts/moveJobFromActiveToWait-4.d.ts

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

package/dist/esm/scripts/moveStalledJobsToWait-8.d.ts

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

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

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

package/dist/esm/scripts/moveToDelayed-8.d.ts

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

package/dist/esm/scripts/moveToFinished-12.d.ts

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

package/dist/esm/scripts/moveToWaitingChildren-4.d.ts

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

package/dist/esm/scripts/obliterate-2.d.ts

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