.ask(text, key, opts): every wait option plus a zod-compatible schema and a delay.
Extends
Type Parameters
Properties
timeout?
Inherited from
WaitOptions.timeout
validate?
Parameters
Returns
string | true | Promise<string | true>
Inherited from
WaitOptions.validate
maxAttempts?
RetriesExceeded). Invalid answers and
c.retry() calls count. Default 3; Infinity = unlimited.
Inherited from
WaitOptions.maxAttempts
retries?
retries: N is maxAttempts: N + 1. Pass one of the two.
Breaking in 2.0: during the alphas retries: N meant N total attempts; use
maxAttempts: N to keep that behaviour. A wait that sets retries without
maxAttempts logs one warning per bot (logger.warn) to flag the change.
Inherited from
WaitOptions.retries
otherwise?
Inherited from
WaitOptions.otherwise
filter?
Parameters
Returns
boolean
Inherited from
WaitOptions.filter
schema?
safeParse() schema (zod-compatible). The parsed
value is stored in c.state[key]; a rejected answer re-prompts with otherwise, else the
schema’s first issue message. Runs after validate.