Interface DefineTaskOptions<Name, Input, Ctx, Output>

Options for defineTask(...).

interface DefineTaskOptions<
    Name extends string,
    Input extends StandardSchema,
    Ctx,
    Output,
> {
    description?: string;
    input: Input;
    handle(
        args: TaskHandleArgs<TaskDef<Name, Input, Ctx, Output>, Ctx>,
    ): MaybePromise<Output>;
}

Type Parameters

Name extends string
Input extends StandardSchema
Ctx
Output

Index

Properties

description? input

Methods

Properties

`Optional`description

description?: string

Optional human-readable description for docs and tooling.

input

input: Input

Standard Schema input validator.

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:104