Interface WordChain

Readonlysize

end

• end(
      chat: string,
  ):
      | {
          chat: string;
          longestWord: string
          | null;
          scores: { score: number; user: string }[];
          turns: number;
          words: number;
      }
      | null

  End the round: scores best-first, longest word, turn count.

  Parameters

  • chat: string

  Returns
      | {
          chat: string;
          longestWord: string
          | null;
          scores: { score: number; user: string }[];
          turns: number;
          words: number;
      }
      | null

getState

• getState(
      chat: string,
  ):
      | {
          lastPlayer: string
          | null;
          lastWord: string;
          nextLetter: string | null;
          turns: number;
          words: number;
      }
      | null

  Parameters

  • chat: string

  Returns
      | {
          lastPlayer: string
          | null;
          lastWord: string;
          nextLetter: string | null;
          turns: number;
          words: number;
      }
      | null

isActive

• isActive(chat: string): boolean

  Parameters

  • chat: string

  Returns boolean

onEnd

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

  Parameters

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

  Returns () => void

onWord

• onWord(
      cb: (
          info: {
              chat: string;
              nextLetter: string;
              score: number;
              user: string;
              word: string;
          },
      ) => void,
  ): () => void

  Parameters

  • cb: (
        info: {
            chat: string;
            nextLetter: string;
            score: number;
            user: string;
            word: string;
        },
    ) => void

  Returns () => void

play

• play(chat: string, user: string, word: string): Promise<WordChainPlay>

  Parameters

  • chat: string
  • user: string
  • word: string

  Returns Promise<WordChainPlay>

start

• start(
      chat: string,
      options?: { firstWord?: string },
  ): { chat: string; firstWord: string; nextLetter: string | null }

  Parameters

  • chat: string
  • Optionaloptions: { firstWord?: string }

  Returns { chat: string; firstWord: string; nextLetter: string | null }