yolkbot
    Preparing search index...

    Interface WSSocket

    The minimal type used to define the crossplatform browser & Node sockets

    interface WSSocket {
        binaryType: string;
        readyState: number;
        addEventListener<K extends keyof WSEventMap>(
            type: K,
            listener: (ev: WSEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(code?: number): void;
        removeEventListener<K extends keyof WSEventMap>(
            type: K,
            listener: (ev: WSEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        send(data: string | Uint8Array<ArrayBuffer>): void;
        terminate?(): void;
    }
    Index

    Methods

    • Type Parameters

      Parameters

      • type: K
      • listener: (ev: WSEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • Optionalcode: number

      Returns void

    • Type Parameters

      Parameters

      • type: K
      • listener: (ev: WSEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • data: string | Uint8Array<ArrayBuffer>

      Returns void

    • Returns void

    Properties

    binaryType: string
    readyState: number