Installation and Configuration

Installation

There are two ways to install ClusterWS Client JS library

• Use npm to install (only for projects which are using bundle libraries/frameworks like Webpack, Gulp)

npm install --save clusterws-client-js

• Import globally in the html script:

1. Navigate to dist/browser
2. Copy clusterws.[min].js to your project
3. Import it in html with <script src="path/to/clusterws.[min].js"></script>
4. Don't forget to take LICENSE file :)

Configurations

To connect to the server use ClusterWS instance:

let ClusterWS = require('clusterws-client-js') // only if you used npm 

let socket = new ClusterWS({
    url: 'ws://localhost:80'
})

Available configurations

{
    url: '{string} url to the server with ws/wss and port at the end. (must be provided)',
    autoReconnect: '{boolean} allow to auto-reconnect to the server on lost connection. (default false)',
    reconnectionIntervalMin: '{number} how long min time waut. (default 1000) in ms', 
    reconnectionIntervalMax: '{number} how long max time wait. (default 5000) in ms', 
    reconnectionAttempts: '{number} how many times to try, 0 means without limit. (default 0)',
}