Module @mtcute/dispatcher

@mtcute/dispatcher

📖 API Reference 🧐 Guide

Dispatcher and bot framework based on @mtcute/core.

  • Straightforward: Simple and expressive API
  • State: Supports storing state for each chat
  • Filters: Powerful and easy-to-use filtering system
  • Middleware: Basic middleware support for updates
  • Scenes: Built-in support for scenes
import { Dispatcher } from '@mtcute/dispatcher'

const tg = new TelegramClient({ ... })
const dp = Dispatcher.for(tg)

dp.onNewMessage(async (msg) => {
await msg.replyText('Hello world!')
})

Namespaces

filters

Enumerations

PropagationAction
WizardSceneAction

Classes

BusinessCallbackQueryContext
BusinessMessageContext
CallbackDataBuilder
CallbackQueryContext
ChatJoinRequestUpdateContext
ChosenInlineResultContext
Dispatcher
InlineCallbackQueryContext
InlineQueryContext
MemoryStateStorage
MessageContext
PreCheckoutQueryContext
RateLimitError
SqliteStateStorage
UpdateState
WizardScene

Interfaces

BaseUpdateHandler
DispatcherDependencies
DispatcherParams
IStateRepository

Type Aliases

BotChatJoinRequestHandler
BotReactionCountUpdateHandler
BotReactionUpdateHandler
BotStoppedHandler
BusinessCallbackQueryHandler
BusinessConnectionUpdateHandler
BusinessMessageGroupHandler
CallbackQueryHandler
ChatJoinRequestHandler
ChatMemberUpdateHandler
ChosenInlineResultHandler
DeleteBusinessMessageHandler
DeleteMessageHandler
DeleteStoryHandler
EditBusinessMessageHandler
EditMessageHandler
HistoryReadHandler
InlineCallbackQueryHandler
InlineQueryHandler
IStateStorageProvider
MessageGroupHandler
NewBusinessMessageHandler
NewMessageHandler
ParsedUpdateHandler
PollUpdateHandler
PollVoteHandler
PreCheckoutQueryHandler
RawUpdateHandler
StateKeyDelegate
StoryUpdateHandler
UpdateContext
UpdateContextDistributed
UpdateContextType
UpdateHandler
UserStatusUpdateHandler
UserTypingHandler

Functions

defaultStateKeyDelegate

References

UpdateFilter → filters.UpdateFilter