GramIO API Reference / @gramio/prompt/dist / WaitFunction

Interface: WaitFunction()<GlobalData>

Defined in: prompt/index.d.ts:107

Type Parameters

Type Parameter	Default type
GlobalData	never

Call Signature

WaitFunction<Data>(): Promise<PromptAnswer<"message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query", Data>>

Defined in: prompt/index.d.ts:109

Wait for the next event from the user

Type Parameters

Type Parameter	Default type
Data	GlobalData

Returns

Promise<PromptAnswer<"message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query", Data>>

Call Signature

WaitFunction<Event, Data>(event): Promise<PromptAnswer<Event, Data>>

Defined in: prompt/index.d.ts:111

Wait for the next event from the user ignoring events not listed

Type Parameters

Type Parameter	Default type
Event extends "message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query"	-
Data	GlobalData

Parameters

Parameter	Type
event	MaybeArray<Event>

Returns

Promise<PromptAnswer<Event, Data>>

Call Signature

WaitFunction<Data>(validate): Promise<PromptAnswer<"message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query", Data>>

Defined in: prompt/index.d.ts:113

Wait for the next event from the user ignoring non validated answers

Type Parameters

Type Parameter	Default type
Data	GlobalData

Parameters

Parameter	Type
validate	ValidateFunction<"message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query">

Returns

Promise<PromptAnswer<"message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query", Data>>

Call Signature

WaitFunction<Event, Data>(event, options): Promise<PromptAnswer<Event, Data>>

Defined in: prompt/index.d.ts:115

Wait for the next event from the user ignoring non validated answers and not listed events with transformer

Type Parameters

Type Parameter	Default type
Event extends "message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query"	-
Data	GlobalData

Parameters

Parameter	Type
event	MaybeArray<Event>
options	{ transform?: TransformFunction<Event, Data>; validate?: ValidateFunction<Event>; }
options.transform?	TransformFunction<Event, Data>
options.validate?	ValidateFunction<Event>

Returns

Promise<PromptAnswer<Event, Data>>

Call Signature

WaitFunction<Event, Data>(event, validate): Promise<PromptAnswer<Event, Data>>

Defined in: prompt/index.d.ts:120

Wait for the next event from the user ignoring non validated answers and not listed events

Type Parameters

Type Parameter	Default type
Event extends "message" | "edited_message" | "channel_post" | "edited_channel_post" | "callback_query"	-
Data	GlobalData

Parameters

Parameter	Type
event	MaybeArray<Event>
validate	ValidateFunction<Event>

Returns

Promise<PromptAnswer<Event, Data>>