Class MemoryQueueStorage

A queue stroage based on array in memory.

Hierarchy

QueueStorageBase
- MemoryQueueStorage

Index

Constructors

Properties

_nextId _tasksInQueue

Methods

cleanupTasksInQueue enqueueRemainingTasks enqueueTask executeTask getErrorHandlers getExecutionHandlers on stopAllEnqueuedTasks

Constructors

constructor

new MemoryQueueStorage(): MemoryQueueStorage
Returns MemoryQueueStorage

Inherited from QueueStorageBase.constructor

Properties

`Private` _nextId

_nextId: number = Number.MIN_SAFE_INTEGER

`Private` _tasksInQueue

_tasksInQueue: ITaskInQueue[] = []

Methods

`Private` cleanupTasksInQueue

cleanupTasksInQueue(): void
Returns void
- Defined in classes/memoryQueueStorage.ts:40

enqueueRemainingTasks

enqueueRemainingTasks(): Promise<IQueueTaskContext[]>
Enqueues all remaing tasks, which are not finished or aborted.

Returns
The contextes or the promise with it.

Returns Promise<IQueueTaskContext[]>
Overrides QueueStorageBase.enqueueRemainingTasks
- Defined in classes/memoryQueueStorage.ts:116

enqueueTask

enqueueTask(options: IQueueTaskInStorageOptions): Promise<IQueueTaskContext>
Queues a task.

Returns
The context or the promise with it.
Parameters
- options: IQueueTaskInStorageOptions
  
  The options.
Returns Promise<IQueueTaskContext>
Overrides QueueStorageBase.enqueueTask
- Defined in classes/memoryQueueStorage.ts:136

`Private` executeTask

executeTask(taskInQueue: ITaskInQueue): void
Parameters
- taskInQueue: ITaskInQueue
Returns void
- Defined in classes/memoryQueueStorage.ts:46

`Protected` getErrorHandlers

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

Returns
The list of error handlers.

Returns QueueErrorHandler[]
Inherited from QueueStorageBase.getErrorHandlers
- Defined in classes/queueStorageBase.ts:31

`Protected` getExecutionHandlers

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

Returns
The list of execution handlers.

Returns QueueExecutionHandler[]
Inherited from QueueStorageBase.getExecutionHandlers
- Defined in classes/queueStorageBase.ts:40

on

on(event: QueueStorageEvent, handler: Func): MemoryQueueStorage
Registers one or more error handlers.

Returns
This instance.
Parameters
- event: QueueStorageEvent
  
  The name of the known event.
- handler: Func
  
  The handler to register.
Returns MemoryQueueStorage
Inherited from QueueStorageBase.on
- Defined in classes/queueStorageBase.ts:47

stopAllEnqueuedTasks

stopAllEnqueuedTasks(): Promise<any>
Stops all enqueued tasks.

Returns Promise<any>
Overrides QueueStorageBase.stopAllEnqueuedTasks
- Defined in classes/memoryQueueStorage.ts:156

Generated using TypeDoc