import Websocket from '@osjs/client/src/websocket.js'

public class | source

Websocket

Extends:

@osjs/event-emitter~EventEmitter → Websocket

Application Socket

This is just an abstraction above the standard browser provided WebSocket class. Since this class implements the EventHandler, use the .on('event') pattern instead of .onevent.

Constructor Summary

Public Constructor
public	constructor(name: string, uri: string, options: WebsocketOptions) Create a new Websocket

Member Summary

Public Members
public	closed: boolean If socket is closed
public	connected: boolean If socket is connected
public	connectfailed: boolean If socket failed to connect
public	connecting: boolean If socket is connecting
public	connection: WebSocket The Websocket
public	options: WebsocketOptions Options
public	reconnecting: boolean If socket is reconnecting
public	uri: string Socket URI

Method Summary

Public Methods
public	close(args: ...): Wrapper for closing
public	open(reconnect: boolean) Opens the connection
public	send(args: ...): Wrapper for sending data

Private Methods
private	_attachEvents() Attaches internal events
private	_destroyConnection(): void Destroys the current connection

Public Constructors

public constructor(name: string, uri: string, options: WebsocketOptions) source

Create a new Websocket

Params:

Name	Type	Attribute	Description
name	string		Instance name
uri	string		Connection URI
options	WebsocketOptions	optional default: {}	Websocket options

Public Members

public closed: boolean source

If socket is closed

public connected: boolean source

If socket is connected

public connectfailed: boolean source

If socket failed to connect

public connecting: boolean source

If socket is connecting

public connection: WebSocket source

The Websocket

public options: WebsocketOptions source

Options

public reconnecting: boolean source

If socket is reconnecting

public uri: string source

Socket URI

Public Methods

public close(args: ...): source

Wrapper for closing

Params:

Name	Type	Attribute	Description
args	...*

Return:

public open(reconnect: boolean) source

Opens the connection

Params:

Name	Type	Attribute	Description
reconnect	boolean	optional default: false	Force reconnection

public send(args: ...): source

Wrapper for sending data

Params:

Name	Type	Attribute	Description
args	...*

Websocket

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(name: string, uri: string, options: WebsocketOptions) source

Params:

Public Members

public closed: boolean source

public connected: boolean source

public connectfailed: boolean source

public connecting: boolean source

public connection: WebSocket source

public options: WebsocketOptions source

public reconnecting: boolean source

public uri: string source

Public Methods

public close(args: ...): source

Params:

Return:

public open(reconnect: boolean) source

Params:

public send(args: ...): source

Params:

Return:

Private Methods

private _attachEvents() source

private _destroyConnection(): void source

Return:

Websocket

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(name: string, uri: string, options: WebsocketOptions) source

Params:

Public Members

public closed: boolean source

public connected: boolean source

public connectfailed: boolean source

public connecting: boolean source

public connection: WebSocket source

public options: WebsocketOptions source

public reconnecting: boolean source

public uri: string source

Public Methods

public close(args: ...*): * source

Params:

Return:

public open(reconnect: boolean) source

Params:

public send(args: ...*): * source

Params:

Return:

Private Methods

private _attachEvents() source

private _destroyConnection(): void source

Return:

public close(args: ...): source

public send(args: ...): source