mongodb-queue.d.ts

import { Db, MongoError } from 'mongodb';

declare function mongodbQueue(db: Db, name: string, opts?: mongodbQueue.QueueOptions): mongodbQueue.Queue;

declare namespace mongodbQueue {
  class Queue {
    constructor(db: Db, name: string, opts?: QueueOptions);

    createIndexes(callback: QueueCallback<string>): void;
    add(payload: Payload, callback: QueueCallback<string>): void;
    add(payload: ArrayPayload, callback: QueueCallback<string[]>): void;
    add(payload: Payload, opts: QueueOptions, callback: QueueCallback<string>): void;
    add(payload: ArrayPayload, opts: QueueOptions, callback: QueueCallback<string[]>): void;
    get(callback: QueueCallback<QueueMessage | undefined>): void;
    get(opts: QueueOptions, callback: QueueCallback<QueueMessage | undefined>): void;
    ping(ack: string, callback: QueueCallback<string>): void;
    ping(ack: string, opts: QueueOptions, callback: QueueCallback<string>): void;
    ack(ack: string, callback: QueueCallback<string>): void;
    clean(callback: QueueCallback<any>): void;
    total(callback: QueueCallback<number>): void;
    size(callback: QueueCallback<number>): void;
    listWaiting(callback: QueueCallback<QueueMessage[]>): void;
    inFlight(callback: QueueCallback<number>): void;
    listInFlight(callback: QueueCallback<QueueMessage[]>): void;
    incomplete(callback: QueueCallback<number>): void;
    listIncomplete(callback: QueueCallback<QueueMessage[]>): void;
    done(callback: QueueCallback<number>): void;
  }

  type Payload = string | Record<string, unknown>;
  type ArrayPayload = Array<string | Record<string, unknown>>;

  interface QueueOptions {
    deadQueue?: Queue | undefined;
    delay?: number | undefined;
    maxRetries?: number | undefined;
    visibility?: number | undefined;
  }

  interface QueueMessage {
    ack: string;
    id: string;
    payload: Payload | ArrayPayload;
    tries: number;
  }

  interface QueueCallback<T> {
    (err: MongoError | Error, result: T): void;
  }
}

export = mongodbQueue;