Permalink
Comparing changes
Choose two branches to see what’s changed or to start a new pull request.
If you need to, you can also or
learn more about diff comparisons.
Open a pull request
Create a new pull request by comparing changes across two branches. If you need to, you can also .
Learn more about diff comparisons here.
...
22
contributors
Commits on Mar 1, 2021
-
feat: allow to exclude specific rooms when broadcasting (#3789)
-
fix: make io.to(...) immutable
Previously, broadcasting to a given room (by calling `io.to()`) would mutate the io instance, which could lead to surprising behaviors, like: ```js io.to("room1"); io.to("room2").emit(...); // also sent to room1 // or with async/await io.to("room3").emit("details", await fetchDetails()); // random behavior: maybe in room3, maybe to all clients ``` Calling `io.to()` (or any other broadcast modifier) will now return an immutable instance. Related: - #3431 - #3444 -
feat: allow to pass an array to io.to(...)
In some cases it is necessary to pass an array of rooms instead of a single room. New syntax: ``` io.to(["room1", "room2"]).except(["room3"]).emit(...); socket.to(["room1", "room2"]).except(["room3"]).emit(...); ``` Related: #3048
Commits on Mar 2, 2021
-
feat: add some utility methods
This commit adds the following methods: - fetchSockets: returns the matching socket instances Syntax: ```js // return all Socket instances const sockets = await io.fetchSockets(); // return all Socket instances of the "admin" namespace in the "room1" room const sockets = await io.of("/admin").in("room1").fetchSockets(); ``` - socketsJoin: makes the matching socket instances join the specified rooms Syntax: ```js // make all Socket instances join the "room1" room io.socketsJoin("room1"); // make all Socket instances of the "admin" namespace in the "room1" room join the "room2" room io.of("/admin").in("room1").socketsJoin("room2"); ``` - socketsLeave: makes the matching socket instances leave the specified rooms Syntax: ```js // make all Socket instances leave the "room1" room io.socketsLeave("room1"); // make all Socket instances of the "admin" namespace in the "room1" room leave the "room2" room io.of("/admin").in("room1").socketsLeave("room2"); ``` - disconnectSockets: makes the matching socket instances disconnect Syntax: ```js // make all Socket instances disconnect io.disconnectSockets(); // make all Socket instances of the "admin" namespace in the "room1" room disconnect io.of("/admin").in("room1").disconnectSockets(); ``` Those methods share the same semantics as broadcasting. They will also work with multiple Socket.IO servers when using the Redis adapter. In that case, the fetchSockets() method will return a list of RemoteSocket instances, which expose a subset of the methods and attributes of the Socket class (the "request" attribute cannot be mocked, for example). Related: - #3042 - #3418 - #3570 - socketio/socket.io-redis-adapter#283
Commits on Mar 9, 2021
-
feat: add support for typed events (#3822)
Syntax: ```ts interface ClientToServerEvents { "my-event": (a: number, b: string, c: number[]) => void; } interface ServerToClientEvents { hello: (message: string) => void; } const io = new Server<ClientToServerEvents, ServerToClientEvents>(httpServer); io.emit("hello", "world"); io.on("connection", (socket) => { socket.on("my-event", (a, b, c) => { // ... }); socket.emit("hello", "again"); }); ``` The events are not typed by default (inferred as any), so this change is backward compatible. Note: we could also have reused the method here ([1]) to add types to the EventEmitter, instead of creating a StrictEventEmitter class. Related: #3742 [1]: https://github.com/binier/tiny-typed-emitter
Commits on Mar 10, 2021
Commits on Mar 18, 2021
-
fix(typings): update return type from emit (#3843)
``` (channel ? io.to(channel) : io).emit("stuff", message); ``` would no longer compile. Related: #3844 -
-
Commits on Mar 24, 2021
-
docs(examples): remove unnecessary type annotations (#3855)
Typed events in Socket.IO 4.0 remove the need for writing type annotations in callbacks of reserved events.
Commits on Mar 31, 2021
Commits on Apr 22, 2021
Commits on May 6, 2021
-
fix: properly export the Socket class
Before this change, `require("socket.io").Socket` would return "undefined". Note: having access to the Socket class allows users to modify its prototype. Related: #3726 -
Commits on May 10, 2021
-
perf: add support for the "wsPreEncoded" writing option
Packets that are sent to multiple clients will now be pre-encoded for the WebSocket transport (which means simply prepending "4" - which is the "message" packet type in Engine.IO). Note: buffers are not pre-encoded, since they are sent without modification over the WebSocket connection See also: socketio/engine.io@7706b12 engine.io diff: socketio/engine.io@5.0.0...5.1.0
-
feat: add support for inter-server communication
Syntax: ```js // server A io.serverSideEmit("hello", "world"); // server B io.on("hello", (arg) => { console.log(arg); // prints "world" }); ``` With acknowledgements: ```js // server A io.serverSideEmit("hello", "world", (err, responses) => { console.log(responses); // prints ["hi"] }); // server B io.on("hello", (arg, callback) => { callback("hi"); }); ``` This feature replaces the customHook/customRequest API from the Redis adapter: socketio/socket.io-redis-adapter#370 -
feat: notify upon namespace creation
A "new_namespace" event will be emitted when a new namespace is created: ```js io.on("new_namespace", (namespace) => { // ... }); ``` This could be used for example for registering the same middleware for each namespace. See #3851 -
Commits on May 11, 2021
Commits on May 17, 2021
-
fix: ensure compatibility with previous versions of the adapter
Using `socket.io@4.1.0` with `socket.io-adapter@2.2.0` would lead to the following error: > Uncaught Error: unknown packet type NaN Because the packet would be encoded twice, resulting in "undefined". See also: - socketio/socket.io-adapter@5579d40 - dc381b7 Related: - #3922 - #3927
-
fix(typings): ensure compatibility with TypeScript 3.x
Labeled tuple elements were added in TypeScript 4.0. Reference: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html#labeled-tuple-elements Related: #3916
Commits on Jun 15, 2021
Commits on Jun 24, 2021
Commits on Jun 28, 2021
Commits on Jul 3, 2021
-
-
fix: remove x-sourcemap header
This header is useless, as the client bundle already contains a sourceMappingURL field. Besides, Firefox prints the following warning: > <url> is being assigned a //# sourceMappingURL, but already has one Related: #3958
Commits on Jul 10, 2021
-
Previously, calling `io.except("theroom").emit(...)` did not exclude the sockets in the given room. This method was forgotten in [1]. [1]: ac9e8ca
Commits on Jul 15, 2021
-
docs(examples): add missing module (#4018)
Fixes the following error: > test/todo-management/todo.tests.ts:275:3 - error TS2582: Cannot find name 'describe'. Do you need to install type definitions for a test runner? Try `npm i --save-dev @types/jest` or `npm i --save-dev @types/mocha`. Co-authored-by: brownman <brownman@users.noreply.github.com>
Commits on Aug 30, 2021
-
fix(typings): allow async listener in typed events
So that: ```ts socket.on("my-event", async () => { // ... }); ``` is valid under the @typescript-eslint/no-misused-promises rule. Related: socketio/socket.io-client#1486 -
docs: update the link of the Repl.it badge
The link will now point towards a sample project, instead of the root repository. Related: #3934
-
Commits on Sep 9, 2021
Commits on Sep 20, 2021
Commits on Oct 8, 2021
Commits on Oct 11, 2021
Commits on Oct 13, 2021
Commits on Oct 14, 2021
Commits on Oct 16, 2021
-
fix: fix server attachment (#4127)
The check excluded an HTTPS server from being properly attached. Related: #4124
There are no files selected for viewing