@waylis/core

---

@waylis/core / SceneStep

Interface: SceneStep<K, T>

Defined in: scene/step.ts:21

Defines a single step in a scene.

Type Parameters

K

K extends string = string

T

T extends UserMessageBodyType = UserMessageBodyType

Properties

handler()?

optional handler: (body: MessageBodyMap[T]) => Promise<void | SystemMessageBody>;

Defined in: scene/step.ts:34

Optional handler to process (validate) the user's reply.

Parameters

body

MessageBodyMap[T]

Message body matching the reply restriction type.

Returns

Promise<void | SystemMessageBody>

Optional system message response if processing (validation) fails.

---

key

key: K;

Defined in: scene/step.ts:23

Unique key identifying the step.

---

prompt

prompt: SystemMessageBody;

Defined in: scene/step.ts:25

Prompt message shown to the user.

---

reply

reply: ExpectedReply<T>;

Defined in: scene/step.ts:27

Restriction on expected reply.