Interface Command<TValues, TPositionals>

Command with handler attached (terminal in the pipeline).

interface Command<
    TValues = Record<string, unknown>,
    TPositionals extends readonly unknown[] = readonly unknown[],
> {
    __brand: "Command";
    __optionsSchema: OptionsSchema;
    __positionalsSchema: PositionalsSchema;
    description?: string;
    handler: HandlerFn<TValues, TPositionals>;
}

Type Parameters

TValues = Record<string, unknown>
TPositionals extends readonly unknown[] = readonly unknown[]

Index

Properties

__brand __optionsSchema __positionalsSchema description? handler

Properties

`Readonly`__brand

__brand: "Command"

Brand for type discrimination. Do not use directly.

`Readonly`__optionsSchema

__optionsSchema: OptionsSchema

Options schema. Do not use directly.

`Readonly`__positionalsSchema

__positionalsSchema: PositionalsSchema

Positionals schema. Do not use directly.

`Optional` `Readonly`description

description?: string

Command description for help text

`Readonly`handler

handler: HandlerFn<TValues, TPositionals>

The handler function