FILE / ScuroNeko/Laniakea
doc.go
Исходный файл и его история в репозитории.
ScuroNeko
d55f58c092
Share queue and runner lifecycle between polling and webhook Keep Close() local-only and harden webhook startup validation Document runtime transitions and add webhook regression tests
34 lines
1.2 KiB
Go
34 lines
1.2 KiB
Go
/*
|
|
Package laniakea provides a modular, extensible framework for building scalable Telegram bots.
|
|
|
|
Core concepts:
|
|
|
|
- Bot manages Telegram API access, update processing, logging, rate limiting, and dependency injection.
|
|
- Plugins group commands, payloads, and non-command update handlers behind shared middleware.
|
|
- MsgContext provides access to the current update and reply/edit/delete helpers.
|
|
- InlineKeyboard builds callback-driven keyboards and structured payloads.
|
|
- DraftProvider accumulates multi-step replies before sending them.
|
|
- L10n stores key-based translations with fallback behavior.
|
|
- Runners execute startup or background tasks alongside the polling loop.
|
|
|
|
Example usage:
|
|
|
|
bot, err := laniakea.NewBot[*mydb.AppData](laniakea.LoadOptsFromEnv())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
bot.SetAppData(myDB).
|
|
AddUpdateType(tgapi.UpdateTypeMessage).
|
|
AddPrefixes("/", "!").
|
|
AddPlugins(&startPlugin, &helpPlugin).
|
|
AddMiddleware(authMiddleware, logMiddleware).
|
|
AddRunner(cleanupRunner).
|
|
SetL10n(l10n.New())
|
|
|
|
return bot.Run()
|
|
|
|
Configure bots, plugins, and localization before starting Run, RunWithContext, or RunWebHookWithContext.
|
|
Runtime accessors are safe for concurrent use unless stated otherwise.
|
|
*/
|
|
package laniakea
|