WaitOptions

^{ref / conversations / WaitOptions}

Options for a call to conversation.wait().

^Source

Properties

maxMilliseconds

maxMilliseconds?: number;

Specifies a timeout for the wait call.

When the wait call is reached, Date.now() is called. When the wait call resolves, Date.now() is called again, and the two values are compared. If the wait call resolved more than the specified number of milliseconds after it was reached initially, then the conversation will be halted, any exit handlers will be called, and the surrounding middleware will resume normally so that subsequent handlers can run.

To the outside middleware system, this will look like the conversation was never active.

^Source

collationKey

collationKey?: string;

Collation key for the wait call, safety measure to protect against data corruption. This is used extensively by the plugin internally, but it is rarely useful to changes this behavior.

^Source