Interface IWebSocketServerConnectionFramed

a framed connection to a WebSocket server (not to be confused with client-side connection!)

interface IWebSocketServerConnectionFramed {
    close: () => void;
    headers: Headers;
    readFrame: () => Promise<string | Uint8Array>;
    url: string;
    writeFrame: (frame: string | Uint8Array) => Promise<void>;
}

Hierarchy (View Summary)

Properties

close: () => void

Close the underlying source.

headers: Headers

headers from the handshake request

readFrame: () => Promise<string | Uint8Array>
url: string

URL of the handshake request

writeFrame: (frame: string | Uint8Array) => Promise<void>