Class TelegramBot

constructor

• new TelegramBot(
      token: string,
      options?: { defaultCommand?: string },
  ): TelegramBot

  Create a bot

  Parameters

  • token: string

    the telegram secret token

  • Optionaloptions: { defaultCommand?: string }

    optional configuration for the bot

  Returns TelegramBot

api

commands

currentContext

defaultCommand

middleware

token

update

webhook

command

• command(
      commandName: string,
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register a command handler

  Parameters

  • commandName: string

    the command name (without /)

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the handler function

  Returns TelegramBot

handle

• handle(request: Request): Promise<Response>

  Handle a request on a given bot

  Parameters

  • request: Request

    the request to handle

  Returns Promise<Response>

on

• on(
      event: string,
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register a function on the bot

  Parameters

  • event: string

    the event or command name

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the bot context

  Returns TelegramBot

onCallback

• onCallback(
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register a callback query handler

  Parameters

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the handler function

  Returns TelegramBot

onMessage

• onMessage(
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register a message handler

  Parameters

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the handler function

  Returns TelegramBot

onPhoto

• onPhoto(
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register a photo handler

  Parameters

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the handler function

  Returns TelegramBot

registerHandlers

• registerHandlers(
      handlers: Record<
          string,
          (ctx: TelegramExecutionContext) => Promise<Response | void>,
      >,
  ): TelegramBot

  Register multiple command handlers at once

  Parameters

  • handlers: Record<string, (ctx: TelegramExecutionContext) => Promise<Response | void>>

    object mapping command names to handler functions

  Returns TelegramBot

use

• use(
      callback: (ctx: TelegramExecutionContext) => Promise<void | Response>,
  ): TelegramBot

  Register middleware to run before all handlers

  Parameters

  • callback: (ctx: TelegramExecutionContext) => Promise<void | Response>

    the middleware function

  Returns TelegramBot