papi-dts
    Preparing search index...

    Interface ServerSocketLikeExperimental

    The subset of a socket the main-process RPC layer touches. Both ws's server-side sockets and the DOM WebSocket type satisfy it structurally, and so does a MessagePort wrapped to look like one. RpcServer and RpcWebSocketListener are written against this rather than against WebSocket so that main can serve a client over something other than a TCP socket.

    interface ServerSocketLike {
        readyState: number;
        addEventListener<K extends "error" | "message" | "close">(
            type: K,
            listener: (ev: WebSocketEventMap[K]) => void,
        ): void;
        close(code?: number, reason?: string): void;
        removeEventListener<K extends "error" | "message" | "close">(
            type: K,
            listener: (ev: WebSocketEventMap[K]) => void,
        ): void;
        send(
            data:
                | string
                | ArrayBufferLike
                | ArrayBufferView<ArrayBufferLike>
                | Blob,
        ): void;
    }
    Index

    Properties

    readyState

    Methods

    addEventListener close removeEventListener send

    Properties

    readyState: number

    0=CONNECTING, 1=OPEN, 2=CLOSING, 3=CLOSED, as on WebSocket.readyState

    Methods

    • Experimental

      Type Parameters

      • K extends "error" | "message" | "close"

      Parameters

      • type: K
      • listener: (ev: WebSocketEventMap[K]) => void

      Returns void

    • Experimental

      Parameters

      • Optionalcode: number
      • Optionalreason: string

      Returns void

    • Experimental

      Type Parameters

      • K extends "error" | "message" | "close"

      Parameters

      • type: K
      • listener: (ev: WebSocketEventMap[K]) => void

      Returns void

    • Experimental

      Parameters

      • data: string | ArrayBufferLike | ArrayBufferView<ArrayBufferLike> | Blob

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods