Class State<TData, TOptions>

Execution state management.

The State is responsible for managing the state of command execution. It provides mechanisms to progress through command execution, handle state transitions, and manage the lifecycle of command data.

Type Parameters

TData = unknown
TOptions extends OptionsConfig = OptionsConfig

Index

Accessors

client

get client(): Client
The client for logging and I/O operations.

Returns Client
- Defined in core/state.ts:160

command

get command(): undefined | ResolvedCommand
Information about the current command module being executed.

Returns undefined | ResolvedCommand
- Defined in core/state.ts:116

commands

get commands(): ResolvedCommand[]
Information about all command modules loaded for the current execution.

Returns ResolvedCommand[]
- Defined in core/state.ts:123

context

get context(): Context<OptionsConfig>
Runtime and configuration context for the command execution.

Returns Context<OptionsConfig>
- Defined in core/state.ts:130

data

get data(): TData
The current data being passed between steps which will be returned after the last step or when end(data) is called.

Returns TData
- Defined in core/state.ts:138

i

get i(): number
The current step/command index within the command chain.

Returns number
- Defined in core/state.ts:109

options

get options(): OptionsGetter<TOptions>
An OptionsGetter to dynamically retrieve options.

Returns OptionsGetter<TOptions>
- Defined in core/state.ts:153

params

get params(): Params
Resolved route parameters from parameterized filenames, e.g., id from commands/get/[id].ts.

Returns Params
- Defined in core/state.ts:146

Constructors

constructor

new State<TData = unknown, TOptions extends OptionsConfig = OptionsConfig>(
__namedParameters: StateParams<TData>,
): State<TData, TOptions>
Type Parameters
- TData = unknown
- TOptions extends OptionsConfig = OptionsConfig
Parameters
- __namedParameters: StateParams<TData>
Returns State<TData, TOptions>
- Defined in core/state.ts:86

Methods

`Readonly`end

end(data?: unknown): Promise<unknown>
End execution, skipping any remaining steps, and return the current or provided data.
Parameters
- data: unknown = ...
  The data to return. Defaults to the current data.
Returns Promise<unknown>
The data from the last command.
- Defined in core/state.ts:270

`Readonly`fork

fork<TCommand extends CommandModule<any, any, unknown>>(
    __namedParameters: {
        commands: (ResolvedCommand | TCommand)[];
        initialData?: unknown;
        optionValues?: OptionValues<
            TCommand["options"] extends OptionsConfig ? any[any] : OptionsConfig,
        >;
        paramValues?: Params;
    },
): Promise<unknown>
Fork the state and execute a new set of commands with the same context.
Type Parameters
- TCommand extends CommandModule<any, any, unknown>
Parameters
- __namedParameters: {
      commands: (ResolvedCommand | TCommand)[];
      initialData?: unknown;
      optionValues?: OptionValues<
          TCommand["options"] extends OptionsConfig ? any[any] : OptionsConfig,
      >;
      paramValues?: Params;
  }
  - commands: (ResolvedCommand | TCommand)[]
    The commands to execute.
  - OptionalinitialData?: unknown
    The initial data to pass to the forked state. If not provided, the current data will be used.
  - OptionaloptionValues?: OptionValues<
    TCommand["options"] extends OptionsConfig ? any[any] : OptionsConfig,
    >
    Options to merge/override the current options.
  - OptionalparamValues?: Params
    Parameters to merge/override the current parameters.
Returns Promise<unknown>
The data from the last command.
- Defined in core/state.ts:320

`Readonly`next

next(data?: unknown): Promise<unknown>
Continue to the next step in the command chain or end the steps if there are no more steps.
Parameters
- data: unknown = ...
  The data to pass to the next step. If not provided, the current data will be used.
Returns Promise<unknown>
The data from the last command.
- Defined in core/state.ts:199

`Readonly`start

start(initialData?: unknown): Promise<void>
Start the steps.
Parameters
- initialData: unknown = ...
Returns Promise<void>
A promise that resolves when the steps are done.

Throws
If the steps have already started.
- Defined in core/state.ts:169

Class State<TData, TOptions>

Type Parameters

Index

Accessors

Constructors

Methods

Accessors

client

Returns Client

command

Returns undefined | ResolvedCommand

commands

Returns ResolvedCommand[]

context

Returns Context<OptionsConfig>

data

Returns TData

i

Returns number

options

Returns OptionsGetter<TOptions>

params

Returns Params

Constructors

constructor

Type Parameters

Parameters

Returns State<TData, TOptions>

Methods

Readonlyend

Parameters

Returns Promise<unknown>

Readonlyfork

Type Parameters

Parameters

commands: (ResolvedCommand | TCommand)[]

OptionalinitialData?: unknown

OptionaloptionValues?: OptionValues< TCommand["options"] extends OptionsConfig ? any[any] : OptionsConfig,>

OptionalparamValues?: Params

Returns Promise<unknown>

Readonlynext

Parameters

Returns Promise<unknown>

Readonlystart

Parameters

Returns Promise<void>

Throws

Settings

On This Page

`Readonly`end

`Readonly`fork

`Optional`initialData?: unknown

`Optional`optionValues?: OptionValues<
TCommand["options"] extends OptionsConfig ? any[any] : OptionsConfig,
>

`Optional`paramValues?: Params

`Readonly`next

`Readonly`start