@japofc/baileys - v2.4.7
    Preparing search index...

    Interface GuessGame

    interface GuessGame {
        size: number;
        bind(sock: unknown): () => void;
        clear(): void;
        end(chat: string): string | null;
        getRound(chat: string): GuessRoundInfo | null;
        guess(
            chat: string,
            user: string,
            text: string,
            msg?: unknown,
        ): "wrong" | "correct" | null;
        handler(upsert: { messages: unknown[] }): void;
        isActive(chat: string): boolean;
        onCorrect(cb: (event: GuessCorrectEvent) => void): () => void;
        onTimeout(
            cb: (
                event: {
                    answer: string;
                    attempts: number;
                    chat: string;
                    hint: string;
                },
            ) => void,
        ): () => void;
        onWrong(
            cb: (
                event: {
                    attempts: number;
                    chat: string;
                    close: boolean;
                    distance: number;
                    msg?: unknown;
                    text: string;
                    user: string;
                },
            ) => void,
        ): () => void;
        revealHint(chat: string, options?: { fraction?: number }): string | null;
        start(
            chat: string,
            round: {
                answer: string | number;
                hint?: string;
                reward?: number;
                startedBy?: string;
                timeoutMs?: number;
            },
        ): { chat: string; deadline: number; hint: string; reward: number };
        startNumberGame(
            chat: string,
            options?: {
                max?: number;
                min?: number;
                random?: () => number;
                reward?: number;
                startedBy?: string;
                timeoutMs?: number;
            },
        ): { chat: string; deadline: number; hint: string; reward: number };
        unbind(): void;
    }
    Index
    size
    bind clear end getRound guess handler isActive onCorrect onTimeout onWrong revealHint start startNumberGame unbind
    size: number

    • End a round without a winner; returns the answer.

      Parameters

      • chat: string

      Returns string | null

    • Parameters

      • chat: string
      • user: string
      • text: string
      • Optionalmsg: unknown

      Returns "wrong" | "correct" | null

    • Parameters

      • upsert: { messages: unknown[] }

      Returns void

    • Parameters

      • cb: (
            event: { answer: string; attempts: number; chat: string; hint: string },
        ) => void

      Returns () => void

    • Parameters

      • cb: (
            event: {
                attempts: number;
                chat: string;
                close: boolean;
                distance: number;
                msg?: unknown;
                text: string;
                user: string;
            },
        ) => void

      Returns () => void

    • Progressive hint mask ('j_k__t_'), more letters each call.

      Parameters

      • chat: string
      • Optionaloptions: { fraction?: number }

      Returns string | null

    • Parameters

      • chat: string
      • round: {
            answer: string | number;
            hint?: string;
            reward?: number;
            startedBy?: string;
            timeoutMs?: number;
        }

      Returns { chat: string; deadline: number; hint: string; reward: number }

    • Number-guessing round with an auto-generated answer + hint.

      Parameters

      • chat: string
      • Optionaloptions: {
            max?: number;
            min?: number;
            random?: () => number;
            reward?: number;
            startedBy?: string;
            timeoutMs?: number;
        }

      Returns { chat: string; deadline: number; hint: string; reward: number }

    Settings
    Member Visibility

    On This Page
    Properties
    Methods