Interface QuizSession

Readonlysize

answer

• answer(chat: string, user: string, text: string): "wrong" | "correct" | null

  Parameters

  • chat: string
  • user: string
  • text: string

  Returns "wrong" | "correct" | null

bind

• bind(sock: unknown): () => void

  Parameters

  • sock: unknown

  Returns () => void

end

• end(
      chat: string,
  ):
      | {
          chat: string;
          questionsAsked: number;
          ranking: { score: number; user: string }[];
          reason: string;
          total: number;
          winner: { score: number; user: string } | null;
      }
      | null

  End early. Returns the final ranking.

  Parameters

  • chat: string

  Returns
      | {
          chat: string;
          questionsAsked: number;
          ranking: { score: number; user: string }[];
          reason: string;
          total: number;
          winner: { score: number; user: string } | null;
      }
      | null

getScores

• getScores(chat: string): { score: number; user: string }[] | null

  Parameters

  • chat: string

  Returns { score: number; user: string }[] | null

handler

• handler(upsert: { messages: unknown[] }): void

  Parameters

  • upsert: { messages: unknown[] }

  Returns void

isActive

• isActive(chat: string): boolean

  Parameters

  • chat: string

  Returns boolean

onCorrect

• onCorrect(
      cb: (
          info: {
              answer: string | number;
              chat: string;
              index: number;
              points: number;
              scores: { score: number; user: string }[];
              user: string;
          },
      ) => void,
  ): () => void

  Parameters

  • cb: (
        info: {
            answer: string | number;
            chat: string;
            index: number;
            points: number;
            scores: { score: number; user: string }[];
            user: string;
        },
    ) => void

  Returns () => void

onEnd

• onEnd(cb: (result: Record<string, unknown>) => void): () => void

  Parameters

  • cb: (result: Record<string, unknown>) => void

  Returns () => void

onQuestion

• onQuestion(
      cb: (
          info: {
              chat: string;
              deadline: number;
              index: number;
              points: number;
              question: string;
              total: number;
          },
      ) => void,
  ): () => void

  Parameters

  • cb: (
        info: {
            chat: string;
            deadline: number;
            index: number;
            points: number;
            question: string;
            total: number;
        },
    ) => void

  Returns () => void

onTimeout

• onTimeout(
      cb: (
          info: {
              answer: string | number;
              chat: string;
              index: number;
              question: string;
              skipped?: boolean;
          },
      ) => void,
  ): () => void

  Per-question timeouts AND host skips (skipped: true).

  Parameters

  • cb: (
        info: {
            answer: string | number;
            chat: string;
            index: number;
            question: string;
            skipped?: boolean;
        },
    ) => void

  Returns () => void

skip

• skip(chat: string): boolean

  Skip the current question (reveals the answer via onTimeout).

  Parameters

  • chat: string

  Returns boolean

start

• start(
      chat: string,
      questions: QuizQuestion[],
      options?: { random?: () => number; shuffle?: boolean },
  ): { chat: string; total: number }

  Parameters

  • chat: string
  • questions: QuizQuestion[]
  • Optionaloptions: { random?: () => number; shuffle?: boolean }

  Returns { chat: string; total: number }

unbind

• unbind(): void

  Returns void