aurora-api v0.2.0-beta.5

AuroraAPI

Реализация JS / TS API для Aurora Launcher

Установка

Используя npm:

npm i aurora-api

Используя jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/aurora-api/dist/aurora-api.min.js"></script>

Используя unpkg CDN:

<script src="https://unpkg.com/aurora-api/dist/aurora-api.min.js"></script>

Пример использования (Node.js)

// Подключение класса API
const { AuroraAPI } = require('aurora-api');

// Инициализация класса API и создание подключения к вебсокету
const api = new AuroraAPI('ws://localhost:1370/ws');

// TODO а чё с коллбеками то делать? api.ready()

// Отправка/обработка запросов с использованием колбеков

api.send('ping', (error, result) => { // Запрос к API лаунчер сервера
    if (error) {
        console.error(error);
        return api.close();
    }
    console.log(result);
    api.close();
});

// в стиле 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

(async () => {
    try {
        await api.ready();
        const result = await api.send('ping');
        console.log(result);
    } catch (error) {
        console.error(error);
    } finally {
        api.close();
    }
})();

Также библиотека поддерживает работу с TypeScript

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

Методы и параметры

Класс AuroraAPI содержит следущее:

Методы:

• ready() - функция ожидания подключения к сокету лаунчсервера
• close() - отключение от сокета лаунчсервера
• hasConnected() - проверка на наличие подключения к сокету лаунчер серверу
• send(type, obj, callback) - отправка запроса к лаунчсерверу, где:
  • type - тип запроса
  • obj - объект с параметрами запроса
  • callback - функция обратного вызова, которая используется для обработки ответа на запрос, при написании кода в Promise стиле. В async/await стиле не используется

Эвенты (стандартные эвенты вебсокета):

• onOpen() - обработчик эвента onopen
• onClose() - обработчик эвента onclose
• onMessage() - обработчик эвента onmessage
• onError() - обработчик эвента onerror