[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 [circleci-url]: https://circleci.com/gh/nestjs/nestA progressive Node.js framework for building efficient and scalable server-side applications.
## Description [Telegraf](https://github.com/telegraf/telegraf) module for [NestJS](https://github.com/nestjs/nest). ## Installation ```bash $ npm i nestjs-telegraf ``` Once the installation process is complete, we can import the TelegrafModule into the root AppModule. ```typescript /* app.module.ts */ import { Module } from '@nestjs/common'; import { TelegrafModule } from 'nestjs-telegraf'; @Module({ imports: [ TelegrafModule.forRoot({ token: 'TELEGRAM_BOT_TOKEN', }) ], }) export class AppModule {} ``` The `forRoot()` method accepts the same configuration object as Telegraf class constructor from the Telegraf package, as described [here](https://telegraf.js.org/#/?id=constructor). ## Telegraf methods Each Telegraf instance method described [here](https://telegraf.js.org/#/?id=telegraf) has own decorator in `nestjs-telegraf` package. The name of the decorator corresponds to the name of the Telegraf method and starts with `Telegraf`. For example [`@TelegrafHears`](https://telegraf.js.org/#/?id=hears), [`@TelegrafOn`](https://telegraf.js.org/#/?id=on), [`@TelegrafAction`](https://telegraf.js.org/#/?id=action) and so on. Now let's try to repeat the example from the Telegraf [documentation page](https://telegraf.js.org/#/?id=example). ```typescript /* app.service.ts */ import { Injectable } from '@nestjs/common'; import { TelegrafStart, TelegrafHelp, TelegrafOn, TelegrafHears, Context, } from 'nestjs-telegraf'; @Injectable() export class AppService { @TelegrafStart() start(ctx: Context) { ctx.reply('Welcome'); } @TelegrafHelp() help(ctx: Context) { ctx.reply('Send me a sticker'); } @TelegrafOn('sticker') on(ctx: Context) { ctx.reply('👍'); } @TelegrafHears('hi') hears(ctx: Context) { ctx.reply('Hey there'); } } ``` ## Bot injection At times you may need to access the native `Telegraf` instance. For example, you may want to connect stage middleware. You can inject the Telegraf by using the `@InjectBot()` decorator as follows: ```typescript import { Injectable } from '@nestjs/common'; import { InjectBot, TelegrafProvider } from 'nestjs-telegraf'; @Injectable() export class BotSettingsService { constructor(@InjectBot() private bot: TelegrafProvider) {} } ``` ## Async configuration When you need to pass module options asynchronously instead of statically, use the forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration. One technique is to use a factory function: ```typescript TelegrafModule.forRootAsync({ useFactory: () => ({ token: 'TELEGRAM_BOT_TOKEN', }), }); ``` Like other [factory providers](https://docs.nestjs.com/fundamentals/custom-providers#factory-providers-usefactory), our factory function can be async and can inject dependencies through inject. ```typescript TelegrafModule.forRootAsync({ imports: [ConfigModule.forFeature(telegrafModuleConfig)], useFactory: async (configService: ConfigService) => ({ token: configService.getEldar Salimzebarov 🐛 🤔 |
Vito Macchia 💻 🐛 🤔 |
KITAHARA SETSUNA 💻 🐛 |
Aleksandr Bukhalo 💼 💻 📖 💡 🤔 🚇 🚧 📆 💬 👀 ✅ |
Vyacheslav Saloid 💬 🐛 |