@steroidsjs/core 3.0.0-beta.11 → 3.0.0-beta.111

package/components/WebSocketComponent.d.ts

@@ -4,13 +4,71 @@
  * ответов и токен авторизации
  */
 import { IComponents } from '../providers/ComponentsProvider';
-export default class WebSocketComponent {
-    wsUrl: string;
-    streams: string[] | [string, string | number[]][];
-    authHandler: (components: IComponents) => Promise<string>;
-    onOpen: (event: any, components: IComponents) => any;
-    onClose: (event: any, components: IComponents) => any;
-    onMessage: (data: Record<string, unknown>, components: IComponents) => any;
+type TStream = string | [string, string | number[]];
+type TStreams = string[] | [string, string | number[]][];
+export interface IWebSocketComponentConfig {
+    /**
+     * url для websocket
+     */
+    wsUrl?: string;
+    /**
+     * Массив streams
+     */
+    streams?: TStreams;
+    /**
+     * Хендлер для авторизации
+     */
+    authHandler?: (components: IComponents) => Promise<string>;
+    /**
+     * Функция, которая вызывается на открытие соединения
+     */
+    onOpen?: (event: any, components: IComponents) => any;
+    /**
+     * Функция, которая вызывается на закрытие соединения
+     */
+    onClose?: (event: any, components: IComponents) => any;
+    /**
+     * Функция, которая вызывается на отправку сообщения
+     */
+    onMessage?: (data: Record<string, unknown>, components: IComponents) => any;
+}
+export interface IWebSocketComponent extends IWebSocketComponentConfig {
+    /**
+     * Открытие websocket соединения
+     */
+    open(closePrevious?: boolean): void;
+    /**
+     * Закрытие websocket соединения
+     */
+    close(): void;
+    /**
+     * Подписка на stream
+     */
+    subscribeStream(stream: TStream, id: string | number): void;
+    /**
+     * Подписка на streams
+     */
+    subscribe(streams: TStreams): void;
+    /**
+     * Отписка от stream
+     */
+    unsubscribeStream(stream: TStream, id: string | number): void;
+    /**
+     * Отписка от streams
+     */
+    unsubscribe(streams: TStreams): void;
+}
+/**
+ * WebSocket Component
+ * Компонент для создания websocket взаимодействия
+ */
+export default class WebSocketComponent implements IWebSocketComponent {
+    wsUrl?: string;
+    streams?: TStreams;
+    authHandler?: (components: IComponents) => Promise<string>;
+    onOpen?: (event: any, components: IComponents) => any;
+    onClose?: (event: any, components: IComponents) => any;
+    onMessage?: (data: Record<string, unknown>, components: IComponents) => any;
     _components: IComponents;
     _connection: any;
     _tryCount: any;
@@ -23,9 +81,10 @@ export default class WebSocketComponent {
     subscribe(streams: any): void;
     unsubscribeStream(stream: any, id: any): void;
     unsubscribe(streams: any): void;
-    _connect(): Promise<void>;
-    _reConnect(): void;
-    _onOpen(event: any): void;
-    _onMessage(message: any): void;
-    _onClose(event: any): void;
+    protected _connect(): Promise<void>;
+    protected _reConnect(): void;
+    protected _onOpen(event: any): void;
+    protected _onMessage(message: any): void;
+    protected _onClose(event: any): void;
 }
+export {};

package/components/WebSocketComponent.js

@@ -37,6 +37,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 exports.__esModule = true;
 var getStreamName = function (stream) { return Array.isArray(stream) ? stream[0] : stream; };
+/**
+ * WebSocket Component
+ * Компонент для создания websocket взаимодействия
+ */
 var WebSocketComponent = /** @class */ (function () {
     function WebSocketComponent(components, config) {
         this.wsUrl = config.wsUrl || null;