x-next 0.0.0-alpha.1 → 0.0.0-alpha.3

package/index.d.ts

@@ -1,159 +0,0 @@
-declare type WebSocketUrl = `ws://${string}` | `wss://${string}`;
-declare type Heartbeat = (callback: HeartbeatCallback) => void;
-declare type HeartbeatCallback = (msg: string) => void;
-declare type ReceiveInterceptor = (event: MessageEvent<any>, send: (msg: SendMsg) => void) => any;
-declare type SendInterceptor = (event: any) => any;
-declare type WebSocketBucketCreate = {
-    url: WebSocketUrl;
-    name?: string;
-    heartbeat?: Heartbeat;
-    heartRate?: Millisecond;
-    restartTime?: Millisecond;
-    restartTimes?: number;
-    restartedTimes?: number;
-    receive?: ReceiveInterceptor;
-    send?: SendInterceptor;
-};
-declare type WebSocketBucketOptions = {
-    name: string;
-    client: WebSocket;
-    url: WebSocketUrl;
-    heartbeat?: Heartbeat;
-    heartRate: Millisecond;
-    heartRateTimer: number;
-    restartTime: Millisecond;
-    restartTimes: number;
-    restartedTimes: number;
-    receive?: ReceiveInterceptor;
-    send?: SendInterceptor;
-    receiveMessageCallbacks: Map<string, (event: MessageEvent<any>) => void>;
-    [key: string]: unknown;
-};
-declare type Millisecond = number;
-declare type SendMsg = string | ArrayBufferLike | Blob | ArrayBufferView;
-
-declare enum WebSocketBucketState {
-    CONNECTING = "CONNECTING",
-    OPEN = "OPEN",
-    CLOSING = "CLOSING",
-    CLOSED = "CLOSED",
-    FAIL = "FAIL"
-}
-/**
- * @class WebSocketBucket
- * @public
- * @classdesc WebSocket快速部署开发，可同开多个WebSocket，并分别命名，可对多个Client进行监听，每一个Bucket为Client运行所必需的空间环境。
- * @example
- * WebSocketBucket.create({url:'wss://ws.demo.com/socket-io'})
- * WebSocketBucket.sendMessage('Hello World')
- */
-declare class WebSocketBucket {
-    static NO_BUCKET: string;
-    static NO_BUCKET_CLIENT: string;
-    static NO_BUCKET_KEY: string;
-    static DEFAULT_NAME: string;
-    client: WebSocket | undefined;
-    buckets: Map<string, WebSocketBucketOptions>;
-    bucketName: string;
-    static instance: WebSocketBucket;
-    constructor();
-    /**
-     * create
-     * 创建一个Bucket空间
-     * @param url {string} 服务地址（SSL）
-     * @param name {string} 实例名称
-     * @param heartbeat {function} (sendMessage,instanceName)=>void 心跳执行函数  send {Function} 消息发送函数
-     * @param heartRate 心跳频率 毫秒
-     * @param restartTime 重启时间，按照通用方式，例如第一次3秒后重连如果没连上第二次就3*2=6秒后重连，如果还没有连上第三次就是3*2*2=12秒后重连，以此类推直到重连上为止，一旦重连上重连等待时间就会自动回到3秒这个初始值
-     * @param restartTimes 重启次数，0为不限制，>0为最大重启次数
-     * @param restartedTimes 已重启次数
-     * @param receive 接收拦截器
-     * @param send 发送拦截器
-     */
-    static create({ url, name, heartbeat, heartRate, restartTime, restartTimes, restartedTimes, receive, send, }: WebSocketBucketCreate): WebSocket | undefined;
-    /**
-     * readBucket
-     * 读取Bucket空间
-     * @param name
-     * @return WebSocketBucketOptions
-     */
-    static getBucket(name: string | undefined): WebSocketBucketOptions;
-    /**
-     * setBucketKeyValue
-     * 设置Bucket属性值
-     * @param key
-     * @param value
-     * @param name
-     */
-    static setBucketKeyValue(key: string, value: number, name: string): void;
-    /**
-     * 获取Bucket客户端
-     * @param name
-     */
-    static getBucketClient(name: string | undefined): WebSocket | undefined;
-    /**
-     * 获取Bucket空间名称
-     * @param name
-     */
-    static getBucketName(name: string | undefined): string;
-    /**
-     * 获取Bucket客户端状态
-     * @param name
-     */
-    static getBucketClientState(name: string | undefined): WebSocketBucketState;
-    /**
-     * 监听WebSocket报错
-     * @param callback
-     * @param name
-     */
-    static wsErrorEventListener(callback: (event: Event) => void, name?: undefined): void;
-    /**
-     * 监听WebSocket关闭
-     * @param callback
-     * @param name
-     */
-    static wsCloseEventListener(callback: (event: CloseEvent) => void, name?: undefined): void;
-    /**
-     * 监听WebSocket打开
-     * @param callback
-     * @param name
-     */
-    static wsOpenEventListener(callback: (event: Event) => void, name?: undefined): void;
-    /**
-     * 发送消息
-     * @param msg 消息
-     * @param name Bucket名称
-     * @param isCloseWarn 是否关闭警告
-     */
-    static sendMessage(msg?: SendMsg, name?: string | undefined, isCloseWarn?: boolean): void;
-    /**
-     * 绑定消息
-     * @param name
-     */
-    static bindMessage(name: string | undefined): void;
-    /**
-     * 接收消息
-     * @param callback 接收消息的回调函数
-     * @param name Bucket名称
-     */
-    static receiveMessage(callback: (event: MessageEvent<any>) => void, name?: string): void;
-    /**
-     * 注册消息接收事件
-     * @param name
-     */
-    static registerOnMessage(name?: string): void;
-    /**
-     * 获取单例实例
-     * @description 采用单例方式有利于减少内存占用
-     */
-    static getInstance(): WebSocketBucket;
-}
-
-/**
- * jsonStringify2Parse
- * @param value
- * @description 将JSON字符串转换为JSON对象
- */
-declare function jsonStringify2Parse(value: unknown): any;
-
-export { WebSocketBucket, jsonStringify2Parse };