Interface ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware>

interface ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware> {
    [symbolFilePath]: string;
    [symbolPhantomTask]?: true;
    [symbolTask]: true;
    [symbolTunneledBy]?: string;
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    inputSchema?: IValidationSchema<TInput>;
    isTunneled?: boolean;
    meta?: TMeta;
    middleware: TMiddleware;
    optional: (() => IOptionalDependency<ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware>>);
    resultSchema?: IValidationSchema<TOutput extends Promise<U>
        ? U
        : never>;
    run: ((input: HasInputContracts<[...TTags[], ...TMiddleware[]]> extends true
        ? [TInput] extends [undefined]
            ? InferInputOrViolationFromContracts<[...TTags[], ...TMiddleware[]]>
            : EnsureInputSatisfiesContracts<[...TTags[], ...TMiddleware[]], TInput>
        : TInput, dependencies: DependencyValuesType<TDependencies>) => HasOutputContracts<[...TTags[], ...TMiddleware[]]> extends true
        ? EnsureOutputSatisfiesContracts<[...TTags[], ...TMiddleware[]], TOutput>
        : TOutput);
    tags: TTags;
}

Type Parameters

Hierarchy (view full)

Properties

[symbolFilePath] [symbolPhantomTask]? [symbolTask] [symbolTunneledBy]? computedDependencies? dependencies id inputSchema? isTunneled? meta? middleware optional resultSchema? run tags

Properties

[symbolFilePath]

[symbolFilePath]: string

Optional[symbolPhantomTask]

[symbolPhantomTask]?: true

Present only for phantom tasks.

[symbolTask]

[symbolTask]: true

Optional[symbolTunneledBy]

[symbolTunneledBy]?: string

Records which tunnel resource owns the task (exclusivity).

OptionalcomputedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

Access other tasks/resources/events. Can be an object or a function when you need late or config‑dependent resolution.

id

id: string

OptionalinputSchema

inputSchema?: IValidationSchema<TInput>

Optional validation schema for runtime input validation. When provided, task input will be validated before execution.

OptionalisTunneled

isTunneled?: boolean

Indicates if the task is tunneled through a tunnel client.

Optionalmeta

meta?: TMeta

Optional metadata used for docs, filtering and tooling.

middleware

middleware: TMiddleware

Middleware applied around task execution.

optional

optional: (() => IOptionalDependency<ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware>>)

Return an optional dependency wrapper for this task.

OptionalresultSchema

resultSchema?: IValidationSchema<TOutput extends Promise<U>
    ? U
    : never>

Optional validation schema for the task result. When provided, the result will be validated immediately after the task's run resolves, without considering middleware.

run

run: ((input: HasInputContracts<[...TTags[], ...TMiddleware[]]> extends true
    ? [TInput] extends [undefined]
        ? InferInputOrViolationFromContracts<[...TTags[], ...TMiddleware[]]>
        : EnsureInputSatisfiesContracts<[...TTags[], ...TMiddleware[]], TInput>
    : TInput, dependencies: DependencyValuesType<TDependencies>) => HasOutputContracts<[...TTags[], ...TMiddleware[]]> extends true
    ? EnsureOutputSatisfiesContracts<[...TTags[], ...TMiddleware[]], TOutput>
    : TOutput)

tags

tags: TTags

Tags applied to the task that might define its behvaiour or impact the systems.

Settings

Member Visibility

On This Page

Properties