6.2.1

Links

• Diff: 6.2.0...6.2.1
• Server release: -
• ws version: ~8.2.3

6.2.0

Features

• add details to the "close" event (b9252e2)

The close 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("close", (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); // ""
});

Note: the error object was already included before this commit and is kept for backward compatibility.

• slice write buffer according to the maxPayload value (46fdc2f)

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.

Links

• Diff: 6.1.1...6.2.0
• Server release: 6.2.0
• ws version: ~8.2.3

6.1.1

Bug Fixes

• add package name in nested package.json (6e798fb)
• fix vite build for CommonJS users (c557707)

Links

• Diff: 6.1.0...6.1.1
• Server release: -
• ws version: ~8.2.3

6.0.3

Some bug fixes were backported from master, to be included by the latest socket.io-client version.

Bug Fixes

• add package name in nested package.json (32511ee)
• fix vite build for CommonJS users (9fcaf58)

Links

• Diff: 6.0.2...6.0.3
• Server release: -
• ws version: ~8.2.3

6.1.0

The minor bump is due to changes on the server side.

Bug Fixes

• typings: allow any value in the query option (018e1af)
• typings: allow port to be a number (#680) (8f68f77)

Links

• Diff: 6.0.2...6.1.0
• Server release: 6.1.0
• ws version: ~8.2.3

6.0.2

Bug Fixes

• bundle: fix vite build (faa9f31)

Links

• Diff: 6.0.1...6.0.2
• Server release: -
• ws version: ~8.2.3

6.0.1

Bug Fixes

• fix usage with vite (4971914)

Links

• Diff: 6.0.0...6.0.1
• Server release: -
• ws version: ~8.2.3

6.0.0

This major release contains three important changes:

• the codebase was migrated to TypeScript (7245b80)
• rollup is now used instead of webpack to create the bundles (27de300)
• code that provided support for ancient browsers (think IE8) was removed (c656192 and b2c7381)

There is now three distinct builds (in the build/ directory):

• CommonJS
• ESM with debug
• ESM without debug (rationale here: 00d7e7d)

And three bundles (in the dist/ directory) :

• engine.io.js: unminified UMD bundle
• engine.io.min.js: minified UMD bundle
• engine.io.esm.min.js: ESM bundle

Please note that the communication protocol was not updated, so a v5 client will be able to reach a v6 server (and vice-versa).

Reference: https://github.com/socketio/engine.io-protocol

Features

• provide an ESM build without debug (00d7e7d)

BREAKING CHANGES

• the enableXDR option is removed (c656192)
• the jsonp and forceJSONP options are removed (b2c7381)

Links

• Diff: 5.2.0...6.0.0
• Server release: 6.0.0
• ws version: ~8.2.3 (diff)

5.2.0

Features

• add an option to use native timer functions (#672) (5d1d5be)

Links

• Diff: 5.1.2...5.2.0
• Server release: 5.2.0
• ws version: ~7.4.2

3.3.3

Bug Fixes

• bump xmlhttprequest-ssl to fix CVE-2021-31597 (d529e86)

Links

• Diff: 3.3.2...3.3.3
• Server release: -
• ws version: ~6.1.0