Class BotRouter

Middleware-capable router for Telegram bot updates, including commands and web_app_data payloads emitted by a Teleforge Mini App.

Index

Constructors

Methods

command handle onHelp onCallbackQuery onStart onWebApp onWebAppData setBot use

Constructors

constructor

new BotRouter(options?: BotRouterOptions): BotRouter
Parameters
- options: BotRouterOptions = {}
Returns BotRouter

Methods

command

command(name: string, handler: CommandHandler): void
Registers a handler for a normalized slash command.
Parameters
- name: string
- handler: CommandHandler
Returns void

handle

handle(update: TelegramUpdate): Promise<void>
Parameters
- update: TelegramUpdate
Returns Promise<void>

onHelp

onHelp(handler: CommandHandler): void
Parameters
- handler: CommandHandler
Returns void

onCallbackQuery

onCallbackQuery(handler: CallbackQueryHandler): void
Parameters
- handler: CallbackQueryHandler
Returns void

onStart

onStart(handler: CommandHandler): void
Parameters
- handler: CommandHandler
Returns void

onWebApp

onWebApp(handler: WebAppHandler): void
Parameters
- handler: WebAppHandler
Returns void

onWebAppData

onWebAppData(handler: WebAppDataHandler): void
Registers a structured handler for Telegram web_app_data payloads.
Parameters
- handler: WebAppDataHandler
Returns void

setBot

setBot(bot: BotInstance): void
Parameters
- bot: BotInstance
Returns void

use

use(middleware: Middleware): void
Parameters
- middleware: Middleware
Returns void