VK-Promise
Advanced tools
Модуль для работы с ВКонтакте API и Callback API ВКонтакте.
npm install VK-Promise
var VK = require('VK-Promise'),
vk = new VK('сюда access_token');
// запрос
vk(/*string*/ метод, /*object*/ данные)
.then(/*function*/ on_response)
.catch(/*function*/ on_error);
// Загрузка файла
vk.upload(
/*string*/ метод_получения_сервера,
/*string*/ метод_сохранения_файла,
{
get: {/* данные передаваемые методу получения сервера*/},
save: {/* данные передаваемые методу сохранения файла*/},
files: {/* файлы */
file1: /*string*/ путь_к_файлу,
file2: stream /* необходимо указать stream.filename */,
file3: {filename: имя_файла, buffer: Buffer},
}
}
);
// Получение всего что у чего есть offset
vk.getAll(/*string*/ метод_получения_данных, /*object*/ данные, /*function*/ отслеживание_прогресса)
// Функции
vk.longpoll.start(/*object*/ options); // Запуск получения сообщения через LongPoll
vk.init_execute_cart(/*number*/ интервал_запросов_50_для_групп_или_334); // Запуск пакетной обработки запросов через execute
vk.callback_api.getCallback(/*confirmation res*/, /* pass */); // Получения обработчика для http.createServer
vk.callback_api.setServer(/* opts */); // Поднятие и установка callback api сервера
vk.callback_api.initAllListeners(); // Включает обработку лишний событий в callback api
// Разное
VK.getAttachmentUrl(/*object*/ массив_или_объект_вложений, /*string*/ тип_добавляемы_массиву_вложений); // Получения url из msg.attachments
VK.Array2Object(/*Array*/ array); // [{ key: key, value: value }] => { key: value }
// Авторизация
vk.auth({ username: 'логин', password: 'пароль' })
.then(vk.users.get)
.then(console.log, console.error);
vk.users.get({
user_id: 1 // данные передаваемые API
}).then(function onResponse(res) {
console.log('response',res);
}).catch(function onError(error) {
console.log('Ошибка',error);
});
vk.longpoll.start(); // Запускаем получение сообщений через LongPoll
vk.on('message', function onMessage(event, msg) { // Обрабатываем сообщения
if (msg.body == 'ping') {
// Если текст сообщения равен ping
msg.send('pong'); // Отвечаем pong
}
});
vk.on('captcha', function onCaptcha(event, data) {
console.log('Ссылка на код:', data.captcha_img);
data.submit('Вводим код с картинки');
});
// API метод вызова captcha
vk('captcha.force', {})
var http = require('http');
// Запускаем http сервер на 80 порту с обработкой Callback API
// PS: Сервер в настройках группы нужно вешать вручную
var callback = vk.init_callback_api('Строка, которую должен вернуть сервер', 'secretkey', { group: 123 });
http.createServer(callback).listen(80);
// Включаем оптимизацию через execute
// Собирает все запросы и выполняет пачками раз в 334мс
// 334мс - 3 раза в секунду, стандартное ограничение для юзеров
// Для групп указываем 50
vk.init_execute_cart(50);
// message_new & message_reply объединяет в message
vk.on('message', function onMessage(event, msg) {
msg.send('OK');
event.ok(); // Отвечаем callback api серверу OK
});
// все остальное идет в callback type
// Например если участник вышел из сообщества
vk.on("group_leave", function onUserLeave(event, data) {
console.log("info", data.$);
if (data.self) { // если сам вышел
vk.messages.send({ // Отправляем сообщени
message: 'Ну куда же ты :_(', // текст сообщения
peer_id: data.object.user_id // Кому
});
}
event.ok();
});
// http
http.get('https://fs.flyink.ru/1.png',function(stream){
stream.filename = 'filename.png';
vk.upload(
'docs.getUploadServer',
'docs.save', {
files: { file: stream }
}
).then(function onResponse(r) {
console.log('response', r)
}, console.error);
});
// https
vk.request('https://vk.com/doc-131495752_441571967?api=1')
.then(vk.upload.photos)
.then(console.log, console.error);
// С диска
var fs = require('fs');
vk.upload.doc(fs.createReadStream('/home/user1/test.png'))
.then(console.log, console.error);
var readline = require('readline');
vk.getAll('wall.get', { owner_id: -2158488, count: 100 }, function onProgress(progress) {
readline.clearLine(process.stdout, 0);
readline.cursorTo(process.stdout, 0);
process.stdout.write('Загружено: ' + progress.offset + ' из ' + progress.count);
}).then(function onDone(res) {
readline.clearLine(process.stdout, 0);
readline.cursorTo(process.stdout, 0);
console.log('Загружено записей:', res.length);
}, console.error);
vk.longpoll.start();
vk.longpoll.stop().then(function onResponse(data) {
setTimeout(vk.longpoll.listen, 10000, data);
});
vk.callback_api.setServer({
group_id: 1234567, // ID группы
serverModule: hipc, // Модуль/функция для поднятия сервера hipc/http/https (req, res)
listen: '/ipc/path', // порт/путь прослушки (передает в listen)
url: 'http://domain/path/', // url сервера
secret_key: 'pass1234', // секретный ключ
message_new: 1, // далее данные для groups.setCallbackSettings
});
// В then отдает opts и server, который можно использовать например для установки ssl, но лучше использовать http + nginx
0.5.0
...
0.2.91
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.1.9
0.1.8
FAQs
VK API module / Модуль для работы с API Вконтакте
We found that VK-Promise demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.