GuardFailure<S>

Type alias exported by @botmesh/core.

type GuardFailure<S> = 
  | string
  | DynamicText<S>
  | {
  message?: string | DynamicText<S>;
  redirect?: string | FlowBuilder<object>;
};

Defined in: flows/FlowBuilder.ts:156

What a .guard() does when its predicate fails. A string / dynamic text is a farewell message (the conversation ends).

Type Parameters

Type Parameter	Default type
S extends object	EmptyFlowState

Union Members

string

---

DynamicText<S>

---

Type Literal

{
  message?: string | DynamicText<S>;
  redirect?: string | FlowBuilder<object>;
}

Name	Type	Description	Defined in
message?	string | DynamicText<S>	Message sent before ending (or before redirecting).	flows/FlowBuilder.ts:161
redirect?	string | FlowBuilder<object>	Jump to another conversation instead of ending (like c.goto(name)).	flows/FlowBuilder.ts:163