minigame-std
    Preparing search index...

    Interface ISocket

    WebSocket 接口定义，描述了 WebSocket 的基本操作方法。

    1.0.0

    import type { ISocket } from 'minigame-std';

    function handleSocket(socket: ISocket) {
        socket.addEventListener('message', (data) => {
            console.log('收到:', data);
        });
        socket.send('Hello');
    }
    interface ISocket {
        readyState: number;
        addEventListener<K extends keyof WebSocketEventMap>(
            type: K,
            listener: SocketListenerMap[K],
        ): () => void;
        close(code?: number, reason?: string): void;
        send(data: DataSource): AsyncVoidIOResult;
    }
    Index

    Properties

    readyState

    Methods

    addEventListener close send

    Properties

    readyState: number

    WebSocket 的连接状态。

    Methods

    • 添加事件监听器到 WebSocket 对象。

      Type Parameters

      • K extends keyof WebSocketEventMap

        限定为 WebSocketEventMap 的键类型。

      Parameters

      • type: K

        事件类型，如 'open', 'close', 'message', 'error'。

      • listener: SocketListenerMap[K]

        对应事件的监听器回调函数。

      Returns () => void

      返回对应的removeEventListener代理函数。

    • 关闭 WebSocket 连接。

      Parameters

      • Optionalcode: number

        可选的状态码，表示关闭连接的原因。

      • Optionalreason: string

        可选的字符串，解释为什么要关闭连接。

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods