VK Types

VK Types - это библиотека с TypeScript типами для работы с API ВКонтакте.

Версия VK API: 5.142

Установка

$ yarn add -D vk-types

или

$ npm i -D vk-types

Использование

Все типы были разделены на 3 раздела:

• objects - основные объекты
• methods - параметры и ответы методов
• attachments - вложения для сообщений

Импортировать нужные типы можно тремя способами:

1. Через глобальный index.ts:

import {
  VKUser,
  MessagesSend,
  MessagesSendParams,
  VKAttachment,
  VKAttachmentWallReply
} from 'vk-types';

2. Через index.ts в каждом разделе:

import { VKUser } from 'vk-types/objects';
import { MessagesSend, MessagesSendParams } from 'vk-types/methods';
import { VKAttachment, VKAttachmentWallReply } from 'vk-types/attachments';

3. Через сам файл с нужным типом:

import { VKUser } from 'vk-types/objects/VKUser';
import { MessagesSend, MessagesSendParams } from 'vk-types/methods/messages';
import { VKAttachment } from 'vk-types/attachments';
import { VKAttachmentWallReply } from 'vk-types/attachments/WallReply';

Поддерживаемые типы

На данный момент поддерживается довольно мало типов, но вы всегда можете помочь нам с их написанием.

Объекты

Папка с объектами

• VKConversation - беседа
• VKConversationPushSettings - настройки уведомлений беседы
• VKGroup - сообщество
• VKImage - фотография
• VKKeyboard - клавиатура
• VKLike - лайки
• VKMessage - сообщения
• VKUser - пользователь

Методы

Папка с методами

account

• account.getCounters
• account.getPushSettings

messages

• messages.delete
• messages.getById
• messages.getConversationMembers
• messages.getConversationsById
• messages.getLongPollHistory
• messages.getLongPollServer
• messages.send

Вложения

Папка с вложениями

• Geo
• Wall
• WallReply

Contributing

Вы всегда можете помочь проекту: добавить новое поле, изменить его описание или тип, или вовсе добавить новый объект, метод или вложение.

Сделать это можно, создав Pull Request в репозитории. Там мы проверим изменения, возможно внесем некоторые правки и примем их.