1 | # node-vk-bot-sdk
|
2 |
|
3 | Небольшое SDK для создания чат-ботов с использованием Node.JS на платформе [сообществ ВКонтакте](https://vk.com/dev/bots_docs).
|
4 |
|
5 | Рекомендуется использовать с версиями API выше [5.103](https://vk.com/dev/versions).
|
6 |
|
7 | ## Установка
|
8 | ```bash
|
9 | $ npm install node-vk-bot-sdk
|
10 | ```
|
11 |
|
12 | ## Возможности
|
13 | * Поддерживает работу с Callback событиями через Express/Koa или LongPoll
|
14 | * Позволяет добавлять слушатели [произвольных событий в сообществе](https://vk.com/dev/groups_events)
|
15 | * Позволяет добавлять обработчики команд в сообщениях через RegExp или строки
|
16 | * Поддерживает работу с присылаемой полезной нагрузкой и данными о клиенте
|
17 | * Поддерживает установку middleware для всех получеемых событий
|
18 | * Поддерживает настройку собственных обработчиков ошибок
|
19 |
|
20 | ## Пример использования
|
21 | ```js
|
22 | const express = require('express');
|
23 | const { VkBotSdk } = require('node-vk-bot-sdk');
|
24 |
|
25 | const app = express();
|
26 |
|
27 | const sdk = new VkBotSdk({
|
28 | group_id: 0,
|
29 | secret: '',
|
30 | confirmation: '',
|
31 | access_token: ''
|
32 | });
|
33 |
|
34 | const bot = sdk.getCallback();
|
35 |
|
36 | bot.command(/test/, (ctx, params) => {
|
37 | ctx.reply(`reply to ${ctx.from_id}`);
|
38 | });
|
39 |
|
40 | bot.defaultReply((ctx, params) => {
|
41 | ctx.reply('Default reply');
|
42 | });
|
43 |
|
44 | app.use(express.json());
|
45 | app.all('/callback', bot.eventsCallback);
|
46 |
|
47 | app.listen(8080);
|
48 | ```
|
49 |
|
50 | [Другие варианты использования](https://github.com/m-vts/node-vk-bot-sdk/tree/master/examples)
|