Interface IMongoQueueStorageOptions

Options for a (new) MongoQueueStorage instance.

interface IMongoQueueStorageOptions {
    getDb: (() => Db | PromiseLike<Db>);
    getLogger?: Nilable<(() => ILogger)>;
    getSystemName?: Nilable<(() => any)>;
    setImmediate?: Nilable<SetImmediateFunc>;
    setTimeout?: Nilable<SetTimeoutFunc>;
    taskCollectionName?: Nilable<string>;
    waitBeforeRetry?: Nilable<number>;
}

Properties

getDb getLogger? getSystemName? setImmediate? setTimeout? taskCollectionName? waitBeforeRetry?

Properties

getDb

getDb: (() => Db | PromiseLike<Db>)

Type declaration

    • (): Db | PromiseLike<Db>

    • A function, returning the Mongo database.

      Returns Db | PromiseLike<Db>

      The instance or the promise with it.

Optional getLogger

getLogger?: Nilable<(() => ILogger)>

A function, returning a custom logger.

Type declaration

Returns

The logger to ise.

Optional getSystemName

getSystemName?: Nilable<(() => any)>

A custom function, returning the name of the system.

Type declaration

    • (): any

    • Returns any

Returns

A value representing the name of the system.

Optional setImmediate

setImmediate?: Nilable<SetImmediateFunc>

Custom setImmediate function.

Optional setTimeout

setTimeout?: Nilable<SetTimeoutFunc>

Custom setTimeout function.

Optional taskCollectionName

taskCollectionName?: Nilable<string>

The custom name of the collection for the tasks. Default: queueTasks

Optional waitBeforeRetry

waitBeforeRetry?: Nilable<number>

The custom time in milliseconds to wait, before a failed task is done to be executed. Default: 10000

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc