Properties
streaming?
capabilities.streaming). 'edit' also exposes
editMessage (recorded in edits); 'draft' exposes sendDraft (recorded in
drafts) and editMessage. Default 'none' (no edit, no drafts).
maxTextLength?
capabilities.maxTextLength to simulate. Default: unset.
maxTextBytes?
capabilities.maxTextBytes (UTF-8) to simulate. Default: unset.
textFormat?
capabilities.textFormat to simulate (e.g. 'whatsapp'). Default: unset.
buttons?
capabilities.buttons and the 'buttons' content
kind). false simulates a channel without them (Baileys, SMS…). Default true.
textFormatFor?
IProvider.textFormatFor), e.g. a provider that
serves WhatsApp and SMS chats. Default: unset (the mock has no textFormatFor).
Parameters
Returns
TextFormat | undefined
supports?
undefined), so the bot treats it exactly like a provider that
lacks the method. Defaults follow streaming: edit and delete when it is not
'none', drafts when it is 'draft'. When left unset, a subclass’s own
override of the method is never hidden; an explicit false hides it too.
exclusiveSession?
capabilities.exclusiveSession to simulate: a transport that allows one live
connection (Baileys). Multi-replica coordination then starts the mock on the elected
replica only. Default: unset.
maxJournal?
10000, Infinity disables the cap). outbox is never capped.
interactionsRequireAck?
capabilities.interactionsRequireAck to simulate (Discord): the bot then acknowledges
every interaction on its own (see ctx.acknowledge()). Default false.