Function task

task<
    Input = undefined,
    Output extends Promise<any> = any,
    Deps extends DependencyMapType = any,
    TMeta extends ITaskMeta = any,
    TTags extends TagType[] = TagType[],
    TMiddleware extends
        TaskMiddlewareAttachmentType[] = TaskMiddlewareAttachmentType[],
>(
    taskConfig: ITaskDefinition<
        Input,
        Output,
        Deps,
        TMeta,
        TTags,
        TMiddleware,
    >,
): ITask<Input, Output, Deps, TMeta, TTags, TMiddleware>
Define a task. Generates a strongly-typed task object with id, dependencies, middleware, and metadata.
Type Parameters
- Input = undefined
  Input type accepted by the task's run function.
- Output extends Promise<any> = any
  Promise type returned by the run function.
- Deps extends DependencyMapType = any
  Dependency map type this task requires.
- TMeta extends ITaskMeta = any
  Arbitrary metadata type carried by the task.
- TTags extends TagType[] = TagType[]
- TMiddleware extends TaskMiddlewareAttachmentType[] = TaskMiddlewareAttachmentType[]
Parameters
- taskConfig: ITaskDefinition<Input, Output, Deps, TMeta, TTags, TMiddleware>
  The task definition config.
Returns ITask<Input, Output, Deps, TMeta, TTags, TMiddleware>
A branded task definition usable by the runner.
- Defined in src/definers/defineTask.ts:34

Index

Methods

Methods

phantom

phantom<Input = undefined, Output extends Promise<any> = any>(
    taskConfig: Omit<
        ITaskDefinition<Input, Output, any, any, any, any>,
        "run",
    >,
): IPhantomTask<Input, Output, any, any, any, any>
Type Parameters
- Input = undefined
- Output extends Promise<any> = any
Parameters
- taskConfig: Omit<ITaskDefinition<Input, Output, any, any, any, any>, "run">
Returns IPhantomTask<Input, Output, any, any, any, any>
- Defined in src/definers/defineTask.ts:73