\n\n\n\n> **Fork notice.** `telegramma` is a maintained fork of [Telegraf](https://github.com/telegraf/telegraf), published as **`@anysk/telegramma`**. It tracks the latest **Telegram Bot API (v10.3)** by depending on [`@anysk/telegramma-types`](https://github.com/AnySk/telegramma-types) and adding the corresponding API methods (ephemeral messages, rich messages, live photos, guest mode, poll media, join-request queries, etc.). The public API is otherwise unchanged from Telegraf v4.\n\n\n## Introduction\n\nBots are special [Telegram](https://telegram.org) accounts designed to handle messages automatically.\nUsers can interact with bots by sending them command messages in private or group chats.\nThese accounts serve as an interface for code running somewhere on your server.\n\nTelegraf is a library that makes it simple for you to develop your own Telegram bots using JavaScript or [TypeScript](https://www.typescriptlang.org/).\n\n### Features\n\n- Full [Telegram Bot API 10.3](https://core.telegram.org/bots/api) support\n- [Excellent TypeScript typings](https://github.com/AnySk/telegramma-types)\n- [Lightweight](https://packagephobia.com/result?p=@anysk/telegramma)\n- [AWS **λ**](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html)\n / [Firebase](https://firebase.google.com/products/functions/)\n / [Glitch](https://glitch.com/edit/#!/dashing-light)\n / [Fly.io](https://fly.io/docs/languages-and-frameworks/node)\n / Whatever ready\n- `http/https/fastify/Connect.js/express.js` compatible webhooks\n- Extensible\n\n### Example\n\n```js\nconst { Telegraf } = require('@anysk/telegramma')\nconst { message } = require('@anysk/telegramma/filters')\n\nconst bot = new Telegraf(process.env.BOT_TOKEN)\nbot.start((ctx) => ctx.reply('Welcome'))\nbot.help((ctx) => ctx.reply('Send me a sticker'))\nbot.on(message('sticker'), (ctx) => ctx.reply('👍'))\nbot.hears('hi', (ctx) => ctx.reply('Hey there'))\nbot.launch()\n\n// Enable graceful stop\nprocess.once('SIGINT', () => bot.stop('SIGINT'))\nprocess.once('SIGTERM', () => bot.stop('SIGTERM'))\n```\n\n```js\nconst { Telegraf } = require('@anysk/telegramma')\n\nconst bot = new Telegraf(process.env.BOT_TOKEN)\nbot.command('oldschool', (ctx) => ctx.reply('Hello'))\nbot.command('hipster', Telegraf.reply('λ'))\nbot.launch()\n\n// Enable graceful stop\nprocess.once('SIGINT', () => bot.stop('SIGINT'))\nprocess.once('SIGTERM', () => bot.stop('SIGTERM'))\n```\n\nFor additional bot examples see the new [`docs repo`](https://github.com/feathers-studio/telegraf-docs/).\n\n### Resources\n\n- [Getting started](#getting-started)\n- [API reference](https://telegraf.js.org/modules.html)\n- Telegram groups (sorted by number of members):\n - [English](https://t.me/TelegrafJSChat)\n - [Russian](https://t.me/telegrafjs_ru)\n - [Uzbek](https://t.me/botjs_uz)\n - [Ethiopian](https://t.me/telegraf_et)\n- [GitHub Discussions](https://github.com/telegraf/telegraf/discussions)\n- [Dependent repositories](https://libraries.io/npm/telegraf/dependent_repositories)\n\n## Getting started\n\n### Telegram token\n\nTo use the [Telegram Bot API](https://core.telegram.org/bots/api),\nyou first have to [get a bot account](https://core.telegram.org/bots)\nby [chatting with BotFather](https://core.telegram.org/bots#6-botfather).\n\nBotFather will give you a _token_, something like `123456789:AbCdefGhIJKlmNoPQRsTUVwxyZ`.\n\n### Installation\n\n```shellscript\n$ npm install @anysk/telegramma\n```\n\nor\n\n```shellscript\n$ yarn add @anysk/telegramma\n```\n\nor\n\n```shellscript\n$ pnpm add @anysk/telegramma\n```\n\n### `Telegraf` class\n\n[`Telegraf`] instance represents your bot. It's responsible for obtaining updates and passing them to your handlers.\n\nStart by [listening to commands](https://telegraf.js.org/classes/Telegraf-1.html#command) and [launching](https://telegraf.js.org/classes/Telegraf-1.html#launch) your bot.\n\n### `Context` class\n\n`ctx` you can see in every example is a [`Context`] instance.\n[`Telegraf`] creates one for each incoming update and passes it to your middleware.\nIt contains the `update`, `botInfo`, and `telegram` for making arbitrary Bot API requests,\nas well as shorthand methods and getters.\n\nThis is probably the class you'll be using the most.\n\n\n\n#### Shorthand methods\n\n```js\nimport { Telegraf } from '@anysk/telegramma'\nimport { message } from '@anysk/telegramma/filters'\n\nconst bot = new Telegraf(process.env.BOT_TOKEN)\n\nbot.command('quit', async (ctx) => {\n // Explicit usage\n await ctx.telegram.leaveChat(ctx.message.chat.id)\n\n // Using context shortcut\n await ctx.leaveChat()\n})\n\nbot.on(message('text'), async (ctx) => {\n // Explicit usage\n await ctx.telegram.sendMessage(ctx.message.chat.id, `Hello ${ctx.state.role}`)\n\n // Using context shortcut\n await ctx.reply(`Hello ${ctx.state.role}`)\n})\n\nbot.on('callback_query', async (ctx) => {\n // Explicit usage\n await ctx.telegram.answerCbQuery(ctx.callbackQuery.id)\n\n // Using context shortcut\n await ctx.answerCbQuery()\n})\n\nbot.on('inline_query', async (ctx) => {\n const result = []\n // Explicit usage\n await ctx.telegram.answerInlineQuery(ctx.inlineQuery.id, result)\n\n // Using context shortcut\n await ctx.answerInlineQuery(result)\n})\n\nbot.launch()\n\n// Enable graceful stop\nprocess.once('SIGINT', () => bot.stop('SIGINT'))\nprocess.once('SIGTERM', () => bot.stop('SIGTERM'))\n```\n\n## Production\n\n### Webhooks\n\n```TS\nimport { Telegraf } from \"@anysk/telegramma\";\nimport { message } from '@anysk/telegramma/filters';\n\nconst bot = new Telegraf(token);\n\nbot.on(message(\"text\"), ctx => ctx.reply(\"Hello\"));\n\n// Start webhook via launch method (preferred)\nbot.launch({\n webhook: {\n // Public domain for webhook; e.g.: example.com\n domain: webhookDomain,\n\n // Port to listen on; e.g.: 8080\n port: port,\n\n // Optional path to listen for.\n // `bot.secretPathComponent()` will be used by default\n path: webhookPath,\n\n // Optional secret to be sent back in a header for security.\n // e.g.: `crypto.randomBytes(64).toString(\"hex\")`\n secretToken: randomAlphaNumericString,\n },\n});\n```\n\nUse `createWebhook()` if you want to attach Telegraf to an existing http server.\n\n\n\n```TS\nimport { createServer } from \"http\";\n\ncreateServer(await bot.createWebhook({ domain: \"example.com\" })).listen(3000);\n```\n\n```TS\nimport { createServer } from \"https\";\n\ncreateServer(tlsOptions, await bot.createWebhook({ domain: \"example.com\" })).listen(8443);\n```\n\n- [AWS Lambda example integration](https://github.com/feathers-studio/telegraf-docs/tree/master/examples/functions/aws-lambda)\n- [Google Cloud Functions example integration](https://github.com/feathers-studio/telegraf-docs/blob/master/examples/functions/google-cloud-function.ts)\n- [`express` example integration](https://github.com/feathers-studio/telegraf-docs/blob/master/examples/webhook/express.ts)\n- [`fastify` example integration](https://github.com/feathers-studio/telegraf-docs/blob/master/examples/webhook/fastify.ts)\n- [`koa` example integration](https://github.com/feathers-studio/telegraf-docs/blob/master/examples/webhook/koa.ts)\n- [NestJS framework integration module](https://github.com/bukhalo/nestjs-telegraf)\n- [Cloudflare Workers integration module](https://github.com/Tsuk1ko/cfworker-middware-telegraf)\n- Use [`bot.handleUpdate`](https://telegraf.js.org/classes/Telegraf-1.html#handleupdate) to write new integrations\n\n### Error handling\n\nIf middleware throws an error or times out, Telegraf calls `bot.handleError`. If it rethrows, update source closes, and then the error is printed to console and process terminates. If it does not rethrow, the error is swallowed.\n\nDefault `bot.handleError` always rethrows. You can overwrite it using `bot.catch` if you need to.\n\n⚠️ Swallowing unknown errors might leave the process in invalid state!\n\nℹ️ In production, `systemd` or [`pm2`](https://www.npmjs.com/package/pm2) can restart your bot if it exits for any reason.\n\n## Advanced topics\n\n### Working with files\n\nSupported file sources:\n\n- `Existing file_id`\n- `File path`\n- `Url`\n- `Buffer`\n- `ReadStream`\n\nAlso, you can provide an optional name of a file as `filename` when you send the file.\n\n\n\n```js\nbot.on('message', async (ctx) => {\n // resend existing file by file_id\n await ctx.replyWithSticker('123123jkbhj6b')\n\n // send file\n await ctx.replyWithVideo(Input.fromLocalFile('/path/to/video.mp4'))\n\n // send stream\n await ctx.replyWithVideo(\n Input.fromReadableStream(fs.createReadStream('/path/to/video.mp4'))\n )\n\n // send buffer\n await ctx.replyWithVoice(Input.fromBuffer(Buffer.alloc()))\n\n // send url via Telegram server\n await ctx.replyWithPhoto(Input.fromURL('https://picsum.photos/200/300/'))\n\n // pipe url content\n await ctx.replyWithPhoto(\n Input.fromURLStream('https://picsum.photos/200/300/?random', 'kitten.jpg')\n )\n})\n```\n\n### Middleware\n\nIn addition to `ctx: Context`, each middleware receives `next: () => Promise`.\n\nAs in Koa and some other middleware-based libraries,\n`await next()` will call next middleware and wait for it to finish:\n\n```TS\nimport { Telegraf } from '@anysk/telegramma';\nimport { message } from '@anysk/telegramma/filters';\n\nconst bot = new Telegraf(process.env.BOT_TOKEN);\n\nbot.use(async (ctx, next) => {\n console.time(`Processing update ${ctx.update.update_id}`);\n await next() // runs next middleware\n // runs after next middleware finishes\n console.timeEnd(`Processing update ${ctx.update.update_id}`);\n})\n\nbot.on(message('text'), (ctx) => ctx.reply('Hello World'));\nbot.launch();\n\n// Enable graceful stop\nprocess.once('SIGINT', () => bot.stop('SIGINT'));\nprocess.once('SIGTERM', () => bot.stop('SIGTERM'));\n```\n\nWith this simple ability, you can:\n\n- extract information from updates and then `await next()` to avoid disrupting other middleware,\n- like [`Composer`] and [`Router`], `await next()` for updates you don't wish to handle,\n- like [`session`] and [`Scenes`], [extend the context](#extending-context) by mutating `ctx` before `await next()`,\n- [intercept API calls](https://github.com/telegraf/telegraf/discussions/1267#discussioncomment-254525),\n- reuse [other people's code](https://www.npmjs.com/search?q=telegraf-),\n- do whatever **you** come up with!\n\n[`Telegraf`]: https://telegraf.js.org/classes/Telegraf-1.html\n[`Composer`]: https://telegraf.js.org/classes/Composer.html\n[`Context`]: https://telegraf.js.org/classes/Context.html\n[`Router`]: https://telegraf.js.org/classes/Router.html\n[`session`]: https://telegraf.js.org/modules.html#session\n[`Scenes`]: https://telegraf.js.org/modules/Scenes.html\n\n### Usage with TypeScript\n\nTelegraf is written in TypeScript and therefore ships with declaration files for the entire library.\nMoreover, it includes types for the complete Telegram API via the [`typegram`](https://github.com/KnorpelSenf/typegram) package.\nWhile most types of Telegraf's API surface are self-explanatory, there's some notable things to keep in mind.\n\n#### Extending `Context`\n\nThe exact shape of `ctx` can vary based on the installed middleware.\nSome custom middleware might register properties on the context object that Telegraf is not aware of.\nConsequently, you can change the type of `ctx` to fit your needs in order for you to have proper TypeScript types for your data.\nThis is done through Generics:\n\n```ts\nimport { Context, Telegraf } from '@anysk/telegramma'\n\n// Define your own context type\ninterface MyContext extends Context {\n myProp?: string\n myOtherProp?: number\n}\n\n// Create your bot and tell it about your context type\nconst bot = new Telegraf('SECRET TOKEN')\n\n// Register middleware and launch your bot as usual\nbot.use((ctx, next) => {\n // Yay, `myProp` is now available here as `string | undefined`!\n ctx.myProp = ctx.chat?.first_name?.toUpperCase()\n return next()\n})\n// ...\n```\n","readmeFilename":"README.md"}
![\"Bot](\"https://img.shields.io/badge/Bot%20API-v10.3-f36caf.svg?style=flat-square\"){kind=icon}
\n![\"GitHub](\"https://img.shields.io/github/languages/top/AnySk/telegramma?style=flat-square&logo=github\")
\n