changelogs.md


learnboost/socket.io-client

Repository  -  API  -  Source

4.2.0

August 30, 2021

Bug Fixes

  • typings: allow async listener in typed events (66e00b7)
  • allow to set randomizationFactor to 0 (#1447) (dfb46b5)

Features

  • add an option to use native timer functions (#1479) (4e1b656)

4.1.3

July 10, 2021

4.1.2

May 17, 2021

Bug Fixes

  • typings: add missing closeOnBeforeunload option (#1469) (35d27df)
  • typings: add missing requestTimeout option (#1467) (c8dfbb1)

4.1.1

May 11, 2021

There were some minor bug fixes on the server side, which mandate a client bump.

4.1.0

May 11, 2021

Features

  • add the "closeOnBeforeunload" option (dcb85e9, from engine.io-client)

4.0.2

May 6, 2021

Bug Fixes

  • typings: add fallback to untyped event listener (5394669)
  • ensure buffered events are sent in order (34f822f)
  • ensure connections are properly multiplexed (dd2a8fc)
  • properly export the Socket class (e20d487)

4.0.1

March 31, 2021

Bug Fixes

  • typings: make auth property public (#1455) (c150223)
  • typings: update definition to match wrapper.mjs (#1456) (48f573f)

4.0.0

March 10, 2021

The major bump is due to some breaking changes on the server side.

Bug Fixes

  • bundle: restore support for JS modules (43613d1)

Features

  • add autoUnref option (6abfa1f)
  • add support for typed events (5902365)

3.1.2

February 26, 2021

Bug Fixes

  • restore support for web workers (13b32b3)
  • silently close the transport in the beforeunload hook (ed48b5d, from engine.io-client)

3.1.1

February 3, 2021

Bug Fixes

  • include the path in the manager ID (7a0c2b5)
  • remove polyfill for process in the bundle (61afc5d)
  • typings: add return types and general-case overload signatures (#1440) (47f917a)
  • typings: fix the type of the "query" option (#1439) (f02ab3b)

3.1.0

January 15, 2021

Bug Fixes

3.0.5

January 5, 2021

Bug Fixes

  • emit a connect_error event upon connection failure (53c7374)
  • typings: make sendBuffer and receiveBuffer public (b83f89c)

3.0.4

December 7, 2020

Bug Fixes

3.0.3

November 19, 2020

Bug Fixes

  • properly export io in ES modules wrapper (bec1524)

3.0.2

November 17, 2020

Bug Fixes

  • typings: export withCredentials option (7193078)
  • typings: export ManagerOptions (#1398) (96cd2c9)
  • add io as named exports (7b3ec9f)

3.0.1

November 9, 2020

Bug Fixes

  • typings: export Socket and SocketOptions types (#1394) (19ab1e9)

3.0.0

November 5, 2020

Code Refactoring

  • rename ERROR to CONNECT_ERROR (13e1db7)

Features

  • emit an Error object upon middleware error (0939395)
  • add bundle with msgpack parser (71d6048)
  • add support for catch-all listeners (55f464f)
  • add volatile events (7ddad2c)
  • move binary detection back to the parser (1789094)
  • add ES6 module export (cbabb03)
  • do not reuse the Engine.IO id (bbe94ad)
  • remove the implicit connection to the default namespace (249e0be)
  • split the events of the Manager and Socket (132f8ec)
  • throw upon reserved event names (6494f61)

BREAKING CHANGES

  • the Socket instance will now emit a "connect_error" event instead of "error" (which is not a reserved event anymore)
// 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", () => {
  // ...
});

3.0.0-rc4

October 30, 2020

Features

  • emit an Error object upon middleware error (0939395)

3.0.0-rc3

October 26, 2020

Code Refactoring

  • rename ERROR to CONNECT_ERROR (13e1db7)

Features

  • add bundle with msgpack parser (71d6048)
  • add support for catch-all listeners (55f464f)
  • add volatile events (7ddad2c)

BREAKING CHANGES

  • the Socket instance will now emit a "connect_error" event instead of "error" (which is not a reserved event anymore)
// before
socket.on("error", () => {});

// after
socket.on("connect_error", () => {});

3.0.0-rc2

October 15, 2020

Features

  • move binary detection back to the parser (1789094)

BREAKING CHANGES

  • the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.

3.0.0-rc1

October 13, 2020

Features

  • add ES6 module export (cbabb03)
  • do not reuse the Engine.IO id (bbe94ad)
  • remove the implicit connection to the default namespace (249e0be)
  • split the events of the Manager and Socket (132f8ec)
  • throw upon reserved event names (6494f61)

BREAKING CHANGES

  • 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", () => {
  // ...
});

2.3.1

September 30, 2020

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.

Bug Fixes

  • fix reconnection after opening socket asynchronously (#1253) (050108b)