Class MongoQueueStorage

An IQueueStorage with MongoDB as backend.

Hierarchy

QueueStorageBase
- MongoQueueStorage

Index

Constructors

Properties

_taskCollectionName _waitBeforeRetry getDb getLogger getSystemName setImmediate setTimeout

Methods

createContextFromDocument enqueueRemainingTasks enqueueTask executeTask getErrorHandlers getExecutionHandlers on stopAllEnqueuedTasks withTaskCollection

Constructors

constructor

new MongoQueueStorage(options): MongoQueueStorage
Initializes a new instance of that class.
Parameters
- options: IMongoQueueStorageOptions
  The options.
Returns MongoQueueStorage
Overrides QueueStorageBase.constructor
- Defined in src/classes/MongoQueueStorage.ts:81

Properties

`Private` `Readonly` _taskCollectionName

_taskCollectionName: string = defaultQueueTasksCollectionName

`Private` `Readonly` _waitBeforeRetry

_waitBeforeRetry: number = defaultWaitBeforeRetryTime

`Readonly` getDb

getDb: (() => Promise<Db>)

Type declaration

- (): Promise<Db>
- Returns the Mongo database to use.
  
  Returns Promise<Db>
  The promise with the instance.

`Readonly` getLogger

getLogger: (() => ILogger)

Type declaration

- (): ILogger
- Returns the logger.
  
  Returns ILogger
  The logger.

`Readonly` getSystemName

getSystemName: (() => Optional<string>)

Type declaration

- (): Optional<string>
- Returns the (normalized) system name.
  
  Returns Optional<string>
  The system name.

`Readonly` setImmediate

setImmediate: SetImmediateFunc

setImmediate function to use.

`Readonly` setTimeout

setTimeout: SetTimeoutFunc

setTimeout function to use.

Methods

`Protected` createContextFromDocument

createContextFromDocument(doc): Promise<IQueueTaskContext>
Creates an IQueueTaskContext from a mongo document.
Parameters
- doc: IMongoQueueTaskDocument
  The document.
Returns Promise<IQueueTaskContext>
The promise with the new instance.
- Defined in src/classes/MongoQueueStorage.ts:178

enqueueRemainingTasks

enqueueRemainingTasks(): Promise<IQueueTaskContext[]>
Returns Promise<IQueueTaskContext[]>
Inherit Doc
Overrides QueueStorageBase.enqueueRemainingTasks
- Defined in src/classes/MongoQueueStorage.ts:208

enqueueTask

enqueueTask(options): Promise<IQueueTaskContext>
Parameters
- options: IQueueTaskInStorageOptions
Returns Promise<IQueueTaskContext>
Inherit Doc
Overrides QueueStorageBase.enqueueTask
- Defined in src/classes/MongoQueueStorage.ts:246

`Private` executeTask

executeTask(options): void
Parameters
- options: IExecuteTaskOptions
Returns void
- Defined in src/classes/MongoQueueStorage.ts:277

`Protected` getErrorHandlers

getErrorHandlers(): QueueErrorHandler[]
Returns a copy of the list of error handlers.

Returns QueueErrorHandler[]
The list of error handlers.
Inherited from QueueStorageBase.getErrorHandlers
- Defined in node_modules/@egomobile/queue/lib/classes/queueStorageBase.d.ts:14

`Protected` getExecutionHandlers

getExecutionHandlers(): QueueExecutionHandler[]
Returns a copy of the list of execution handlers.

Returns QueueExecutionHandler[]
The list of execution handlers.
Inherited from QueueStorageBase.getExecutionHandlers
- Defined in node_modules/@egomobile/queue/lib/classes/queueStorageBase.d.ts:20

on

on(event, handler): MongoQueueStorage
Parameters
- event: QueueStorageEvent
- handler: Func
Returns MongoQueueStorage
Inherit Doc
Inherited from QueueStorageBase.on
- Defined in node_modules/@egomobile/queue/lib/classes/queueStorageBase.d.ts:24

stopAllEnqueuedTasks

stopAllEnqueuedTasks(): Promise<any>
Returns Promise<any>
Inherit Doc
Overrides QueueStorageBase.stopAllEnqueuedTasks
- Defined in src/classes/MongoQueueStorage.ts:429

`Protected` withTaskCollection

withTaskCollection<TResult>(action): Promise<TResult>
Execute an action for the task collection.
Type Parameters
- TResult = any
Parameters
- action: WithTaskCollectionAction<TResult>
  The action to invoke.
Returns Promise<TResult>
The promise with the result.
- Defined in src/classes/MongoQueueStorage.ts:458

Generated using TypeDoc