0.1.1 • Published 6 months ago
@fotontv/gotma-api v0.1.1
GotmaLauncherAPI (@fotontv/gotma-api)
Реализация JS / TS API
Установка
Используя npm:
npm i @fotontv/gotma-api
Используя jsDelivr CDN:
<script src="https://cdn.jsdelivr.net/npm/@fotontv/gotma-api/dist/index-web.js"></script>
Используя unpkg CDN:
<script src="https://unpkg.com/@fotontv/gotma-api/dist/index-web.js"></script>
Пример использования (Node.js)
// Подключение класса API
const { GotmaAPI } = require('@fotontv/gotma-api');
// Инициализация класса API и создание подключения к вебсокету
const api = new GotmaAPI('ws://localhost:1370/ws');
// Отправка/обработка запросов в стиле Promise
api.ready() // Ожидание подключения к сокету лаунчсервера
.then(() => {
api.send('ping').then(result => { // Запрос к API лаунчер сервера
console.log(result);
}).catch((error) => {
console.error(error);
});
api.close(); // Закрытие соединения
}).catch((error) => {
console.error(error);
});
// или в стиле async/await
await api.ready();
try {
const result = await api.send('ping');
console.log(result);
} catch (error) {
console.error(error);
} finally {
api.close();
}
Также библиотека поддерживает работу с TypeScript
Методы и параметры
Класс GotmaAPI
содержит следущее:
Методы:
ready()
- функция ожидания подключения к сокету лаунчсервераclose()
- отключение от сокета лаунчсервераhasConnected()
- проверка на наличие подключения к сокету лаунчер серверуsend(type, obj)
- отправка запроса к лаунчсерверу, где:type
- тип запросаobj
- объект с параметрами запроса
Эвенты (стандартные эвенты вебсокета):
0.1.1
6 months ago