Interface ISocketOptions

interface ISocketOptions {
    autoClose?: boolean;
    beforeMessage?: ((e: MessageEvent<any>) => any);
    heartMessage?: string;
    heartTime?: number;
    isReconnect?: boolean;
    onClose?: ((ws: WebSocket, e: CloseEvent) => void);
    onError?: ((ws: WebSocket, e: Event) => void);
    onFailed?: (() => void);
    onMessage?: ((ws: WebSocket, e: MessageEvent<any>) => void);
    onOpen?: ((ws: WebSocket) => void);
    protocols?: string | string[];
    reconnectCount?: number | (() => boolean);
    reconnectTime?: number;
}

Properties

autoClose? beforeMessage? heartMessage? heartTime? isReconnect? onClose? onError? onFailed? onMessage? onOpen? protocols? reconnectCount? reconnectTime?

Properties

OptionalautoClose

autoClose?: boolean

自动关闭

Default

true

OptionalbeforeMessage

beforeMessage?: ((e: MessageEvent<any>) => any)

数据接收前处理 只处理data

OptionalheartMessage

heartMessage?: string

心跳信息

Default

ping

OptionalheartTime

heartTime?: number

心跳时间间隔

Default

5000

OptionalisReconnect

isReconnect?: boolean

是否自动重连

Default

true

OptionalonClose

onClose?: ((ws: WebSocket, e: CloseEvent) => void)

关闭的回调

OptionalonError

onError?: ((ws: WebSocket, e: Event) => void)

错误的回调

OptionalonFailed

onFailed?: (() => void)

重连失败回调

OptionalonMessage

onMessage?: ((ws: WebSocket, e: MessageEvent<any>) => void)

消息的回调

OptionalonOpen

onOpen?: ((ws: WebSocket) => void)

连接成功地回调

Optionalprotocols

protocols?: string | string[]

通信协议

OptionalreconnectCount

reconnectCount?: number | (() => boolean)

重连次数 可以是数值或者返回一个boolean

Default

-1

OptionalreconnectTime

reconnectTime?: number

重连时间间隔

Default

5000

Settings

Member Visibility

On This Page

Properties