Interface TestChat

jid

chatId

senderId

isGroup

displayName

send

• send(text: string, opts?: { type?: MessageType }): Promise<void>

  Simulate an inbound message from this user, then yield one macrotask so the dispatch starts.

  Parameters

  • text: string
  • Optionalopts: { type?: MessageType }

  Returns Promise<void>

sendLocation

• sendLocation(location: InboundLocation): Promise<void>

  Simulate a shared location (ctx.sharedLocation, c.waitLocation()).

  Parameters

  • location: InboundLocation

  Returns Promise<void>

• sendLocation(
      lat: number,
      lng: number,
      extra?: Omit<InboundLocation, "latitude" | "longitude">,
  ): Promise<void>

  Parameters

  • lat: number
  • lng: number
  • Optionalextra: Omit<InboundLocation, "latitude" | "longitude">

  Returns Promise<void>

sendMedia

• sendMedia(
      kind:
          | "image"
          | "video"
          | "audio"
          | "voice"
          | "document"
          | "sticker"
          | "location"
          | "contact",
      source: MockMediaSource,
      caption?: string | MockMediaOptions,
  ): Promise<void>

  Simulate an inbound media message: ctx.body is the caption, loadMediaOf(ctx) resolves with the bytes. A { url } source without bytes makes the download reject with MediaUnavailableError (the mock never touches the network).

  Parameters

  • kind:
        | "image"
        | "video"
        | "audio"
        | "voice"
        | "document"
        | "sticker"
        | "location"
        | "contact"
  • source: MockMediaSource
  • Optionalcaption: string | MockMediaOptions

  Returns Promise<void>

sendReaction

• sendReaction(
      emoji: string,
      target?: MessageRef | { to?: MessageRef; removed?: boolean },
  ): Promise<void>

  Simulate a reaction (bot.on('reaction'), 'reaction' hooks). Default target: the bot's last message in this chat, else the user's last message. { removed: true } retracts it.

  Parameters

  • emoji: string
  • Optionaltarget: MessageRef | { to?: MessageRef; removed?: boolean }

  Returns Promise<void>

sendInteraction

• sendInteraction(
      data: string,
      opts?: {
          kind?: "list" | "button" | "command" | "modal" | "autocomplete";
          id?: string;
      },
  ): Promise<void>

  Simulate a raw interaction (provider.interaction): data is what ctx.body / ctx.interaction.data carry.

  Parameters

  • data: string
  • Optionalopts: { kind?: "list" | "button" | "command" | "modal" | "autocomplete"; id?: string }

  Returns Promise<void>

pressButton

• pressButton(target: string | number): Promise<PressedButton>

  Press a native button, list row or card button of the LAST interactive message the bot sent to this chat: by id, by title (case-insensitive) or 1-based index. The bot receives what a real press produces (a 'buttons' message whose body is the id).

  Parameters

  • target: string | number

  Returns Promise<PressedButton>

expectReply

• expectReply(matcher: string | RegExp, timeoutMs?: number): Promise<string>

  Resolve with the first reply matching matcher (already sent or arriving before the timeout).

  Parameters

  • matcher: string | RegExp
  • OptionaltimeoutMs: number

  Returns Promise<string>

expectNoReply

• expectNoReply(opts?: number | { timeout?: number }): Promise<void>

  Resolve when no reply beyond the ones already consumed exists now nor arrives within timeout (default 300 ms); reject listing the unexpected replies. Consumes nothing.

  Parameters

  • Optionalopts: number | { timeout?: number }

  Returns Promise<void>

replies

• replies(): string[]

  Snapshot of all text/caption replies sent to this chat so far (buttons and lists: their text).

  Returns string[]

sent

• sent(): TestSent[]

  Every message the bot sent to this chat, with its full content and ref.

  Returns TestSent[]

lastReply

• lastReply(): TestSent | undefined

  The last message the bot sent to this chat.

  Returns TestSent | undefined

transcript

• transcript(opts: TestTranscriptOptions & { as: "text" }): string

  The exchange so far as a golden Transcript (same shape recordTranscript produces: it parses, redacts and replays with assertTranscript). Deterministic by default (no ids, no timestamps), so it fits toMatchSnapshot().

  Parameters

  • opts: TestTranscriptOptions & { as: "text" }

  Returns string

• transcript(opts?: TestTranscriptOptions): Transcript

  Parameters

  • Optionalopts: TestTranscriptOptions

  Returns Transcript

as

• as(userId: string, opts?: { displayName?: string }): TestChat

  Same chat seen by another participant (groups). On a DM: another DM with the same bot.

  Parameters

  • userId: string
  • Optionalopts: { displayName?: string }

  Returns TestChat