0.1.3 • Published 5 years ago
vk-types v0.1.3
VK Types
VK Types - это библиотека с TypeScript типами для работы с API ВКонтакте.
Версия VK API: 5.142
Установка
$ yarn add -D vk-typesили
$ npm i -D vk-typesИспользование
Все типы были разделены на 3 раздела:
objects- основные объектыmethods- параметры и ответы методовattachments- вложения для сообщений
Импортировать нужные типы можно тремя способами:
- Через глобальный
index.ts:
import {
VKUser,
MessagesSend,
MessagesSendParams,
VKAttachment,
VKAttachmentWallReply
} from 'vk-types';- Через
index.tsв каждом разделе:
import { VKUser } from 'vk-types/objects';
import { MessagesSend, MessagesSendParams } from 'vk-types/methods';
import { VKAttachment, VKAttachmentWallReply } from 'vk-types/attachments';- Через сам файл с нужным типом:
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.getCountersaccount.getPushSettings
messages
messages.deletemessages.getByIdmessages.getConversationMembersmessages.getConversationsByIdmessages.getLongPollHistorymessages.getLongPollServermessages.send
Вложения
GeoWallWallReply
Contributing
Вы всегда можете помочь проекту: добавить новое поле, изменить его описание или тип, или вовсе добавить новый объект, метод или вложение.
Сделать это можно, создав Pull Request в репозитории. Там мы проверим изменения, возможно внесем некоторые правки и примем их.