Nestjs telegraf state

The "Nestjs-telegraf-state" library is an extension for the NestJS framework and the Telegraf bot framework, designed to manage states inside scenes and process scripts in Telegram bots.

Key features

• State mechanism inside scenes: The library provides a mechanism for managing states inside Telegram bot scenes. With Nestjs-telegraf-state you can define different states within each scene and store the data associated with each state.

• Scene Utilities: The library provides convenient utilities for working with scenes in Telegram bots. You can define scenes, switch between them, perform certain actions when entering and exiting a scene.

• Integration with NestJS and Telegraf: The library allows you to easily integrate the state engine and scene utilities into your applications developed using the NestJS framework and the Telegraf bot framework.

Install

1$ npm install nestjs-telegraf-state

Usage

1. Create a entity of your state.

1import { StateEntity } from 'nestjs-telegraf-state'
2
3export interface InitState {
4    title: string
5}
6
7interface State extends InitState {
8    description?: string 
9}
10
11@StateEntity()
12export class MyStateEntity {
13    constructor(private state: State) {}
14    
15    get title(): string {
16        return this.state.title
17    }
18    
19    get description(): string | undefined {
20        return this.state.description
21    }
22}

2. Usage state entity in scene

1import { Scene, InFn, BaseScene, UpdateSceneContextType } from 'nestjs-telegraf-state'
2import { Ctx, SceneEnter } from 'nestjs-telegraf'
3
4@Scene()
5export class MyScene implements BaseScene {
6    static in: InFn<InitState>
7    
8    @SceneEnter()
9    enter(
10        @Ctx() context: UpdateSceneContextType, 
11        @State(MyStateEntity) entity: MyStateEntity
12    ) {
13        context.reply(entity.title)
14    }
15}