telegrambo-polling

1.0.0 • Public • Published

Telegrambo Polling

Plugin for polling telegram service

Installation

You can install telegrambo-polling using npm:

npm install telegrambo-polling

Usage

// bot.js
import telegrambo from 'telegrambo';
import polling  from 'telegrambo-polling';

const bot = telegrambo(process.env.YOU_BOT_TOKEN);
const bot.polling = polling;

// Create echo bot
bot.on('message', (event) => {
  event.sendMessage({
    text: event.message.text
  });
});

Using with own options:

bot.poliing({
  timeout: 60,
  limit: 100,
  offset: 0,
  allowedUpdates: []
});

Or with handler:

bot.poliing({}, async (update, stop) => {
  // stop polling if messaege is "/stop"
  if (update.message.text === '/stop')
    stop();

  // Applaing update to bot
  else
    bot.setUpdate(update);
});

Also, you can skip options:

bot.poliing(async (update, stop) => {
  // update handler code
});

Returns:

  • function: A callback function that get option object:

    • options (object, optional): Parameters for getUpdates method.

    • options.offset (number, optional): The initial offset value for the first API request. Default is 0.

    • options.limit (number, optional): The maximum number of updates to receive per API request. Default is 100.

    • options.timeout (number, optional): The timeout for each API request in seconds. Default is 60 seconds.

    • options.allowedUpdates (Array, optional): An array of allowed update types. Default is an empty array.

    • handler (function, optional): The handler function to call for each update. Has two arguments:

      • update (object): Object of update.

      • stop (function): Function for stop polling.

Package Sidebar

Install

npm i telegrambo-polling

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

5.13 kB

Total Files

4

Last publish

Collaborators

  • headmad