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

Accessors

command commands context data i options params

Constructors

constructor

Methods

end fork next start

Accessors

command

commands

context

data

i

  • get i(): number

  • The current step index.

    Returns number

options

params

Constructors

constructor

Methods

Readonly end

  • end(data?): Promise<void>

  • Return data and end the steps.

    Parameters

    • Optional data: unknown

      The data to return.

    Returns Promise<void>

Readonly fork

Readonly next

  • next(data?): Promise<void>

  • Modify the data and continue to the next step if there is one, otherwise return the data.

    Parameters

    • Optional data: unknown

      The data to pass to the next step or return.

    Returns Promise<void>

Readonly start

  • start(initialData?): Promise<void>

  • Start the steps.

    Parameters

    • Optional initialData: unknown

    Returns Promise<void>

    A promise that resolves when the steps are done.

    Throws

    If the steps have already started.

Settings

Member Visibility

Theme

On This Page

commandcommandscontextdataioptionsparamsconstructorendforknextstart