Docs
Root Β·
docs
Files
Root: docs/
WSPluginClient.js
File: framework/js/core-lib/WSPluginClient.js.md

WSPluginClient.js

Source: framework/js/core-lib/WSPluginClient.js

Generated (UTC): 2026-01-08T12:18:17Z

Factory

Definition: WSPluginClient

Only purpose is to establish a web socket connection.

Options

url

URL of websocket destination. Example: wss://example.net

dataStore

DataStore object with reader, writer and enum capacity.

Expects `DataStore().[reader|writer|enum].socket...

                  socket : {
                      readyState : null,
                      url = null,
                  }

Returns

socket

No description.

ready

No description.

pendingRequests

No description.

sentAt

No description.

usedTickets

No description.

send

No description.

sendJson

No description.

close

No description.

Methods

sendJson

No description.

Options

pluginId

No description.

pluginAction

Test desc...

data

No description.