Interface AcEdPromptState<TPromptOptions, TResult>

Represents a single prompt step in a state machine workflow.

Each state is responsible for:

Building a prompt (options/config) to show to the user.
Handling the prompt result and deciding whether to continue or finish.

interface AcEdPromptState<TPromptOptions, TResult> {
    buildPrompt(): TPromptOptions;
    handleResult(
        result: TResult,
    ): AcEdPromptStateStep | Promise<AcEdPromptStateStep>;
}

Type Parameters

TPromptOptions
The prompt options type passed to the editor.
TResult
The result type returned by the editor.

Index

Methods

buildPrompt handleResult

Methods

buildPrompt

buildPrompt(): TPromptOptions
Build the prompt options for this state.

Returns TPromptOptions
- Defined in packages/cad-simple-viewer/src/editor/input/AcEdPromptStateMachine.ts:23

handleResult

handleResult(
result: TResult,
): AcEdPromptStateStep | Promise<AcEdPromptStateStep>
Handle the prompt result and return the next step directive.
Parameters
- result: TResult
  The result returned from the editor for this prompt.
Returns AcEdPromptStateStep | Promise<AcEdPromptStateStep>
- Defined in packages/cad-simple-viewer/src/editor/input/AcEdPromptStateMachine.ts:30