import ReopeningWebSocket from 'reopening-websocket/src/ReopeningWebSocket.js'

public class | source

ReopeningWebSocket

Extends:

WebSocket → ReopeningWebSocket

Implements:

EventTarget

Automatically reopening WebSocket

Test:

ReopeningWebSocket

Constructor Summary

Public Constructor
public	constructor(url: String, protocols: String \| String[]) Creates a new ReopeningWebSocket

Member Summary

Public Members
public	onreopen: EventListener An event listener to be called on reopen.
public	onreopenattempt: EventListener An event listener to be called on each reopen attempt.
public	reopenAttempt: Number How many times a reopen happened without success.

Method Summary

Public Methods
public	addEventListener(type: String, listener: EventListener, options: Boolean \| Object) Register an event handler of a specific type.
public	close(code: Number, reason: String) Closes the WebSocket connection or connection attempt, if any.
public	dispatchEvent(event: Event) Dispatches an Event.
public	removeEventListener(type: String, listener: EventListener) Removes an event listener registed with ReopeningWebSocket#addEventListener.
public	reopen() Reopens the WebSocket connection.
public	send(data: String \| ArrayBuffer \| Blob) Transmits data to the server

Public Constructors

public constructor(url: String, protocols: String | String[]) source

Creates a new ReopeningWebSocket

Params:

Name	Type	Attribute	Description
url	String		The URL to connect to.
protocols	String \| String[]	optional	The protocol(s) to use.

Public Members

public onreopen: EventListener source

An event listener to be called on reopen.

Test:

ReopeningWebSocket EventTarget on[event] properties

public onreopenattempt: EventListener source

An event listener to be called on each reopen attempt.

public reopenAttempt: Number source

How many times a reopen happened without success. Reset to 0 the first time a reopen succeeds.

Public Methods

public addEventListener(type: String, listener: EventListener, options: Boolean | Object) source

Params:

Name	Type	Attribute	Description
type	String		The event to listen for.
listener	EventListener		The function to call when the event occures.
options	Boolean \| Object	optional	Specifies characteristics of the listener.
options.once	Boolean	optional	Only call the listener once.

Test:

ReopeningWebSocket EventTarget #addEventListener

See:

https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

public close(code: Number, reason: String) source

Closes the WebSocket connection or connection attempt, if any.

Note that after calling this method the connection will not reopen automatically any more. Call ReopeningWebSocket#reopen to reopen it.

Params:

Name	Type	Attribute	Description
code	Number	optional default: 1000	A numeric value indicating why the connection is being closed.
reason	String		The human-readable reason why the connection is being closed.

Example:

Disabling and re-enabling automatic reopening

const ws = new ReopeningWebSocket('ws://example.com');
...
ws.close();
// At this point the connection will not no longer automatically reopen
ws.reopen();
// At this point automatic reopening is re-enabled.