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 the command.

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

command

get command(): ResolvedCommand
The current command.

Returns ResolvedCommand
- Defined in core/state.ts:96

commands

get commands(): ResolvedCommand[]
The commands that will be executed.

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

context

get context(): Context<OptionsConfig>
The context for the command.

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

data

get data(): TData
The current data.

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

i

get i(): number
The current step index.

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

options

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

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

params

get params(): Params
The current params, including params from previous steps.

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

Constructors

constructor

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

Methods

`Readonly`end

end(data?): Promise<void>
Return data and end the steps.
Parameters
- Optionaldata: unknown
  The data to return.
Returns Promise<void>
- Defined in core/state.ts:211

`Readonly`fork

fork<TCommand>(__namedParameters): Promise<any>
Fork the state and execute a new set of commands with the same context.
Type Parameters
- TCommand extends CommandModule<any, any>
Parameters
- __namedParameters: {
      commands: (ResolvedCommand | TCommand)[];
      initialData?: any;
      optionValues?: OptionValues<Required<TCommand>["options"] extends OptionsConfig
          ? any[any]
          : OptionsConfig>;
      paramValues?: Record<string, any>;
  }
  - commands: (ResolvedCommand | TCommand)[]
  - OptionalinitialData?: any
  - OptionaloptionValues?: OptionValues<Required<TCommand>["options"] extends OptionsConfig
    ? any[any]
    : OptionsConfig>
  - OptionalparamValues?: Record<string, any>
Returns Promise<any>
The data from the last command.
- Defined in core/state.ts:259

`Readonly`next

next(data?): Promise<void>
Modify the data and continue to the next step if there is one, otherwise return the data.
Parameters
- Optionaldata: unknown
  The data to pass to the next step or return.
Returns Promise<void>
- Defined in core/state.ts:157

`Readonly`start

start(initialData?): 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:129

Class State<TData, TOptions>

Type Parameters

Index

Accessors

Constructors

Methods

Accessors

client

Returns Client

command

Returns 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<void>

Readonlyfork

Type Parameters

Parameters

commands: (ResolvedCommand | TCommand)[]

OptionalinitialData?: any

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

OptionalparamValues?: Record<string, any>

Returns Promise<any>

Readonlynext

Parameters

Returns Promise<void>

Readonlystart

Parameters

Returns Promise<void>

Throws

Settings

On This Page

`Readonly`end

`Readonly`fork

`Optional`initialData?: any

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

`Optional`paramValues?: Record<string, any>

`Readonly`next

`Readonly`start