[e29cc2e] | 1 | # [4.4.0](https://github.com/socketio/socket.io/compare/4.3.2...4.4.0) (2021-11-18)
|
---|
| 2 |
|
---|
| 3 |
|
---|
| 4 | ### Bug Fixes
|
---|
| 5 |
|
---|
| 6 | * only set 'connected' to true after middleware execution ([02b0f73](https://github.com/socketio/socket.io/commit/02b0f73e2c64b09c72c5fbf7dc5f059557bdbe50))
|
---|
| 7 |
|
---|
| 8 |
|
---|
| 9 | ### Features
|
---|
| 10 |
|
---|
| 11 | * add an implementation based on uWebSockets.js ([c0d8c5a](https://github.com/socketio/socket.io/commit/c0d8c5ab234d0d2bef0d0dec472973cc9662f647))
|
---|
| 12 | * add timeout feature ([f0ed42f](https://github.com/socketio/socket.io/commit/f0ed42f18cabef20ad976aeec37077b6bf3837a5))
|
---|
| 13 | * add type information to `socket.data` ([#4159](https://github.com/socketio/socket.io/issues/4159)) ([fe8730c](https://github.com/socketio/socket.io/commit/fe8730ca0f15bc92d5de81cf934c89c76d6af329))
|
---|
| 14 |
|
---|
| 15 |
|
---|
| 16 |
|
---|
| 17 | ## [4.3.2](https://github.com/socketio/socket.io/compare/4.3.1...4.3.2) (2021-11-08)
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | ### Bug Fixes
|
---|
| 21 |
|
---|
| 22 | * fix race condition in dynamic namespaces ([#4137](https://github.com/socketio/socket.io/issues/4137)) ([9d86397](https://github.com/socketio/socket.io/commit/9d86397243bcbb5775a29d96e5ef03e17148a8e7))
|
---|
| 23 |
|
---|
| 24 |
|
---|
| 25 | ## [4.3.1](https://github.com/socketio/socket.io/compare/4.3.0...4.3.1) (2021-10-16)
|
---|
| 26 |
|
---|
| 27 |
|
---|
| 28 | ### Bug Fixes
|
---|
| 29 |
|
---|
| 30 | * fix server attachment ([#4127](https://github.com/socketio/socket.io/issues/4127)) ([0ef2a4d](https://github.com/socketio/socket.io/commit/0ef2a4d02c9350aff163df9cb61aece89c4dac0f))
|
---|
| 31 |
|
---|
| 32 |
|
---|
| 33 | # [4.3.0](https://github.com/socketio/socket.io/compare/4.2.0...4.3.0) (2021-10-14)
|
---|
| 34 |
|
---|
| 35 |
|
---|
| 36 | ### Bug Fixes
|
---|
| 37 |
|
---|
| 38 | * **typings:** add name field to cookie option ([#4099](https://github.com/socketio/socket.io/issues/4099)) ([033c5d3](https://github.com/socketio/socket.io/commit/033c5d399a2b985afad32c1e4b0c16d764e248cd))
|
---|
| 39 | * send volatile packets with binary attachments ([dc81fcf](https://github.com/socketio/socket.io/commit/dc81fcf461cfdbb5b34b1a5a96b84373754047d5))
|
---|
| 40 |
|
---|
| 41 |
|
---|
| 42 | ### Features
|
---|
| 43 |
|
---|
| 44 | * serve ESM bundle ([60edecb](https://github.com/socketio/socket.io/commit/60edecb3bd33801803cdcba0aefbafa381a2abb3))
|
---|
| 45 |
|
---|
| 46 |
|
---|
| 47 | # [4.2.0](https://github.com/socketio/socket.io/compare/4.1.3...4.2.0) (2021-08-30)
|
---|
| 48 |
|
---|
| 49 |
|
---|
| 50 | ### Bug Fixes
|
---|
| 51 |
|
---|
| 52 | * **typings:** allow async listener in typed events ([ccfd8ca](https://github.com/socketio/socket.io/commit/ccfd8caba6d38b7ba6c5114bd8179346ed07671c))
|
---|
| 53 |
|
---|
| 54 |
|
---|
| 55 | ### Features
|
---|
| 56 |
|
---|
| 57 | * ignore the query string when serving client JavaScript ([#4024](https://github.com/socketio/socket.io/issues/4024)) ([24fee27](https://github.com/socketio/socket.io/commit/24fee27ba36485308f8e995879c10931532c814e))
|
---|
| 58 |
|
---|
| 59 |
|
---|
| 60 | ## [4.1.3](https://github.com/socketio/socket.io/compare/4.1.2...4.1.3) (2021-07-10)
|
---|
| 61 |
|
---|
| 62 |
|
---|
| 63 | ### Bug Fixes
|
---|
| 64 |
|
---|
| 65 | * fix io.except() method ([94e27cd](https://github.com/socketio/socket.io/commit/94e27cd072c8a4eeb9636f6ffbb7a21d382f36b0))
|
---|
| 66 | * remove x-sourcemap header ([a4dffc6](https://github.com/socketio/socket.io/commit/a4dffc6527f412d51a786ae5bf2e9080fe1ca63c))
|
---|
| 67 |
|
---|
| 68 |
|
---|
| 69 | ## [4.1.2](https://github.com/socketio/socket.io/compare/4.1.1...4.1.2) (2021-05-17)
|
---|
| 70 |
|
---|
| 71 |
|
---|
| 72 | ### Bug Fixes
|
---|
| 73 |
|
---|
| 74 | * **typings:** ensure compatibility with TypeScript 3.x ([0cb6ac9](https://github.com/socketio/socket.io/commit/0cb6ac95b49a27483b6f1b6402fa54b35f82e36f))
|
---|
| 75 | * ensure compatibility with previous versions of the adapter ([a2cf248](https://github.com/socketio/socket.io/commit/a2cf2486c366cb62293101c10520c57f6984a3fc))
|
---|
| 76 |
|
---|
| 77 |
|
---|
| 78 | ## [4.1.1](https://github.com/socketio/socket.io/compare/4.1.0...4.1.1) (2021-05-11)
|
---|
| 79 |
|
---|
| 80 |
|
---|
| 81 | ### Bug Fixes
|
---|
| 82 |
|
---|
| 83 | * **typings:** properly type server-side events ([b84ed1e](https://github.com/socketio/socket.io/commit/b84ed1e41c9053792caf58974c5de9395bfd509f))
|
---|
| 84 | * **typings:** properly type the adapter attribute ([891b187](https://github.com/socketio/socket.io/commit/891b1870e92d1ec38910f03bb839817e2d6be65a))
|
---|
| 85 |
|
---|
| 86 |
|
---|
| 87 | # [4.1.0](https://github.com/socketio/socket.io/compare/4.0.2...4.1.0) (2021-05-11)
|
---|
| 88 |
|
---|
| 89 |
|
---|
| 90 | ### Features
|
---|
| 91 |
|
---|
| 92 | * add support for inter-server communication ([93cce05](https://github.com/socketio/socket.io/commit/93cce05fb3faf91f21fa71212275c776aa161107))
|
---|
| 93 | * notify upon namespace creation ([499c892](https://github.com/socketio/socket.io/commit/499c89250d2db1ab7725ab2b74840e188c267c46))
|
---|
| 94 | * add a "connection_error" event ([7096e98](https://github.com/socketio/engine.io/commit/7096e98a02295a62c8ea2aa56461d4875887092d), from `engine.io`)
|
---|
| 95 | * add the "initial_headers" and "headers" events ([2527543](https://github.com/socketio/engine.io/commit/252754353a0e88eb036ebb3082e9d6a9a5f497db), from `engine.io`)
|
---|
| 96 |
|
---|
| 97 |
|
---|
| 98 | ### Performance Improvements
|
---|
| 99 |
|
---|
| 100 | * add support for the "wsPreEncoded" writing option ([dc381b7](https://github.com/socketio/socket.io/commit/dc381b72c6b2f8172001dedd84116122e4cc95b3))
|
---|
| 101 |
|
---|
| 102 |
|
---|
| 103 | ## [4.0.2](https://github.com/socketio/socket.io/compare/4.0.1...4.0.2) (2021-05-06)
|
---|
| 104 |
|
---|
| 105 |
|
---|
| 106 | ### Bug Fixes
|
---|
| 107 |
|
---|
| 108 | * **typings:** make "engine" attribute public ([b81ce4c](https://github.com/socketio/socket.io/commit/b81ce4c9d0b00666361498e2ba5e0d007d5860b8))
|
---|
| 109 | * properly export the Socket class ([d65b6ee](https://github.com/socketio/socket.io/commit/d65b6ee84c8e91deb61c3c1385eb19afa196a909))
|
---|
| 110 |
|
---|
| 111 |
|
---|
| 112 | ## [4.0.1](https://github.com/socketio/socket.io/compare/4.0.0...4.0.1) (2021-03-31)
|
---|
| 113 |
|
---|
| 114 |
|
---|
| 115 | ### Bug Fixes
|
---|
| 116 |
|
---|
| 117 | * **typings:** add fallback to untyped event listener ([#3834](https://github.com/socketio/socket.io/issues/3834)) ([a11152f](https://github.com/socketio/socket.io/commit/a11152f42b281df83409313962f60f230239c79e))
|
---|
| 118 | * **typings:** update return type from emit ([#3843](https://github.com/socketio/socket.io/issues/3843)) ([1a72ae4](https://github.com/socketio/socket.io/commit/1a72ae4fe27a14cf60916f991a2c94da91d9e54a))
|
---|
| 119 |
|
---|
| 120 |
|
---|
| 121 | # [4.0.0](https://github.com/socketio/socket.io/compare/3.1.2...4.0.0) (2021-03-10)
|
---|
| 122 |
|
---|
| 123 |
|
---|
| 124 | ### Bug Fixes
|
---|
| 125 |
|
---|
| 126 | * make io.to(...) immutable ([ac9e8ca](https://github.com/socketio/socket.io/commit/ac9e8ca6c71e00d4af45ee03f590fe56f3951186))
|
---|
| 127 |
|
---|
| 128 |
|
---|
| 129 | ### Features
|
---|
| 130 |
|
---|
| 131 | * add some utility methods ([b25495c](https://github.com/socketio/socket.io/commit/b25495c069031674da08e19aed68922c7c7a0e28))
|
---|
| 132 | * add support for typed events ([#3822](https://github.com/socketio/socket.io/issues/3822)) ([0107510](https://github.com/socketio/socket.io/commit/0107510ba8a0f148c78029d8be8919b350feb633))
|
---|
| 133 | * allow to exclude specific rooms when broadcasting ([#3789](https://github.com/socketio/socket.io/issues/3789)) ([7de2e87](https://github.com/socketio/socket.io/commit/7de2e87e888d849eb2dfc5e362af4c9e86044701))
|
---|
| 134 | * allow to pass an array to io.to(...) ([085d1de](https://github.com/socketio/socket.io/commit/085d1de9df909651de8b313cc6f9f253374b702e))
|
---|
| 135 |
|
---|
| 136 |
|
---|
[6a3a178] | 137 | ## [3.1.2](https://github.com/socketio/socket.io/compare/3.1.1...3.1.2) (2021-02-26)
|
---|
| 138 |
|
---|
| 139 |
|
---|
| 140 | ### Bug Fixes
|
---|
| 141 |
|
---|
| 142 | * ignore packets received after disconnection ([494c64e](https://github.com/socketio/socket.io/commit/494c64e44f645cbd24c645f1186d203789e84af0))
|
---|
| 143 |
|
---|
| 144 |
|
---|
| 145 | ## [3.1.1](https://github.com/socketio/socket.io/compare/3.1.0...3.1.1) (2021-02-03)
|
---|
| 146 |
|
---|
| 147 |
|
---|
| 148 | ### Bug Fixes
|
---|
| 149 |
|
---|
| 150 | * properly parse the CONNECT packet in v2 compatibility mode ([6f4bd7f](https://github.com/socketio/socket.io/commit/6f4bd7f8e7c41a075a8014565330a77c38b03a8d))
|
---|
| 151 | * **typings:** add return types and general-case overload signatures ([#3776](https://github.com/socketio/socket.io/issues/3776)) ([9e8f288](https://github.com/socketio/socket.io/commit/9e8f288ca9f14f91064b8d3cce5946f7d23d407c))
|
---|
| 152 | * **typings:** update the types of "query", "auth" and "headers" ([4f2e9a7](https://github.com/socketio/socket.io/commit/4f2e9a716d9835b550c8fd9a9b429ebf069c2895))
|
---|
| 153 |
|
---|
| 154 |
|
---|
| 155 | # [3.1.0](https://github.com/socketio/socket.io/compare/3.0.5...3.1.0) (2021-01-15)
|
---|
| 156 |
|
---|
| 157 |
|
---|
| 158 | ### Features
|
---|
| 159 |
|
---|
| 160 | * confirm a weak but matching ETag ([#3485](https://github.com/socketio/socket.io/issues/3485)) ([161091d](https://github.com/socketio/socket.io/commit/161091dd4c9e1b1610ac3d45d964195e63d92b94))
|
---|
| 161 | * **esm:** export the Namespace and Socket class ([#3699](https://github.com/socketio/socket.io/issues/3699)) ([233650c](https://github.com/socketio/socket.io/commit/233650c22209708b5fccc4349c38d2fa1b465d8f))
|
---|
| 162 | * add support for Socket.IO v2 clients ([9925746](https://github.com/socketio/socket.io/commit/9925746c8ee3a6522bd640b5d586c83f04f2f1ba))
|
---|
| 163 | * add room events ([155fa63](https://github.com/socketio/socket.io-adapter/commit/155fa6333a504036e99a33667dc0397f6aede25e))
|
---|
| 164 |
|
---|
| 165 |
|
---|
| 166 | ### Bug Fixes
|
---|
| 167 |
|
---|
| 168 | * allow integers as event names ([1c220dd](https://github.com/socketio/socket.io-parser/commit/1c220ddbf45ea4b44bc8dbf6f9ae245f672ba1b9))
|
---|
| 169 |
|
---|
| 170 |
|
---|
| 171 | ## [3.0.5](https://github.com/socketio/socket.io/compare/3.0.4...3.0.5) (2021-01-05)
|
---|
| 172 |
|
---|
| 173 |
|
---|
| 174 | ### Bug Fixes
|
---|
| 175 |
|
---|
| 176 | * properly clear timeout on connection failure ([170b739](https://github.com/socketio/socket.io/commit/170b739f147cb6c92b423729b877e242e376927d))
|
---|
| 177 |
|
---|
| 178 |
|
---|
| 179 | ### Reverts
|
---|
| 180 |
|
---|
| 181 | * restore the socket middleware functionality ([bf54327](https://github.com/socketio/socket.io/commit/bf5432742158e4d5ba2722cff4a614967dffa5b9))
|
---|
| 182 |
|
---|
| 183 |
|
---|
| 184 | ## [3.0.4](https://github.com/socketio/socket.io/compare/3.0.3...3.0.4) (2020-12-07)
|
---|
| 185 |
|
---|
| 186 |
|
---|
| 187 | ## [3.0.3](https://github.com/socketio/socket.io/compare/3.0.2...3.0.3) (2020-11-19)
|
---|
| 188 |
|
---|
| 189 |
|
---|
| 190 | ## [3.0.2](https://github.com/socketio/socket.io/compare/3.0.1...3.0.2) (2020-11-17)
|
---|
| 191 |
|
---|
| 192 |
|
---|
| 193 | ### Bug Fixes
|
---|
| 194 |
|
---|
| 195 | * merge Engine.IO options ([43705d7](https://github.com/socketio/socket.io/commit/43705d7a9149833afc69edc937ea7f8c9aabfeef))
|
---|
| 196 |
|
---|
| 197 |
|
---|
| 198 | ## [3.0.1](https://github.com/socketio/socket.io/compare/3.0.0...3.0.1) (2020-11-09)
|
---|
| 199 |
|
---|
| 200 |
|
---|
| 201 | ### Bug Fixes
|
---|
| 202 |
|
---|
| 203 | * export ServerOptions and Namespace types ([#3684](https://github.com/socketio/socket.io/issues/3684)) ([f62f180](https://github.com/socketio/socket.io/commit/f62f180edafdd56d8a8a277e092bc66df0c5f07f))
|
---|
| 204 | * **typings:** update the signature of the emit method ([50671d9](https://github.com/socketio/socket.io/commit/50671d984a81535a6a15c704546ca7465e2ea295))
|
---|
| 205 |
|
---|
| 206 |
|
---|
| 207 | # [3.0.0](https://github.com/socketio/socket.io/compare/2.3.0...3.0.0) (2020-11-05)
|
---|
| 208 |
|
---|
| 209 | ### Bug Fixes
|
---|
| 210 |
|
---|
| 211 | * close clients with no namespace ([91cd255](https://github.com/socketio/socket.io/commit/91cd255ba76ff6a780c62740f9f5cd3a76f5d7c7))
|
---|
| 212 |
|
---|
| 213 | ### Features
|
---|
| 214 |
|
---|
| 215 | * emit an Error object upon middleware error ([54bf4a4](https://github.com/socketio/socket.io/commit/54bf4a44e9e896dfb64764ee7bd4e8823eb7dc7b))
|
---|
| 216 | * serve msgpack bundle ([aa7574f](https://github.com/socketio/socket.io/commit/aa7574f88471aa30ae472a5cddf1000a8baa70fd))
|
---|
| 217 | * add support for catch-all listeners ([5c73733](https://github.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
|
---|
| 218 | * make Socket#join() and Socket#leave() synchronous ([129c641](https://github.com/socketio/socket.io/commit/129c6417bd818bc8b4e1b831644323876e627c13))
|
---|
| 219 | * remove prod dependency to socket.io-client ([7603da7](https://github.com/socketio/socket.io/commit/7603da71a535481e3fc60e38b013abf78516d322))
|
---|
| 220 | * move binary detection back to the parser ([669592d](https://github.com/socketio/socket.io/commit/669592d120409a5cf00f128070dee6d22259ba4f))
|
---|
| 221 | * add ES6 module export ([8b6b100](https://github.com/socketio/socket.io/commit/8b6b100c284ccce7d85e55659e3397f533916847))
|
---|
| 222 | * do not reuse the Engine.IO id ([2875d2c](https://github.com/socketio/socket.io/commit/2875d2cfdfa463e64cb520099749f543bbc4eb15))
|
---|
| 223 | * remove Server#set() method ([029f478](https://github.com/socketio/socket.io/commit/029f478992f59b1eb5226453db46363a570eea46))
|
---|
| 224 | * remove Socket#rooms object ([1507b41](https://github.com/socketio/socket.io/commit/1507b416d584381554d1ed23c9aaf3b650540071))
|
---|
| 225 | * remove the 'origins' option ([a8c0600](https://github.com/socketio/socket.io/commit/a8c06006098b512ba1b8b8df82777349db486f41))
|
---|
| 226 | * remove the implicit connection to the default namespace ([3289f7e](https://github.com/socketio/socket.io/commit/3289f7ec376e9ec88c2f90e2735c8ca8d01c0e97))
|
---|
| 227 | * throw upon reserved event names ([4bd5b23](https://github.com/socketio/socket.io/commit/4bd5b2339a66a5a675e20f689fff2e70ff12d236))
|
---|
| 228 |
|
---|
| 229 | ### BREAKING CHANGES
|
---|
| 230 |
|
---|
| 231 | * the Socket#use() method is removed (see [5c73733](https://github.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
|
---|
| 232 |
|
---|
| 233 | * Socket#join() and Socket#leave() do not accept a callback argument anymore.
|
---|
| 234 |
|
---|
| 235 | Before:
|
---|
| 236 |
|
---|
| 237 | ```js
|
---|
| 238 | socket.join("room1", () => {
|
---|
| 239 | io.to("room1").emit("hello");
|
---|
| 240 | });
|
---|
| 241 | ```
|
---|
| 242 |
|
---|
| 243 | After:
|
---|
| 244 |
|
---|
| 245 | ```js
|
---|
| 246 | socket.join("room1");
|
---|
| 247 | io.to("room1").emit("hello");
|
---|
| 248 | // or await socket.join("room1"); for custom adapters
|
---|
| 249 | ```
|
---|
| 250 |
|
---|
| 251 | * the "connected" map is renamed to "sockets"
|
---|
| 252 | * the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
|
---|
| 253 | * the 'origins' option is removed
|
---|
| 254 |
|
---|
| 255 | Before:
|
---|
| 256 |
|
---|
| 257 | ```js
|
---|
| 258 | new Server(3000, {
|
---|
| 259 | origins: ["https://example.com"]
|
---|
| 260 | });
|
---|
| 261 | ```
|
---|
| 262 |
|
---|
| 263 | The 'origins' option was used in the allowRequest method, in order to
|
---|
| 264 | determine whether the request should pass or not. And the Engine.IO
|
---|
| 265 | server would implicitly add the necessary Access-Control-Allow-xxx
|
---|
| 266 | headers.
|
---|
| 267 |
|
---|
| 268 | After:
|
---|
| 269 |
|
---|
| 270 | ```js
|
---|
| 271 | new Server(3000, {
|
---|
| 272 | cors: {
|
---|
| 273 | origin: "https://example.com",
|
---|
| 274 | methods: ["GET", "POST"],
|
---|
| 275 | allowedHeaders: ["content-type"]
|
---|
| 276 | }
|
---|
| 277 | });
|
---|
| 278 | ```
|
---|
| 279 |
|
---|
| 280 | The already existing 'allowRequest' option can be used for validation:
|
---|
| 281 |
|
---|
| 282 | ```js
|
---|
| 283 | new Server(3000, {
|
---|
| 284 | allowRequest: (req, callback) => {
|
---|
| 285 | callback(null, req.headers.referer.startsWith("https://example.com"));
|
---|
| 286 | }
|
---|
| 287 | });
|
---|
| 288 | ```
|
---|
| 289 |
|
---|
| 290 | * Socket#rooms is now a Set instead of an object
|
---|
| 291 |
|
---|
| 292 | * Namespace#connected is now a Map instead of an object
|
---|
| 293 |
|
---|
| 294 | * there is no more implicit connection to the default namespace:
|
---|
| 295 |
|
---|
| 296 | ```js
|
---|
| 297 | // client-side
|
---|
| 298 | const socket = io("/admin");
|
---|
| 299 |
|
---|
| 300 | // server-side
|
---|
| 301 | io.on("connect", socket => {
|
---|
| 302 | // not triggered anymore
|
---|
| 303 | })
|
---|
| 304 |
|
---|
| 305 | io.use((socket, next) => {
|
---|
| 306 | // not triggered anymore
|
---|
| 307 | });
|
---|
| 308 |
|
---|
| 309 | io.of("/admin").use((socket, next) => {
|
---|
| 310 | // triggered
|
---|
| 311 | });
|
---|
| 312 | ```
|
---|
| 313 |
|
---|
| 314 | * the Server#set() method was removed
|
---|
| 315 |
|
---|
| 316 | This method was kept for backward-compatibility with pre-1.0 versions.
|
---|
| 317 |
|
---|
| 318 |
|
---|
| 319 | # [3.0.0-rc4](https://github.com/socketio/socket.io/compare/3.0.0-rc3...3.0.0-rc4) (2020-10-30)
|
---|
| 320 |
|
---|
| 321 |
|
---|
| 322 | ### Features
|
---|
| 323 |
|
---|
| 324 | * emit an Error object upon middleware error ([54bf4a4](https://github.com/socketio/socket.io/commit/54bf4a44e9e896dfb64764ee7bd4e8823eb7dc7b))
|
---|
| 325 | * serve msgpack bundle ([aa7574f](https://github.com/socketio/socket.io/commit/aa7574f88471aa30ae472a5cddf1000a8baa70fd))
|
---|
| 326 |
|
---|
| 327 |
|
---|
| 328 |
|
---|
| 329 | # [3.0.0-rc3](https://github.com/socketio/socket.io/compare/3.0.0-rc2...3.0.0-rc3) (2020-10-26)
|
---|
| 330 |
|
---|
| 331 |
|
---|
| 332 | ### Features
|
---|
| 333 |
|
---|
| 334 | * add support for catch-all listeners ([5c73733](https://github.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
|
---|
| 335 | * make Socket#join() and Socket#leave() synchronous ([129c641](https://github.com/socketio/socket.io/commit/129c6417bd818bc8b4e1b831644323876e627c13))
|
---|
| 336 | * remove prod dependency to socket.io-client ([7603da7](https://github.com/socketio/socket.io/commit/7603da71a535481e3fc60e38b013abf78516d322))
|
---|
| 337 |
|
---|
| 338 |
|
---|
| 339 | ### BREAKING CHANGES
|
---|
| 340 |
|
---|
| 341 | * the Socket#use() method is removed (see [5c73733](https://github.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
|
---|
| 342 |
|
---|
| 343 | * Socket#join() and Socket#leave() do not accept a callback argument anymore.
|
---|
| 344 |
|
---|
| 345 | Before:
|
---|
| 346 |
|
---|
| 347 | ```js
|
---|
| 348 | socket.join("room1", () => {
|
---|
| 349 | io.to("room1").emit("hello");
|
---|
| 350 | });
|
---|
| 351 | ```
|
---|
| 352 |
|
---|
| 353 | After:
|
---|
| 354 |
|
---|
| 355 | ```js
|
---|
| 356 | socket.join("room1");
|
---|
| 357 | io.to("room1").emit("hello");
|
---|
| 358 | // or await socket.join("room1"); for custom adapters
|
---|
| 359 | ```
|
---|
| 360 |
|
---|
| 361 |
|
---|
| 362 |
|
---|
| 363 | # [3.0.0-rc2](https://github.com/socketio/socket.io/compare/3.0.0-rc1...3.0.0-rc2) (2020-10-15)
|
---|
| 364 |
|
---|
| 365 |
|
---|
| 366 | ### Bug Fixes
|
---|
| 367 |
|
---|
| 368 | * close clients with no namespace ([91cd255](https://github.com/socketio/socket.io/commit/91cd255ba76ff6a780c62740f9f5cd3a76f5d7c7))
|
---|
| 369 |
|
---|
| 370 |
|
---|
| 371 | ### Code Refactoring
|
---|
| 372 |
|
---|
| 373 | * remove duplicate _sockets map ([8a5db7f](https://github.com/socketio/socket.io/commit/8a5db7fa36a075da75cde43cd4fb6382b7659953))
|
---|
| 374 |
|
---|
| 375 |
|
---|
| 376 | ### Features
|
---|
| 377 |
|
---|
| 378 | * move binary detection back to the parser ([669592d](https://github.com/socketio/socket.io/commit/669592d120409a5cf00f128070dee6d22259ba4f))
|
---|
| 379 |
|
---|
| 380 |
|
---|
| 381 | ### BREAKING CHANGES
|
---|
| 382 |
|
---|
| 383 | * the "connected" map is renamed to "sockets"
|
---|
| 384 | * the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
|
---|
| 385 |
|
---|
| 386 |
|
---|
| 387 |
|
---|
| 388 | # [3.0.0-rc1](https://github.com/socketio/socket.io/compare/2.3.0...3.0.0-rc1) (2020-10-13)
|
---|
| 389 |
|
---|
| 390 |
|
---|
| 391 | ### Features
|
---|
| 392 |
|
---|
| 393 | * add ES6 module export ([8b6b100](https://github.com/socketio/socket.io/commit/8b6b100c284ccce7d85e55659e3397f533916847))
|
---|
| 394 | * do not reuse the Engine.IO id ([2875d2c](https://github.com/socketio/socket.io/commit/2875d2cfdfa463e64cb520099749f543bbc4eb15))
|
---|
| 395 | * remove Server#set() method ([029f478](https://github.com/socketio/socket.io/commit/029f478992f59b1eb5226453db46363a570eea46))
|
---|
| 396 | * remove Socket#rooms object ([1507b41](https://github.com/socketio/socket.io/commit/1507b416d584381554d1ed23c9aaf3b650540071))
|
---|
| 397 | * remove the 'origins' option ([a8c0600](https://github.com/socketio/socket.io/commit/a8c06006098b512ba1b8b8df82777349db486f41))
|
---|
| 398 | * remove the implicit connection to the default namespace ([3289f7e](https://github.com/socketio/socket.io/commit/3289f7ec376e9ec88c2f90e2735c8ca8d01c0e97))
|
---|
| 399 | * throw upon reserved event names ([4bd5b23](https://github.com/socketio/socket.io/commit/4bd5b2339a66a5a675e20f689fff2e70ff12d236))
|
---|
| 400 |
|
---|
| 401 |
|
---|
| 402 | ### BREAKING CHANGES
|
---|
| 403 |
|
---|
| 404 | * the 'origins' option is removed
|
---|
| 405 |
|
---|
| 406 | Before:
|
---|
| 407 |
|
---|
| 408 | ```js
|
---|
| 409 | new Server(3000, {
|
---|
| 410 | origins: ["https://example.com"]
|
---|
| 411 | });
|
---|
| 412 | ```
|
---|
| 413 |
|
---|
| 414 | The 'origins' option was used in the allowRequest method, in order to
|
---|
| 415 | determine whether the request should pass or not. And the Engine.IO
|
---|
| 416 | server would implicitly add the necessary Access-Control-Allow-xxx
|
---|
| 417 | headers.
|
---|
| 418 |
|
---|
| 419 | After:
|
---|
| 420 |
|
---|
| 421 | ```js
|
---|
| 422 | new Server(3000, {
|
---|
| 423 | cors: {
|
---|
| 424 | origin: "https://example.com",
|
---|
| 425 | methods: ["GET", "POST"],
|
---|
| 426 | allowedHeaders: ["content-type"]
|
---|
| 427 | }
|
---|
| 428 | });
|
---|
| 429 | ```
|
---|
| 430 |
|
---|
| 431 | The already existing 'allowRequest' option can be used for validation:
|
---|
| 432 |
|
---|
| 433 | ```js
|
---|
| 434 | new Server(3000, {
|
---|
| 435 | allowRequest: (req, callback) => {
|
---|
| 436 | callback(null, req.headers.referer.startsWith("https://example.com"));
|
---|
| 437 | }
|
---|
| 438 | });
|
---|
| 439 | ```
|
---|
| 440 |
|
---|
| 441 | * Socket#rooms is now a Set instead of an object
|
---|
| 442 |
|
---|
| 443 | * Namespace#connected is now a Map instead of an object
|
---|
| 444 |
|
---|
| 445 | * there is no more implicit connection to the default namespace:
|
---|
| 446 |
|
---|
| 447 | ```js
|
---|
| 448 | // client-side
|
---|
| 449 | const socket = io("/admin");
|
---|
| 450 |
|
---|
| 451 | // server-side
|
---|
| 452 | io.on("connect", socket => {
|
---|
| 453 | // not triggered anymore
|
---|
| 454 | })
|
---|
| 455 |
|
---|
| 456 | io.use((socket, next) => {
|
---|
| 457 | // not triggered anymore
|
---|
| 458 | });
|
---|
| 459 |
|
---|
| 460 | io.of("/admin").use((socket, next) => {
|
---|
| 461 | // triggered
|
---|
| 462 | });
|
---|
| 463 | ```
|
---|
| 464 |
|
---|
| 465 | * the Server#set() method was removed
|
---|
| 466 |
|
---|
| 467 | This method was kept for backward-compatibility with pre-1.0 versions.
|
---|
| 468 |
|
---|