Window Socket

new WindowSocket(_windowopt)

Source:

index.js, line 1

Parameters:

Name	Type	Attributes	Description
`_window`	Window	<optional>	specify other window to listen

Classes

Client

Methods

(static) broadcast(…args) → {WindowSocket}

Source:

index.js, line 430

Parameters:

Name	Type	Attributes	Description
`args`	Array.<any>	<repeatable>

Returns:

Type: WindowSocket

(static) clients() → {Array.<WindowSocket.Client>}

Source:

index.js, line 537

Returns:

Type: Array.<WindowSocket.Client>

(static) encoders(encoders) → {WindowSocket}

update encoders

Source:

index.js, line 520

update encoders

Parameters:

Name	Type	Description
`encoders`	Array.<WindowSocket.Encoder>

Returns:

Type: WindowSocket

(static) encoders() → {Array.<WindowSocket.Encoder>}

get current encoders

Source:

index.js, line 513

get current encoders

Returns:

Type: Array.<WindowSocket.Encoder>

(static) fire(…args) → {WindowSocket}

Source:

index.js, line 448

Parameters:

Name	Type	Attributes	Description
`args`	Array.<any>	<repeatable>

Returns:

Type: WindowSocket

(static) start() → {WindowSocket}

Source:

index.js, line 330

Returns:

Type: WindowSocket

(static) stop() → {WindowSocket}

Source:

index.js, line 310

Returns:

Type: WindowSocket

(static) validateSource(event) → {WindowSocket.Client}

Validate Message Event Source

Source:

index.js, line 468

Validate Message Event Source

Parameters:

Name	Type	Description
`event`	MessageEvent

Returns:

Type: WindowSocket.Client

Events

connect

Source:

index.js, line 500

Parameters:

Type	Description
WindowSocket.Client

message

Source:

index.js, line 369

Type:

object

message:error

Source:

index.js, line 347

Type:

MessageEvent

message:raw

Source:

index.js, line 338

Type:

MessageEvent