Interface ITask<TInput, TOutput, TDependencies, TOn>

This is the response after the definition has been prepared. TODO: better naming?

interface ITask<TInput, TOutput, TDependencies, TOn> {
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    events: {
        afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
        beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware: IMiddlewareDefinition<any>[];
    on?: TOn;
    run: ((input: TOn extends undefined
        ? TInput
        : IEvent<ExtractEventParams<TOn>>, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

TInput = any
TOutput extends Promise<any> = any
TDependencies extends DependencyMapType = {}
TOn extends "*" | IEventDefinition<any> | undefined = undefined

Hierarchy (view full)

ITaskDefinition<TInput, TOutput, TDependencies, TOn>
- ITask

Index

Properties

computedDependencies? dependencies events id listenerOrder? meta? middleware on? run

Properties

`Optional`computedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

events

events: {
    afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
    beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

id

id: string

`Optional`listenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. The event with the lowest order will be executed first.

`Optional`meta

meta?: ITaskMeta

middleware

middleware: IMiddlewareDefinition<any>[]

`Optional`on

on?: TOn

Listen to events in a simple way

run

run: ((input: TOn extends undefined
? TInput
: IEvent<ExtractEventParams<TOn>>, dependencies: DependencyValuesType<TDependencies>) => TOutput)