From c3d466697ee880c66678723f80b0abd3c5105c10 Mon Sep 17 00:00:00 2001 From: Amin Yahyaabadi Date: Mon, 12 Aug 2024 21:30:03 -0700 Subject: [PATCH] chore: v6.0.0 Closes #529 --- CHANGELOG.md | 76 ---------------------------------------------------- README.md | 6 +---- package.json | 2 +- 3 files changed, 2 insertions(+), 82 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 0d382666..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,76 +0,0 @@ -## Unreleased - -- Improved TypeScript compatibility by supplying version-specific types for - situations where generated TypeScript typings are not backwards compatible. - This reduces the minimum required TypeScript version to 3.0. - -### v6.0.0-beta.6 - -- BREAKING: When inadvertedly executing two concurrent send() or receive() - operations the errno attribute of the error thrown is now EBUSY instead of - EAGAIN. - -- Error messages for EBUSY are more specific. - -- Compatibility mode will now provide an implementation for - bindSync()/unbindSync() if the 'deasync' package is available. - -- Produce a warning when messages are still queued at process exit and context - termination takes more than 500ms. - -- Bump version requirement to Node.js 10.2, but reduce N-API version to 3 to - support more 10.x Node.js versions. - -### v6.0.0-beta.5 - -- Check if properties are defined before defining them. This ensures - compatibility with alternative file loaders, notably by the Jest test - framework. - -- Performance of calling methods & validating arguments has been improved. - -- Header files from node-addon-api are now bundled to reduce runtime - depedencies. - -### v6.0.0-beta.4 - -- Break out of busy loops automatically when the number of synchronous I/O - operations moves beyond a built-in threshold. This avoids the ZeroMQ - background I/O process(es) starving the Node.js event loop when it can process - messages faster than the application. This could have caused decreased - responsiveness and/or high memory usage. This only happens when - sending/receiving messages as quickly as possible, such as in a benchmark or - in test code. - -- Fixed a memory leak in socket construction that would manifest itself when - repeatedly creating many sockets. - -### v6.0.0-beta.3 - -- Error details have been added to the "handshake:error:protocol" and - "handshake:error:auth" events. - -- Reading from event observers now prevents the Node process from exiting, even - if the underlying socket is no longer being used. - -- Reading or writing on unbound and unconnected sockets now prevents the Node - process from exiting. - -### v6.0.0-beta.2 - -- Fix omission of "zeromq/v5-compat" export. - -### v6.0.0-beta.1 - -- BREAKING: Complete rewrite of ZeroMQ.js with a modern and safe API. This - version is based on ZeroMQ-NG version v5.0.0-beta.27. A compatibility layer - for existing users of versions 5.x or earlier of ZeroMQ.js is available as - "zeromq/v5-compat". - -### Previous changes - -- See https://github.com/rolftimmermans/zeromq-ng/blob/master/CHANGELOG.md for - the changelog of the next generation API before the merge back into ZeroMQ.js. - -- See https://github.com/zeromq/zeromq.js/blob/5.x/History.md for the changelog - of the previous API before the merge of ZeroMQ-NG. diff --git a/README.md b/README.md index 8f9e8169..d5fa5565 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,6 @@ [![Latest version](https://img.shields.io/npm/v/zeromq?label=version)](https://www.npmjs.com/package/zeromq) -## ⚠️ Version 6.0.0 (in beta) features a brand new API that solves many fundamental issues and is recommended for new projects. ⚠️ - -## ⚠️ For the current stable version see the [5.x branch](https://github.com/zeromq/zeromq.js/tree/5.x) ⚠️ - [ØMQ](http://zeromq.org) bindings for Node.js. The goals of this library are: - Semantically similar to the [native](https://github.com/zeromq/libzmq) ØMQ @@ -43,7 +39,7 @@ Install **ZeroMQ.js** with prebuilt binaries: ```sh -npm install zeromq@6.0.0-beta.20 +npm install zeromq ``` Requirements for using prebuilt binaries: diff --git a/package.json b/package.json index aaeae895..48b9a7e0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "zeromq", - "version": "6.0.0-beta.21", + "version": "6.0.0", "description": "Next-generation ZeroMQ bindings for Node.js", "main": "lib/index.js", "types": "lib/index.d.ts",