mirror of https://github.com/lukaszraczylo/go-telegram.git synced 2026-06-05 22:43:59 +00:00

Files

T

lukaszraczylo 607c3e8ddd test(bench): cross-library benchmarks vs top 5 go telegram libraries

Adds test/benchmarks/ as a separate Go module so competitor deps
(go-telegram-bot-api/v5, telebot.v3, go-telegram/bot, telego,
echotron/v3) stay out of the root go.mod.

Hot paths covered:
  - Webhook decode  (small Update -> typed Update struct)
  - Large unmarshal (Update with entities + reply markup + photo array)
  - API round-trip  (sendMessage against httptest.Server)
  - Dispatch route  (20 handlers, last-registered matches)

Results on Apple M4 Max / go1.26.2: ours wins 3 of 4 paths and is
2nd of 5 in the round-trip path. Full report at
docs/benchmarks/2026-05-10-comparison.md, raw output committed under
test/benchmarks/results/.

Caveats called out in the report:
  - codec asymmetry (we ship goccy/go-json; competitors mostly stdlib)
  - echotron call bench skipped — built-in rate limiter not externally
    configurable; would measure throttling, not the library
  - dispatch bench limited to libs with a public sync entry point
    (ours, telebot, gobot); gotba has no dispatcher, telego/echotron
    use channel/per-chat paradigms not directly comparable

Also gitignores docs/superpowers/ (local brainstorm/spec scratch)
and regenerates docs/reference/dispatch.md after the new
Router.Process method.

2026-05-10 21:52:00 +01:00

dispatch

fix(api): generate CallRaw + per-element decode for []<union> returns

2026-05-09 18:57:54 +01:00

api.md

docs(reference): regenerate after typed-allowed-updates merge

2026-05-09 21:19:09 +01:00

client.md

docs(reference): regenerate after perf series

2026-05-10 02:57:25 +01:00

dispatch.md

test(bench): cross-library benchmarks vs top 5 go telegram libraries

2026-05-10 21:52:00 +01:00

README.md

docs: auto-generate markdown reference + soften README

2026-05-09 14:14:37 +01:00

transport.md

docs(reference): regenerate after perf series

2026-05-10 02:57:25 +01:00

README.md

API Reference

Auto-generated from Go source comments by gomarkdoc. Do not edit by hand — run make docs to regenerate.

Packages

Package	Description
`api`	Telegram Bot API types and method wrappers — 176 methods, 301 types, fully generated
`client`	Bot client, codec, HTTP doer, retry middleware
`transport`	Long-poll and webhook transports
`dispatch`	Update router, filters, handler groups, named handlers
`dispatch/conversation`	Multi-step conversation state machines
`dispatch/filters/message`	Message filters — `Command`, `Text`, `IsReply`, etc.
`dispatch/filters/callback`	Callback query filters
`dispatch/filters/inline`	Inline query filters
`dispatch/filters/chatmember`	Chat member update filters
`dispatch/filters/chatjoinrequest`	Join request filters
`dispatch/filters/precheckoutquery`	Pre-checkout filters for payments

Also see

Project home — landing page with examples and overview
GitHub repository
pkg.go.dev — official Go package documentation