Interface ITaskDefinition<TInput, TOutput, TDependencies, TOn>

interface ITaskDefinition<TInput, TOutput, TDependencies, TOn> {
    dependencies?: TDependencies | (() => TDependencies);
    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
- ITask

Index

Properties

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

Properties

`Optional`dependencies

dependencies?: TDependencies | (() => TDependencies)

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

`Optional`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)