@apidog/longpoll
Advanced tools
Comparing version 0.0.2 to 0.0.3
{ | ||
"name": "@apidog/longpoll", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "APIdog LongPoll service and typings", | ||
"main": "dist/index.js", | ||
"types": "dist/index.d.ts", | ||
"files": [ | ||
"/dist", | ||
"/README.md" | ||
], | ||
"type": "module", | ||
@@ -27,3 +31,3 @@ "scripts": { | ||
"devDependencies": { | ||
"@apidog/vk-typings": "git://github.com/APIdogRU/vk-typings.git", | ||
"@apidog/vk-typings": "0.1.2", | ||
"@types/jest": "24.0.23", | ||
@@ -30,0 +34,0 @@ "@types/node": "12.12.14", |
@@ -9,5 +9,3 @@ # @apidog/longpoll | ||
getLongPoll({ | ||
token: process.env.token // токен | ||
}).then(longpoll => { | ||
LongPoll.getInstance(process.env.token).then(longpoll => { | ||
@@ -23,1 +21,23 @@ // Подписка на новое сообщение | ||
``` | ||
# API | ||
## `LongPoll.getInstance(auth: string | VKAPIClient, props?: ILongPollProps)` | ||
Создает "сервис" для получения данных от LongPoll сервера. Возвращает `Promise` с объектом `LongPoll`. | ||
`auth` принимается в двух видах: | ||
* `string` - токен; | ||
* инстанс объекта `VKAPIClient`. | ||
Через `props` можно пробросить некоторые параметры подключения и настройки LongPoll (все они необязательные): | ||
* `versionApi` - версия API, с которой будет получены данные о LongPoll сервере; | ||
* `versionLongPoll` - версия LongPoll; | ||
* `wait` - время (в секундах) ожидания ответа. Максимальное значение - 90; | ||
* `mode` - дополнительные опции ответа. Сумма кодов опций из списка. | ||
Подробную документацию о последних трёх параметрах можно найти [здесь](https://vk.com/dev/using_longpoll). | ||
## `lp.start()` | ||
Начинает пуллинг. | ||
## `lp.isActive()` | ||
Возвращает `true`, если пуллинг включен. | ||
## `lp.stop()` | ||
Останавливает пуллинг и обрывает текущее соединение. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
42
1
26342
12
519