vk-streaming-api v0.1.0
vk-streaming-api - это Node.js модуль для взаимодействия с VK Streaming API
Установка
NPM
npm install vk-streaming-api --saveYarn
yarn add vk-streaming-apiЗависимости
Инициализация
import VKStreamingAPI from 'vk-streaming-api'
const vkStreaming = new VKStreamingAPI(options)| Параметр | Тип | Описание |
|---|---|---|
| options | object | Параметры |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| onOpen | function | Коллбэк, вызывающийся при открытии соединения websocket |
| onMessage | function | Коллбэк, вызывающийся при получении данных по websocket |
| onServiceMessage | function | Коллбэк, вызывающийся при получении сервисных сообщений по websocket |
| onError | function | Коллбэк, вызывающийся при получении ошибки по websocket |
| onClose | function | Коллбэк, вызывающийся при зыкрытии соединения websocket |
| serviceKey | string | Сервисный ключ доступа (access_token) |
| apiVersion | number | Версия VKontakte API |
| rules | array | Список правил, которые должны быть добавлены в поток |
Все параметры опциональны, за исключением serviceKey.
Список поддерживаемых методов
authorize()
Возвращает Promise, который будет разрешен со значением null в успешном случае, иначе отклонен с ошибкой (например, если параметр serviceKey не был передан при инициализации).
addRules([rules])
Последовательно добавляет правила в поток. Будет отклонен с ошибкой если правила не были переданы ни при инициализации, ни в качестве параметра при вызове.
addRule(rule)
Добавляет правило в поток.
getRules()
Получает список правил, добавленных в поток.
getRule(tag)
Получает правило по его тэгу.
deleteRules
Удаляет все правила из потока. Удаление происходит последовательно.
deleteRule(tag)
Удаляет правило из потока по его тэгу.
getStream()
Устанавливает соединение для получения данных и возвращает объект WebSocket.
Пример использования
Promise
.bind(vkStreaming)
.then(vkStreaming.authorize)
.then(vkStreaming.deleteRules)
.then(vkStreaming.addRules)
.then(vkStreaming.getRules)
.then(vkStreaming.getStream)
.then((stream) => {
// do something with stream
}).catch((err) => {
// error handling
})Логирование
Для того что бы получать данные логирования в консоль, необходимо установить переменную окружения DEBUG
DEBUG=vk-streaming-api:*Обратная связь
По всем вопросам/замечаниям/предложениям прошу написать мне ВКонтакте либо сделать pull request
7 years ago