Connect to the server using an address and unique id that specifies the client
An object which passed out to define all the main properties of the server. Notable fields are: ClientOptions.address, ClientOptions.handshake and ClientOptions.prepareContext.
Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:
Can be set, to change how binary data is returned. The default is "blob".
Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.
If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)
Returns the extensions selected by the server, if any.
Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.
Returns the state of the WebSocket object's connection. It can have the values described below.
Returns the URL that was used to establish the WebSocket connection.
Call the server method using params as one argument construction.
The name of the remote method to call
Method arguments
Returns a Promise with the JSON response from the client. It can be an object, an array or a primitive.
Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Register the method on the client side, handler must return an object or a Promise<object> which will be held on the server side
Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
Generated using TypeDoc
RPC websocket client class which establishes the connection to the server. It inherits from browser's Websocket class, but for the connection you need to provide the unique client token in the constructor to let the server sends you method call using it. This class can register any method to call it by the server. And also can call any method on the server and receive response data.
The main parts of this class are:
import Client from '@noveo/dual-rpc-ws/client'; const client = new Client({ token: 'id13', address: 'ws://192.168.0.80:8080', handshake: (connected) => { console.log('connected', connected); this.call(token, 'hi', {message: 'hello from client'}); } }); client.register('hi', (params, context) => { console.log('client hi, call id:', context.id); return Promise.resolve(`${token}, hello`); }); client.addEventListener('close', () => { console.log('connection closed'); });