Socket
Book a DemoInstallSign in
Socket

@bot-base/callback-data

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
Package was removed
Sorry, it seems this package was removed from the registry

@bot-base/callback-data

Easy callback data management for Telegram

0.3.0
unpublished
latest
Source
npmnpm
Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

Introduction

Lightweight and simple library that helps manage callback data when using inline buttons in messages

Installation

$ npm install @bot-base/callback-data

or using yarn:

$ yarn add @bot-base/callback-data

Example

import { Telegraf, Markup, Context } from 'telegraf';
import { CallbackData } from '@bot-base/callback-data';

const bot = new Telegraf(process.env.BOT_TOKEN);

const greetingData = new CallbackData<{ type: string; }>(
  'greeting', // namespace identifier
  ['type'] // data properties
);

bot.start((ctx: Context) =>
  ctx.reply('How to greet?', {
    ...Markup.inlineKeyboard([
      Markup.button.callback(
        'oldschool',
        greetingData.create({
          type: 'oldschool',
        })
      ), // callback data is equal to `greeting:oldschool`

      Markup.button.callback(
        'modern',
        greetingData.create({
          type: 'modern',
        })
      ), // callback data is equal to `greeting:modern`
    ]),
  })
);

bot.action(
  greetingData.filter({
    type: 'modern',
  }),
  (ctx) => ctx.answerCbQuery('Yo')
);

bot.action(
  greetingData.filter({
    type: 'oldschool',
  }),
  (ctx) => ctx.answerCbQuery('Hello')
);

bot.launch();

There's some more complex examples: counter and menu.

API Usage Example

exampleCallbackData = new CallbackData(
  'namespace-prefix',
  ['id', 'action' /* many as you want */]
  /* separator = ':' */
);

const callbackData = exampleCallbackData.create({
  id: '1337',
  action: 'show',
});
console.log(callbackData); // namespace-prefix:1337:show

const parsedCallbackData = exampleCallbackData.parse(callbackData);
console.log(parsedCallbackData); // { id: "1337", action: "show" }

const regexpCallbackDataFilter = exampleCallbackData.filter({
  action: 'show',
});
console.log(regexpCallbackDataFilter); // /namespace-prefix:.*:show/

Keywords

telegram

FAQs

Package last updated on 03 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.