Interface TaskDef<Name, Input, Ctx, Output>

Operational task definition created by defineTask(...).

interface TaskDef<
    Name extends string = string,
    Input extends StandardSchema = StandardSchema,
    Ctx = unknown,
    Output = unknown,
> {
    description?: string;
    input: Input;
    kind: "task";
    name: Name;
    handle(
        args: TaskHandleArgs<TaskDef<Name, Input, Ctx, Output>, Ctx>,
    ): MaybePromise<Output>;
}

Type Parameters

Name extends string = string
Input extends StandardSchema = StandardSchema
Ctx = unknown
Output = unknown

Index

Properties

description? input kind name

Methods

Properties

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`input

input: Input

Standard Schema input validator.

`Readonly`kind

kind: "task"

Discriminator for task definitions.

`Readonly`name

name: Name

Stable task name used by CLIs and operational runners.

Methods

handle

handle(
args: TaskHandleArgs<TaskDef<Name, Input, Ctx, Output>, Ctx>,
): MaybePromise<Output>
Handle a parsed task input.
Parameters
- args: TaskHandleArgs<TaskDef<Name, Input, Ctx, Output>, Ctx>
Returns MaybePromise<Output>
- Defined in packages/core/src/tasks/index.ts:49