Class StepScene<T, S>

Type Parameters

T = MessageContext
S extends Record<string, unknown> = Record<string, any>

Implements

IScene<S>

Index

Constructors

Properties

onEnterHandler onLeaveHandler slug steps

Methods

enterHandler leaveHandler

Constructors

constructor

new StepScene<T, S>(slug, rawOptions): StepScene<T, S>
Type Parameters
- T = MessageContext<ContextDefaultState>
- S extends Record<string, unknown> = Record<string, any>
Parameters
- slug: string
- rawOptions: StepSceneHandler<T, S>[] | IStepSceneOptions<T, S>
Returns StepScene<T, S>
- Defined in scenes/src/scenes/step.ts:22

Properties

`Private` onEnterHandler

onEnterHandler: StepSceneHandler<T, S>

`Private` onLeaveHandler

onLeaveHandler: StepSceneHandler<T, S>

slug

slug: string

The unique name of the scene

`Private` steps

steps: StepSceneHandler<T, S>[]

Methods

enterHandler

enterHandler(context): Promise<void>
Enter handler for the scene
Parameters
- context: IStepContext<S> & T
Returns Promise<void>
Implementation of IScene.enterHandler
- Defined in scenes/src/scenes/step.ts:38

leaveHandler

leaveHandler(context): Promise<unknown>
Leave handler for the scene
Parameters
- context: IStepContext<S> & T
Returns Promise<unknown>
Implementation of IScene.leaveHandler
- Defined in scenes/src/scenes/step.ts:54

Generated using TypeDoc