Interface WebSocket

interface WebSocket {
    CLOSED: number;
    CLOSING: number;
    CONNECTING: number;
    OPEN: number;
    binaryType: "/home/runner/work/amplify-js/amplify-js/amplify-js/packages/adapter-nextjs/node_modules/undici-types/index".BinaryType;
    bufferedAmount: number;
    extensions: string;
    onclose: null | ((this, ev) => any);
    onerror: null | ((this, ev) => any);
    onmessage: null | ((this, ev) => any);
    onopen: null | ((this, ev) => any);
    protocol: string;
    readyState: number;
    url: string;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    close(code?, reason?): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    send(data): void;
}

Hierarchy

  • EventTarget
    • WebSocket

Properties

CLOSED CLOSING CONNECTING OPEN binaryType bufferedAmount extensions onclose onerror onmessage onopen protocol readyState url

Methods

addEventListener close dispatchEvent removeEventListener send

Properties

Readonly CLOSED

CLOSED: number

Readonly CLOSING

CLOSING: number

Readonly CONNECTING

CONNECTING: number

Readonly OPEN

OPEN: number

binaryType

binaryType: "/home/runner/work/amplify-js/amplify-js/amplify-js/packages/adapter-nextjs/node_modules/undici-types/index".BinaryType

Readonly bufferedAmount

bufferedAmount: number

Readonly extensions

extensions: string

onclose

onclose: null | ((this, ev) => any)

Type declaration

onerror

onerror: null | ((this, ev) => any)

Type declaration

onmessage

onmessage: null | ((this, ev) => any)

Type declaration

onopen

onopen: null | ((this, ev) => any)

Type declaration

Readonly protocol

protocol: string

Readonly readyState

readyState: number

Readonly url

url: string

Methods

addEventListener

close

  • close(code?, reason?): void

  • Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    Returns boolean

removeEventListener

send

Settings

Member Visibility

Theme

On This Page