Interface ISocketReturn<T>

interface ISocketReturn<T> {
    close: {
        (code?, reason?): void;
        (code?, reason?): void;
    };
    data?: Ref<null | T>;
    send: ((data, useBuffer?) => boolean);
    websocketOpen: (() => void);
    ws: Ref<undefined | WebSocket>;
}

Type Parameters

  • T

Properties

close data? send websocketOpen ws

Properties

close

close: {
    (code?, reason?): void;
    (code?, reason?): void;
}

Type declaration

    • (code?, reason?): void

    • Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

      Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

    • (code?, reason?): void

    • Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

      Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

Optional data

data?: Ref<null | T>

send

send: ((data, useBuffer?) => boolean)

Type declaration

    • (data, useBuffer?): boolean

    • Parameters

      • data: string | ArrayBuffer | Blob
      • Optional useBuffer: boolean

      Returns boolean

websocketOpen

websocketOpen: (() => void)

Type declaration

    • (): void

    • Returns void

ws

ws: Ref<undefined | WebSocket>

Settings

Member Visibility

Theme

On This Page

closedatasendwebsocketOpenws