Code Monkey home page Code Monkey logo

scriptogram's Introduction

logo

Scriptogram

Библиотека для интеграции с Telegram Bot API, написанная на TypeScript.
Описание типов и методов полностью переведено на русский.

Установка

Утановка библиотеки доступна через npm:

npm i scriptogram

Примеры

В каталоге examples находятся примеры использования библиотеки.

Создание бота:
// импорт класса бота
import { Scriptogram } from "scriptogram";

// создание экземпляра бота
const bot = new Scriptogram("token");

// логика работы бота
// ...

// запуск цикла обработки обновлений
bot.startUpdate();

token необходимо получить у BotFather.

Обработка команд (command handler):
// на введенную пользователем комманду /hello бот ответит "Привет!"
bot.onCommand("/hello", async (update: IUpdate) => {
  // через метод sendMessage осуществляется отправка сообщения ботом
  await bot.MethodHandler.sendMessage({
    chat_id: update?.message?.from?.id!,
    text: "Привет!",
  });
});
Обработка сообщений и колбеков (update handler):
// на сообщение или колбек бот ответит "Понятно"
bot.onUpdate(async (update: IUpdate) => {
  // логика обработки сообщений или колбеков
  // ...

  await bot.MethodHandler.sendMessage({
    chat_id: update?.message?.from?.id!,
    text: "Понятно",
  });
});
Промежуточная обработка (middleware):
// выполняется до обработки команд, сообщений или колбеков
// например, чтобы проверить права доступа у пользователя
bot.use(async (update: IUpdate) => {
  if ("условие проверки") {
    await bot.MethodHandler.sendMessage({
      chat_id: update?.message?.from?.id!,
      text: "Доступ получен",
    });
    return false;
  }
  return true;
});
Обработчики событий (handlers)

Для работы с обработчиками событий необходимо реализовать класс обработчика, реализующий интерфейс IHandler. Реализация обработчика сообщений - пример. Реализация обработчика клавиатуры - пример.

После чего добавить обработчики в бота:

bot.setHandler(new MessageHandler(state));
bot.setHandler(new KeyboardHandler());
Состояние (state)

Для работы с состоянием бота необходимо реализовать класс состояния (пример), после чего добавить его в бота:

// State - кастомный класс для работы с состоянием бота
var state = new State();
bot.setState(state);

Лицензия

Эта библиотека доступна по лицензии MIT. Файл LICENSE для подробностей.

scriptogram's People

Contributors

moxhatka avatar avirtan avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.