Realtime application framework client
Please see the documentation here.
The source code of the website can be found here. Contributions are welcome!
In order to see all the client debug output, run the following command on the browser console – including the desired scope – and reload your app page:
socketio
localStorage.debug = '*';And then, filter by the scopes you're interested in. See also: https://socket.io/docs/v4/logging-and-debugging/
This release contains a bump of the socket.io-parser dependency, in order to fix CVE-2022-2421.
There were some minor bug fixes on the server side, which mandate a client bump.
The "disconnect" event will now include additional details to help debugging if anything has gone wrong.
Example when a payload is over the maxHttpBufferSize value in HTTP long-polling mode:
socket.on("disconnect", (reason, details) => {
console.log(reason); // "transport error"
// in that case, details is an error object
console.log(details.message); "xhr post error"
console.log(details.description); // 413 (the HTTP status of the response)
// details.context refers to the XMLHttpRequest object
console.log(details.context.status); // 413
console.log(details.context.responseText); // ""
});This is similar to onAny(), but for outgoing packets.
Syntax:
socket.onAnyOutgoing((event, ...args) => {
console.log(event);
});The server will now include a "maxPayload" field in the handshake details, allowing the clients to decide how many packets they have to send to stay under the maxHttpBufferSize value.
socket.disconnect().connect() usage (99c2cb8)socket.timeout(5000).emit("my-event", (err) => {
if (err) {
// the server did not acknowledge the event in the given delay
}
});An ESM bundle is now provided:
<script type="module">
import { io } from "https://cdn.socket.io/4.3.0/socket.io.esm.min.js";
const socket = io();
socket.emit("hello", "world");
</script>There were some minor bug fixes on the server side, which mandate a client bump.
engine.io-client)auth property public (#1455) (c150223)The major bump is due to some breaking changes on the server side.
engine.io-client)The minor bump is matching the bump of the server, but there is no new feature in this release.
// before
socket.on("error", () => {});
// after
socket.on("connect_error", () => {});the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
the Socket instance will no longer forward the events of its Manager
Those events can still be accessed on the Manager instance though:
socket.io.on("reconnect", () => {
// ...
});// before
socket.on("error", () => {});
// after
socket.on("connect_error", () => {});Those events can still be accessed on the Manager instance though:
socket.io.on("reconnect", () => {
// ...
});The debug dependency has been reverted to ~3.1.0, as the newer versions contains ES6 syntax which breaks in IE
browsers.
Please note that this only applied to users that bundle the Socket.IO client in their application, with webpack for example, as the "official" bundles (in the dist/ folder) were already transpiled with babel.
For webpack users, you can also take a look at the webpack-remove-debug plugin.
The minor bump is matching the bump of the server, but there is no new feature in this release.
global variable (related: https://github.com/socketio/socket.io-client/issues/1166)// by default, the object is recursively scanned to check whether it contains some binary data
// in the following example, the check is skipped in order to improve performance
socket.binary(false).emit('plain-object', object);