npm package: @iobroker/ws-server
Description: ioBroker server-side web sockets
Author: bluefox
Latest version: 4.3.11

# @iobroker/ws-server

This library is used for communication with the front-end via pure web-sockets.

It simulates `socket.io` interface.

It is used normally together with `@iobroker/ws` on the browser side, and it is not compatible with `socket.io.client` library.

## Usage

```js
const http = require('node:http');
const { SocketIO } = require('@iobroker/ws-server');

const requestListener = function (req, res) {
    res.writeHead(200);
    res.end('Hello, World!');
};

// create web server
const webServer = http.createServer(requestListener);
// create web socket server
const socketServer = new SocketIO(webServer);

// install event handlers on socket connection
function onConnection(socket, initDone) {
    console.log('==> Connected IP: ' + socket.connection.remoteAddress);

    socket.on('customMessage', function (data, cb) {
        console.log('Received ' + data);
        cb(data + 1);
    });

    socket.on('disconnect', function (error) {
        console.log(`<== Disconnect from ${socket.connection.remoteAddress}: ${error}`);
    });

    initDone && initDone();
}

// install event handlers of the socket server
socketServer.on('connection', onConnection);
socketServer.on('error', (e, details) => console.error(`Server error: ${e}${details ? ' - ' + details : ''}`));

// start web server
webServer.listen(5000);
```

<!--
	Placeholder for the next version (at the beginning of the line):
	### **WORK IN PROGRESS**
-->

## Changelog
### 4.3.11 (2026-02-25)

- (@GermanBluefox) Updated packages

### 4.3.9 (2025-04-30)

- (@GermanBluefox) Correcting edge cases in the socket server

### 4.3.7 (2025-04-16)

- (@GermanBluefox) Added types for cloud application (as a client)

### 4.3.4 (2025-03-29)

- (@GermanBluefox) Added support for the wildcard message handlers

### 4.3.2 (2025-03-05)

- (@GermanBluefox) Updated TypeScript to 5.8

### 4.2.9 (2025-02-24)

- (@GermanBluefox) Added authentication by headers.

### 4.2.8 (2025-02-22)

- (@GermanBluefox) Added cookie support

### 4.2.6 (2025-02-11)

- (@GermanBluefox) Added type definitions used in `@iobroker/socket-classes`

### 4.2.2 (2025-02-05)

- (@GermanBluefox) Added the query path to the socket class
- (@GermanBluefox) Added support for different handlers for different paths

### 4.1.0 (2024-11-17)

- (@GermanBluefox) Corrected error with session ID

### 4.0.1 (2024-10-11)

- (@GermanBluefox) Corrected error with session ID and authentication
- (@GermanBluefox) Increased a major version to have a clear indicator for the new package

### 3.0.0 (2024-10-02)

- (@GermanBluefox) Package was rewritten with TypeScript
- BREAKING CHANGE: import of SocketIO class changed (see example above)

### 2.1.2 (2023-12-17)

- (foxriver76) increase maximum message size from 100 MB to 500 MB

### 2.1.1 (2023-07-31)

- (@GermanBluefox) Packages updated

### 2.1.0 (2022-05-19)

- (@GermanBluefox) Support interface of socket.io 4.0

### 2.0.0 (2022-04-24)

- (@GermanBluefox) renamed package into `@iobroker/ws-server`
- (@GermanBluefox) added error handlers

### 1.0.1 (2022-01-30)

- (@GermanBluefox) initial commit

## License

The MIT License (MIT)

Copyright (c) 2020-2026 Bluefox <dogafox@gmail.com>

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.