@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface ChooseStepOptions

    Options of .choose(prompt, options, stateKey, opts).

    interface ChooseStepOptions {
        timeout?: string | number;
        validate?: (
            body: string,
            ctx: RuntimeMessage,
        ) => string | true | Promise<string | true>;
        maxAttempts?: number;
        retries?: number;
        otherwise?: string;
        filter?: (ctx: RuntimeMessage) => boolean;
        delay?: FlowDelay;
    }

    Hierarchy (View Summary)

    Index
    timeout? validate? maxAttempts? retries? otherwise? filter? delay?
    timeout?: string | number
    validate?: (
        body: string,
        ctx: RuntimeMessage,
    ) => string | true | Promise<string | true>
    maxAttempts?: number

    Total answers the wait accepts, the first one included, before the conversation ends with the "too many attempts" message (RetriesExceeded). Invalid answers and c.retry() calls count. Default 3; Infinity = unlimited.

    retries?: number

    Retries AFTER the first answer: 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.

    otherwise?: string
    filter?: (ctx: RuntimeMessage) => boolean
    delay?: FlowDelay

    Settings
    Member Visibility

    On This Page
    Properties