VK-IO

Appearance

Модули ​

Библиотека разбита на модули, вы можете использовать их по отдельности, главное передать необходимые зависимости.

API ​

Базовый модуль запросов, позволяет вызывать методы API.

ts
import { VK } from 'vk-io';

const vk = new VK({
    token: process.env.TOKEN
});

const users = await vk.api.users.get({
    user_ids: 1
});

Более подробно

Upload ​

Базовый модуль для загрузки, позволяет:

  • Загружать файлы на стену (фото/документ)
  • Загружать фото в альбом
  • Загружать файлы в личные сообщения (фото/документ/граффити/голосовое сообщение)
  • Загружать видео/истории/аудио/документы
  • Устанавливать обложку сообщества
  • Устанавливать главное фото сообщества/пользователя/беседы/товара/опроса
ts
import { VK } from 'vk-io';

const vk = new VK({
    token: process.env.TOKEN
});

const attachment = await vk.upload.messagePhoto({
    peer_id: ...,
    source: {    
        value: './cat.jpeg'
    }
});

Более подробно

Updates ​

Базовый модуль для получения обновлений, поддерживает:

ts
import { VK } from 'vk-io';

const vk = new VK({
    token: process.env.TOKEN
});

vk.updates.on('message_new', async (context) => {
    if (context.text === 'Привет') {
        await context.send('Привет!');
    }
});

await vk.updates.start();

Более подробно

Collect ​

Базовый модуль для работы с коллекциями, позволяет:

  • Вызывать множество однотипных методов через execute
  • Цепочка вызовов с контролируемым результатом запроса через execute
  • Итератор сбора данных с методов которые поддерживают limit/offset

Более подробно

Keyboard ​

Базовый модуль для работы с клавиатурой, предоставляет:

  • Абстракцию над структурой клавиатуры
  • Две вариации составления клавиатуры, через сборщик или ручное составление
ts
await api.messages.send({
    message: 'Hey!',
    keyboard: Keyboard.builder()
        .urlButton({
            label: 'View on site',
            url: 'https://coffee.mania/view/coffee'
        })
        .callbackButton({
            label: 'Buy a coffee',
            payload: {
                command: 'buy',
                item: 'coffee'
            }
        })
        .row()
        .textButton({
            label: 'Back to the menu',
            payload: {
                command: 'menu'
            }
        })
});

Более подробно

Utils ​

Базовые утилиты