libtelegram v0.1.18

LibTelegram

Modern Library for Telegram Bots Api 🤖

Installation

$ npm install libtelegram

Example:

const telegram = require('libtelegram')(<TOKEN>);

telegram.hear('menu', '/start', (msg, next) => {
    telegram.sendMessage({ id:msg.from.id, text: '1st step' });

    next();
}).folow((msg, next, prev, quit) => {
    telegram.sendMessage({ id:msg.from.id, text: '2nd step' });
    
    next();
}).folow((msg, next, prev, quit) => {
    telegram.sendMessage({ id:msg.from.id, text: '3rd step' });
    
    quit();
}).folow((msg, next, prev, quit) => {
    telegram.sendMessage({ id:msg.from.id, text: '4th step' });
    
    prev();
});

telegram.startPolling();

Classes

Telegram

Kind: global class

• Telegram
  • new Telegram(token)
  • .use(callback) ⇒ Null
  • .getUserByID(id) ⇒ User
  • .hear(name, condition, callback) ⇒ Event
  • .createUser(params) ⇒ User
  • .startPolling(interval) ⇒ Null
  • .webhookCallback(path) ⇒ function
  • .startWebhook(path, tls, port) ⇒ Null

new Telegram(token)

Init Telegram class

telegram.use(callback) ⇒ Null

Middleware allows you to modify requests and responses as they pass between the Telegram and your bot.

Kind: instance method of Telegram

telegram.getUserByID(id) ⇒ User

Getting User by ID

Kind: instance method of Telegram

telegram.hear(name, condition, callback) ⇒ Event

Event creation

Kind: instance method of Telegram

telegram.createUser(params) ⇒ User

User creation

Kind: instance method of Telegram

telegram.startPolling(interval) ⇒ Null

Start polling

Kind: instance method of Telegram

telegram.webhookCallback(path) ⇒ function

Use webhookCallback() if you want to attach libtelegram to existing http server

Kind: instance method of Telegram

telegram.startWebhook(path, tls, port) ⇒ Null

Start receiving messages from webhook

Kind: instance method of Telegram

Event

Kind: global class

• Event
  • new Event(name, condition, firstStep)
  • .condition(message) ⇒ Boolean
  • .folow(callback) ⇒ Event

new Event(name, condition, firstStep)

Init Event

event.condition(message) ⇒ Boolean

Checks if a message matches the condition

Kind: instance method of Event

event.folow(callback) ⇒ Event

Creates a new step in the event stack

Kind: instance method of Event

User

Kind: global class
Params: object - Often used values

new User()

Containing user state and offten used values