Skip to content

Latest commit

 

History

History
236 lines (110 loc) · 9.95 KB

CHANGELOG.md

File metadata and controls

236 lines (110 loc) · 9.95 KB
Raw

History

Version Release date
5.2.3 July 2024
5.2.2 February 2024
5.2.1 August 2023
5.2.0 July 2023
5.1.0 June 2023
5.0.7 May 2023
5.0.6 January 2023
5.0.5 January 2023
5.0.4 April 2022
5.0.3 January 2022
5.0.2 November 2021
5.0.1 October 2021
5.0.0 (major: TypeScript rewrite) October 2021
4.0.3 August 2021
4.0.2 December 2020
2.2.1 (from the 2.2.x branch) September 2020
4.0.1 September 2020
4.0.0 (major: Engine.IO v4) September 2020
2.2.0 September 2019

Release notes

5.2.3 (2024-07-11)

Bug Fixes

  • do not expose the TransformStream type (f9cb983)

5.2.2 (2024-02-05)

Bug Fixes

  • typescript: properly import the TransformStream type (0305b4a)

5.2.1 (2023-08-01)

The format of the WebTransport frame has been slightly updated.

5.2.0 (2023-07-31)

Features

  • prepend a header to each WebTransport chunk (6142324)

5.1.0 (2023-06-11)

Features

  • implement WebTransport-related encoding/decoding (bed70a4)

5.0.7 (2023-05-24)

The CommonJS build now includes the TypeScript declarations too, in order to be compatible the "node16" moduleResolution.

5.0.6 (2023-01-16)

The compile script was not run before publishing 5.0.5, so the esm build did not include the latest changes.

5.0.5 (2023-01-06)

Bug Fixes

  • properly encode empty buffer in base64 encoding (#131) (351ba82)

5.0.4 (2022-04-30)

Bug Fixes

  • add missing file extension for ESM import (a421bbe)
  • typings: update the type of RawData (039b45c)

5.0.3 (2022-01-17)

5.0.2 (2021-11-14)

Bug Fixes

  • add package name in nested package.json (7e27159)
  • fix vite build for CommonJS users (5f22ed0)

5.0.1 (2021-10-15)

Bug Fixes

5.0.0 (2021-10-04)

This release includes the migration to TypeScript. The major bump is due to the new "exports" field in the package.json file.

See also: https://nodejs.org/api/packages.html#packages_package_entry_points

4.0.3 (2021-08-29)

Bug Fixes

  • respect the offset and length of TypedArray objects (6d7dd76)

4.0.2 (2020-12-07)

Bug Fixes

  • add base64-arraybuffer as prod dependency (2ccdeb2)

2.2.1 (2020-09-30)

4.0.1 (2020-09-10)

Bug Fixes

  • use a terser-compatible representation of the separator (886f9ea)

4.0.0 (2020-09-08)

This major release contains the necessary changes for the version 4 of the Engine.IO protocol. More information about the new version can be found there.

Encoding changes between v3 and v4:

  • encodePacket with string

    • input: { type: "message", data: "hello" }
    • output in v3: "4hello"
    • output in v4: "4hello"

  • encodePacket with binary

    • input: { type: 'message', data: <Buffer 01 02 03> }
    • output in v3: <Buffer 04 01 02 03>
    • output in v4: <Buffer 01 02 03>

  • encodePayload with strings

    • input: [ { type: 'message', data: 'hello' }, { type: 'message', data: '€€€' } ]
    • output in v3: "6:4hello4:4€€€"
    • output in v4: "4hello\x1e4€€€"

  • encodePayload with string and binary

    • input: [ { type: 'message', data: 'hello' }, { type: 'message', data: <Buffer 01 02 03> } ]
    • output in v3: <Buffer 00 06 ff 34 68 65 6c 6c 6f 01 04 ff 04 01 02 03>
    • output in v4: "4hello\x1ebAQID"

Please note that the parser is now dependency-free! This should help reduce the size of the browser bundle.

Bug Fixes

  • keep track of the buffer initial length (8edf2d1)

Features

  • restore the upgrade mechanism (6efedfa)

4.0.0-alpha.1 (2020-05-19)

Features

  • implement the version 4 of the protocol (cab7db0)

4.0.0-alpha.0 (2020-02-04)

Bug Fixes

  • properly decode binary packets (5085373)

Features

  • remove packet type when encoding binary packets (a947ae5)

BREAKING CHANGES

  • the packet containing binary data will now be sent without any transformation

Protocol v3: { type: 'message', data: <Buffer 01 02 03> } => <Buffer 04 01 02 03> Protocol v4: { type: 'message', data: <Buffer 01 02 03> } => <Buffer 01 02 03>

2.2.0 (2019-09-13)

  • [refactor] Use Buffer.allocUnsafe instead of new Buffer (#104) (aedf8eb), closes #104

BREAKING CHANGES

  • drop support for Node.js 4 (since Buffer.allocUnsafe was added in v5.10.0)

Reference: https://nodejs.org/docs/latest/api/buffer.html#buffer_class_method_buffer_allocunsafe_size