Interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput>

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

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

Type Parameters

TInput = any
TOutput extends Promise<any> = any
TDependencies extends DependencyMapType = {}
TEventDefinitionInput = null

Hierarchy (view full)

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

Index

Properties

computedDependencies? dependencies events id 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`meta

meta?: ITaskMeta

middleware

middleware: IMiddlewareDefinition<any>[]

`Optional`on

on?: IEventDefinition<TEventDefinitionInput>

run

run: ((input: TEventDefinitionInput extends null
? TInput
: TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)