Interface IQueueStorage

A queue storage.

Hierarchy

IQueueStorage

Implemented by

QueueStorageBase

Index

Properties

Methods

enqueueRemainingTasks on stopAllEnqueuedTasks

Properties

enqueueTask

enqueueTask: ((options: IQueueTaskInStorageOptions) => IQueueTaskContext | PromiseLike<IQueueTaskContext>)

Type declaration

- (options: IQueueTaskInStorageOptions): IQueueTaskContext | PromiseLike<IQueueTaskContext>
- Queues a task.
  
  Returns
  The context or the promise with it.
  Parameters
  - options: IQueueTaskInStorageOptions
    
    The options.
  Returns IQueueTaskContext | PromiseLike<IQueueTaskContext>

Methods

enqueueRemainingTasks

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

Returns
The contextes or the promise with it.

Returns IQueueTaskContext[] | PromiseLike<IQueueTaskContext[]>
- Defined in types/index.ts:68

on

on(event: "error", handler: QueueErrorHandler): IQueueStorage
Registers one or more error handlers.

Returns
This instance.
Parameters
- event: "error"
  
  The name of the known event.
- handler: QueueErrorHandler
  
  The handler to register.
Returns IQueueStorage
- Defined in types/index.ts:59
on(event: "execute", handler: QueueExecutionHandler): IQueueStorage
Parameters
- event: "execute"
- handler: QueueExecutionHandler
Returns IQueueStorage
- Defined in types/index.ts:60
on(event: QueueStorageEvent, handler: Func): IQueueStorage
Parameters
- event: QueueStorageEvent
- handler: Func
Returns IQueueStorage
- Defined in types/index.ts:61

stopAllEnqueuedTasks

stopAllEnqueuedTasks(): any
Stops all enqueued tasks.

Returns any
- Defined in types/index.ts:82

Generated using TypeDoc