# vk-fast-longpoll

> VK Lib for better performance

Latest version **2.1.19** (published 2018-02-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install vk-fast-longpoll
pnpm add vk-fast-longpoll
yarn add vk-fast-longpoll
bun add vk-fast-longpoll
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.19 |
| Published | 2018-02-06 |
| First published | 2017-03-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Eugene Pogrebnyak |
| Maintainers | tuxick |
| Keywords | vk, longpoll, bot, vk-api, vk-app, vkontakte, vk-bot, vkbot, vkontakte-sdk, vkontakte-api, vkontakte-client, vkapi, bots |

## Links

- npm: https://www.npmjs.com/package/vk-fast-longpoll
- Repository: https://github.com/emcifuntik/vk-fast-longpoll
- Homepage: https://github.com/emcifuntik/vk-fast-longpoll#readme
- Issues: https://github.com/emcifuntik/vk-fast-longpoll/issues/new
- npm.io page: https://npm.io/package/vk-fast-longpoll

## Dependencies (4)

- [request](https://npm.io/package/request.md) ^2.81.0
- [winston](https://npm.io/package/winston.md) ^2.3.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0
- [file-type](https://npm.io/package/file-type.md) ^4.1.0

## Recent versions

- 2.1.19 (latest) — 2018-02-06
- 2.1.18 — 2017-08-03
- 2.1.17 — 2017-08-03
- 2.1.16 — 2017-08-03
- 2.1.15 — 2017-08-03
- 2.1.14 — 2017-06-19
- 2.1.13 — 2017-06-18
- 2.1.12 — 2017-05-30
- 2.1.11 — 2017-05-25
- 2.1.10 — 2017-05-21
- 2.1.9 — 2017-04-28
- 2.1.8 — 2017-04-02
- 2.1.7 — 2017-04-01
- 2.1.6 — 2017-04-01
- 2.1.5 — 2017-03-31
- … 45 more at https://npm.io/package/vk-fast-longpoll/versions

## README

# vk-fast-longpoll
> RU | Мощный инструмент для работы с VK API, который работает в 25 раз быстрее обычных вызовов API методов.

> EN | Powerfull tool for VK api that works 25 times faster then usual api calls

[![NPM version](https://img.shields.io/npm/v/vk-fast-longpoll.svg)](https://www.npmjs.com/package/vk-fast-longpoll)
[![NPM downloads](https://img.shields.io/npm/dt/vk-fast-longpoll.svg)](https://www.npmjs.com/package/vk-fast-longpoll)

# Русский
## Установка и начало работы
### Установка
```shell
npm install vk-fast-longpoll --save
```
### Инициализация
```javascript
const VK = require('vk-fast-longpoll');
const group = new VK('token here');
```
### Запуск longpoll соединения
```javascript
group.longpoll.start();
```
### Начинаем слушать сообщения
```javascript
group.longpoll.on('message', (message) => {
    if(!message.isOutbox)
    {
        //Отвечаем на сообщение
    }
});
```
### Вызов API методов
Все методы VK должны вызываться с префиксом api например
```javascript
group.api.messages.send({user_id: 1, message: 'Привет, Паша'});
```
Методы возвращают Promise-ы, поэтому стоит добавлять обработчик ошибок к каждому вызову.
```javascript
group.api.messages.send({user_id: 1, message: 'Привет, Паша'}).catch(console.error);
```
Все названия методов, а также названия полей полностью соответсвуют названиям из [документации VK](https://vk.com/dev/methods)

### Echo пример
```javascript
const VK = require('vk-fast-longpoll');
const group = new VK('token here');

group.longpoll.start();

group.longpoll.on('message', (message) => {
    if(!message.isOutbox)
    {
        group.api.messages.send({user_id: message.sender, message: message.text}).then(() => {
            console.log(message.text);
        }).catch(console.error);
    }
});
```

### Загрузка файлов
```javascript
//В разработке
```

# English
## Installing and getting started
### Installing
```shell
npm install vk-fast-longpoll --save
```
### Initializing
```javascript
const VK = require('vk-fast-longpoll');
const group = new VK('token here');
```
### Longpoll connection start
```javascript
group.longpoll.start();
```
### Listen to messages
```javascript
group.longpoll.on('message', (message) => {
    if(!message.isOutbox)
    {
        //Reply message
    }
});
```
### API method calls
All VK Api methods must be called with `api` prefix
```javascript
group.api.messages.send({user_id: 1, message: 'Hello, Pasha'});
```
All methods return Promises, therefor you need to catch errors in every api call.
```javascript
group.api.messages.send({user_id: 1, message: 'Hello, Pasha'}).catch(console.error);
```
All methods names and fields names are equal as [VK Api docs](https://vk.com/dev/methods)

### Echo example
```javascript
const VK = require('vk-fast-longpoll');
const group = new VK('token here');

group.longpoll.start();

group.longpoll.on('message', (message) => {
    if(!message.isOutbox)
    {
        group.api.messages.send({user_id: message.sender, message: message.text}).then(() => {
            console.log(message.text);
        }).catch(console.error);
    }
});
```

### File uploading
```javascript
//In development
```

---
_Source: https://npm.io/package/vk-fast-longpoll · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._