diff options
| -rw-r--r-- | doc/api/deprecations.md | 5 | ||||
| -rw-r--r-- | lib/zlib.js | 11 | ||||
| -rw-r--r-- | test/parallel/test-zlib-bytes-read.js | 6 |
3 files changed, 17 insertions, 5 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index ca23a4fa32..19f96099f3 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2056,12 +2056,15 @@ core and obsoleted by the removal of NPN (Next Protocol Negotiation) support. ### DEP0108: zlib.bytesRead <!-- YAML changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/23308 + description: Runtime deprecation. - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/19414 description: Documentation-only deprecation. --> -Type: Documentation-only +Type: Runtime Deprecated alias for [`zlib.bytesWritten`][]. This original name was chosen because it also made sense to interpret the value as the number of bytes diff --git a/lib/zlib.js b/lib/zlib.js index 6ec1d680d8..c97da5dd30 100644 --- a/lib/zlib.js +++ b/lib/zlib.js @@ -29,6 +29,7 @@ const { } = require('internal/errors').codes; const Transform = require('_stream_transform'); const { + deprecate, _extend, inherits, types: { @@ -334,12 +335,14 @@ Object.defineProperty(Zlib.prototype, '_closed', { Object.defineProperty(Zlib.prototype, 'bytesRead', { configurable: true, enumerable: true, - get() { + get: deprecate(function() { return this.bytesWritten; - }, - set(value) { + }, 'zlib.bytesRead is deprecated and will change its meaning in the ' + + 'future. Use zlib.bytesWritten instead.', 'DEP0108'), + set: deprecate(function(value) { this.bytesWritten = value; - } + }, 'Setting zlib.bytesRead is deprecated. ' + + 'This feature will be removed in the future.', 'DEP0108') }); // This callback is used by `.params()` to wait until a full flush happened diff --git a/test/parallel/test-zlib-bytes-read.js b/test/parallel/test-zlib-bytes-read.js index 493478e78d..e8983efc45 100644 --- a/test/parallel/test-zlib-bytes-read.js +++ b/test/parallel/test-zlib-bytes-read.js @@ -21,6 +21,12 @@ function createWriter(target, buffer) { return writer; } +common.expectWarning( + 'DeprecationWarning', + 'zlib.bytesRead is deprecated and will change its meaning in the ' + + 'future. Use zlib.bytesWritten instead.', + 'DEP0108'); + for (const method of [ ['createGzip', 'createGunzip', false], ['createGzip', 'createUnzip', false], |