Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/SocketCluster/socketcluster-client

JavaScript client for SocketCluster
https://github.com/SocketCluster/socketcluster-client

javascript realtime socketcluster socketcluster-client websockets

Last synced: 2 months ago
JSON representation

JavaScript client for SocketCluster

Awesome Lists containing this project

README 

        
SocketCluster JavaScript client

======



Client module for SocketCluster.



## Setting up



You will need to install both ```socketcluster-client``` and ```socketcluster-server``` (https://github.com/SocketCluster/socketcluster-server).



To install this module:

```bash

npm install socketcluster-client

```



## How to use



The socketcluster-client script is called `socketcluster-client.js` (located in the main socketcluster-client directory).

Embed it in your HTML page like this:

```html



```

\* Note that the src attribute may be different depending on how you setup your HTTP server.



Once you have embedded the client `socketcluster-client.js` into your page, you will gain access to a global `socketClusterClient` object.

You may also use CommonJS `require` or ES6 module imports.



### Connect to a server



```js

let socket = socketClusterClient.create({

  hostname: 'localhost',

  port: 8000

});

```



### Transmit data



```js

// Transmit some data to the server.

// It does not expect a response from the server.

// From the server socket, it can be handled using either:

// - for await (let data of socket.receiver('foo')) {}

// - let data = await socket.receiver('foo').once()

socket.transmit('foo', 123);

```



### Invoke an RPC



```js

(async () => {



  // Invoke an RPC on the server.

  // It expects a response from the server.

  // From the server socket, it can be handled using either:

  // - for await (let req of socket.procedure('myProc')) {}

  // - let req = await socket.procedure('myProc').once()

  let result = await socket.invoke('myProc', 123);



})();

```



### Subscribe to a channel



```js

(async () => {



  // Subscribe to a channel.

  let myChannel = socket.subscribe('myChannel');



  await myChannel.listener('subscribe').once();

  // myChannel.state is now 'subscribed'.



})();

```



### Get a channel without subscribing



```js

(async () => {



  let myChannel = socket.channel('myChannel');



  // Can subscribe to the channel later as a separate step.

  myChannel.subscribe();

  await myChannel.listener('subscribe').once();

  // myChannel.state is now 'subscribed'.



})();

```



### Publish data to a channel



```js

// Publish data to the channel.

myChannel.transmitPublish('This is a message');



// Publish data to the channel from the socket.

socket.transmitPublish('myChannel', 'This is a message');



(async () => {

  // Publish data to the channel and await for the message

  // to reach the server.

  try {

    await myChannel.invokePublish('This is a message');

  } catch (error) {

    // Handle error.

  }



  // Publish data to the channel from the socket and await for

  // the message to reach the server.

  try {

    await socket.invokePublish('myChannel', 'This is a message');

  } catch (error) {

    // Handle error.

  }

})();

```



### Consume data from a channel



```js

(async () => {



  for await (let data of myChannel) {

    // ...

  }



})();

```



### Connect over HTTPS:



```js

let options = {

  hostname: 'securedomain.com',

  secure: true,

  port: 443,

  wsOptions: { rejectUnauthorized: false } // Only necessary during debug if using a self-signed certificate

};

// Initiate the connection to the server

let socket = socketClusterClient.create(options);

```



For more detailed examples of how to use SocketCluster, see `test/integration.js`.

Also, see tests from the `socketcluster-server` module.



### Connect Options



See all available options: https://socketcluster.io/



```js

let options = {

  path: '/socketcluster/',

  port: 8000,

  hostname: '127.0.0.1',

  autoConnect: true,

  secure: false,

  connectTimeout: 10000, //milliseconds

  ackTimeout: 10000, //milliseconds

  channelPrefix: null,

  autoReconnectOptions: {

    initialDelay: 10000, //milliseconds

    randomness: 10000, //milliseconds

    multiplier: 1.5, //decimal

    maxDelay: 60000 //milliseconds

  },

  authEngine: null,

  codecEngine: null,

  subscriptionRetryOptions: {},

  wsOptions: { rejectUnauthorized: false },

  query: {

    yourparam: 'hello'

  }

};

```



## Running the tests



- Clone this repo: `git clone [email protected]:SocketCluster/socketcluster-client.git`

- Navigate to project directory: `cd socketcluster-client`

- Install all dependencies: `npm install`

- Run the tests: `npm test`



## Compatibility mode



For compatibility with an existing SocketCluster server, set the `protocolVersion` to `1` and make sure that the `path` matches your old server path:



```js

let socket = socketClusterClient.create({

  protocolVersion: 1,

  path: '/socketcluster/'

});

```



## Developing



### Install all dependencies



```bash

cd socketcluster-client



npm install -g gulp gulp-cli browserify uglify-es



npm install

```



### Building



To build the SocketCluster client:



```bash

npm run build

```



## Change log



See the 'releases' section for changes: https://github.com/SocketCluster/socketcluster-client/releases



## License



(The MIT License)



Copyright (c) 2013-2023 SocketCluster.io



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.