• Preparing search index...
  • The search index is not available
@bluelibs/runner - v4.5.10
  • @bluelibs/runner
  • task

Function task

  • task<Input, Output, Deps, TMeta, TTags, TMiddleware>(taskConfig): 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:28

Settings

Member Visibility
@bluelibs/runner - v4.5.10
  • Loading...

Generated using TypeDoc