StreamKit+ Addon Docs

network

Входящий HTTP — network.endpoints

Требуется: WEB_END_POINTS

await network.endpoints.create(path, method, callbackName);
Аргумент Описание
path Суффикс после /addon/{addonId}/
method 'GET' или 'POST'
callbackName Имя для events.On

Возвращает { success: true } или { success: false, message }.

Эндпоинт с защитой токеном для веб-UI

events.On('onParams', ({ query }) => {
  if (query.token !== data.token) {
    return { success: false, message: 'Unauthorized' };
  }
  return api.config.getParams();
});

Socket.IO — network.socketEndpoints

Требуется: SOCKET_END_POINTS

await network.socketEndpoints.create(path, callbackName);
events.On(callbackName, payload => { /* см. api-events.md */ });

await network.socketEndpoints.emit(path, event, data, socketId?);

Подключение клиента:

// path: /addon/socket.io
// namespace: /addon/{addonId}/{path}
const socket = io('http://localhost:3000/addon/my_addon/live', {
  path: '/addon/socket.io',
});

Без socketId в emit — широковещательная рассылка.

Исходящий HTTP — network.request

Требуется: NETWORK_REQUEST

Метод Описание
get(url, headers?) GET, ответ как текст
post(url, body, headers?) POST JSON (Content-Type: application/json)
put(url, body, headers?) PUT JSON
delete(url, headers?) DELETE
postForm(url, fields, headers?) POST application/x-www-form-urlencoded

Ограничения: 5 одновременных запросов, таймаут 10 с, без приватных хостов, редиректы не выполняются.

const text = await network.request.get('https://api.example.com/v1/me');
const created = await network.request.post('https://api.example.com/v1/items', { title: 'Hello' });

Исходящий WebSocket — network.websocket

Требуется: NETWORK_WEBSOCKET

const ws = await network.websocket.connect('wss://example.com/socket', {
  headers: { Authorization: 'Bearer token' },
  protocols: 'json',
});

ws.On('open', () => ws.Send({ type: 'hello' }));
ws.On('message', data => console.log(data));
ws.On('close', ({ code, reason }) => console.log(code, reason));
ws.On('error', err => console.error(err));

ws.Close();
ws.Destroy();

Send принимает строку или JSON-сериализуемый объект. Максимум 5 одновременных соединений.