Class TaskRunner

Index

Constructors

Properties

eventManager logger runnerStore store

Methods

createRunnerWithMiddleware run

Constructors

constructor

new TaskRunner(store, eventManager, logger): TaskRunner
Parameters
- store: Store
- eventManager: EventManager
- logger: Logger
Returns TaskRunner
- Defined in src/models/TaskRunner.ts:15

Properties

`Protected` `Readonly`eventManager

eventManager: EventManager

`Protected` `Readonly`logger

logger: Logger

`Protected` `Readonly`runnerStore

runnerStore: Map<string | symbol, ((input: any) => Promise<any>)> = ...

`Protected` `Readonly`store

store: Store

Methods

`Protected`createRunnerWithMiddleware

createRunnerWithMiddleware<TInput, TOutput, TDeps>(task): ((input: any) => Promise<TOutput | (TOutput extends Promise<U>
? U
: never)>)
Creates the function with the chain of middleware.
Type Parameters
- TInput
- TOutput extends Promise<any>
- TDeps extends DependencyMapType
Parameters
- task: ITask<TInput, TOutput, TDeps, any, TagType[], TaskMiddlewareAttachmentType[]>
Returns ((input: any) => Promise<TOutput | (TOutput extends Promise<U>
? U
: never)>)
- - (input): Promise<TOutput | (TOutput extends Promise<U>
    ? U
    : never)>
  - Parameters
    - input: any
    Returns Promise<TOutput | (TOutput extends Promise<U>
    ? U
    : never)>
- Defined in src/models/TaskRunner.ts:69

run

run<TInput, TOutput, TDeps>(task, input?): Promise<undefined | TOutput>
Begins the execution of an task. These are registered tasks and all sanity checks have been performed at this stage to ensure consistency of the object. This function can throw only if any of the event listeners or run function throws
Type Parameters
- TInput
- TOutput extends Promise<any>
- TDeps extends DependencyMapType
Parameters
- task: ITask<TInput, TOutput, TDeps, any, TagType[], TaskMiddlewareAttachmentType[]>
  the task to be run
- Optionalinput: TInput
  the input to be passed to the task
Returns Promise<undefined | TOutput>
- Defined in src/models/TaskRunner.ts:33