Class CrashableProvider

Readonlyid

Readonlycapabilities

selfId

outbox

journal

edits

drafts

deleted

acks

OptionaltextFormatFor

ReadonlymaxJournal

starts

stops

editMessage

• editMessage(
      ref: MessageRef,
      content: OutboundContent,
  ): Promise<SendResult<unknown>>

  Records the edit in edits. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

  Parameters

  • ref: MessageRef
  • content: OutboundContent

  Returns Promise<SendResult<unknown>>

acknowledgeInteraction

• acknowledgeInteraction(
      interactionId: string,
      opts?: { text?: string; defer?: boolean },
  ): Promise<void>

  Records the ack in acks (button/callback interactions).

  Parameters

  • interactionId: string
  • Optionalopts: { text?: string; defer?: boolean }

  Returns Promise<void>

deleteMessage

• deleteMessage(ref: MessageRef): Promise<void>

  Records the ref in deleted. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

  Parameters

  • ref: MessageRef

  Returns Promise<void>

sendDraft

• sendDraft(
      chatId: string,
      draftId: number,
      text: string,
      opts?: DraftOptions,
  ): Promise<void>

  Records the draft in drafts. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

  Parameters

  • chatId: string
  • draftId: number
  • text: string
  • Optionalopts: DraftOptions

  Returns Promise<void>

stopDraft

• stopDraft(): boolean

  Simulate the user pressing "stop" on the latest draft that offered it.

  Returns boolean

start

• start(): Promise<void>

  Returns Promise<void>

stop

• stop(): Promise<void>

  Returns Promise<void>

onEvent

• onEvent(listener: (e: InboundEvent) => void | Promise<void>): () => void

  Subscribe to the normalized event stream. Returns an unsubscriber.

  Parameters

  • listener: (e: InboundEvent) => void | Promise<void>

  Returns () => void

downloadMedia

• downloadMedia(ref?: MediaRef): Promise<Buffer<ArrayBufferLike>>

  Bytes of a simulated media: a copy of the bytes behind the ref (incomingMedia, chat.sendMedia); an empty buffer for a legacy token: null ref (incoming(text, { type: 'image' })). A { url } token without bytes rejects with MediaUnavailableError — the mock never touches the network.

  Parameters

  • Optionalref: MediaRef

  Returns Promise<Buffer<ArrayBufferLike>>

clearJournal

• clearJournal(): void

  Forget the journal (the seq counter keeps growing; outbox is untouched).

  Returns void

incoming

• incoming(text: string, opts?: MockIncomingOptions): void

  Simulate an incoming message.

  Parameters

  • text: string
  • opts: MockIncomingOptions = {}

  Returns void

incomingMedia

• incomingMedia(
      kind:
          | "image"
          | "video"
          | "audio"
          | "voice"
          | "document"
          | "sticker"
          | "location"
          | "contact",
      source: MockMediaSource,
      opts?: MockIncomingOptions & MockMediaOptions,
  ): void

  Simulate an inbound media message (type: kind, body = caption). source bytes are what downloadMedia returns; { url } alone is metadata only, and the download then rejects with MediaUnavailableError.

  Parameters

  • kind:
        | "image"
        | "video"
        | "audio"
        | "voice"
        | "document"
        | "sticker"
        | "location"
        | "contact"
  • source: MockMediaSource
  • opts: MockIncomingOptions & MockMediaOptions = {}

  Returns void

incomingLocation

• incomingLocation(
      location: InboundLocation,
      opts?: Omit<MockIncomingOptions, "location" | "type">,
  ): void

  Simulate a shared location (type: 'location', ctx.sharedLocation). The body is the place name, else the address, else '' — as the real providers set it.

  Parameters

  • location: InboundLocation
  • opts: Omit<MockIncomingOptions, "location" | "type"> = {}

  Returns void

interaction

• interaction(data: string, opts?: MockIncomingOptions): void

  Simulate a UI interaction (button/list row/slash command; kind defaults to 'button').

  Parameters

  • data: string
  • opts: MockIncomingOptions = {}

  Returns void

reaction

• reaction(
      emoji: string,
      opts: { to: MessageRef; from?: string; sender?: string; removed?: boolean },
  ): void

  Simulate a reaction to a message (bot.on('reaction'), 'reaction' hooks). to is the reacted message; the sender defaults to from (the chat), as in a DM.

  Parameters

  • emoji: string
  • opts: { to: MessageRef; from?: string; sender?: string; removed?: boolean }

  Returns void

call

• call(opts?: Partial<CallEvent>): void

  Simulate an inbound call notification (what bot.on('call') and the CALL trigger receive). Reuse the same id to emit later updates of one call. For a group call pass chatId (the group) and isGroup: true; from is the caller.

  Parameters

  • opts: Partial<CallEvent> = {}

  Returns void