Commit e225f00
authored
zlib: remove zlib.bytesRead
Use `zlib.bytesWritten` instead.
PR-URL: #55020
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent f805d0b commit e225f00
4 files changed
Lines changed: 4 additions & 141 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2290,6 +2290,9 @@ core and obsoleted by the removal of NPN (Next Protocol Negotiation) support. | |||
| 2290 | 2290 | ||
| 2291 | 2291 | <!-- YAML | |
| 2292 | 2292 | changes: | |
| 2293 | + - version: REPLACEME | ||
| 2294 | + pr-url: https://github.com/nodejs/node/pull/55020 | ||
| 2295 | + description: End-of-Life. | ||
| 2293 | 2296 | - version: v11.0.0 | |
| 2294 | 2297 | pr-url: https://github.com/nodejs/node/pull/23308 | |
| 2295 | 2298 | description: Runtime deprecation. | |
@@ -2298,7 +2301,7 @@ changes: | |||
| 2298 | 2301 | description: Documentation-only deprecation. | |
| 2299 | 2302 | --> | |
| 2300 | 2303 | ||
| 2301 | - Type: Runtime | ||
| 2304 | + Type: End-of-Life | ||
| 2302 | 2305 | ||
| 2303 | 2306 | Deprecated alias for [`zlib.bytesWritten`][]. This original name was chosen | |
| 2304 | 2307 | because it also made sense to interpret the value as the number of bytes | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -684,22 +684,6 @@ base class of the compressor/decompressor classes. | |||
| 684 | 684 | This class inherits from [`stream.Transform`][], allowing `node:zlib` objects to | |
| 685 | 685 | be used in pipes and similar stream operations. | |
| 686 | 686 | ||
| 687 | - ### `zlib.bytesRead` | ||
| 688 | - | ||
| 689 | - <!-- YAML | ||
| 690 | - added: v8.1.0 | ||
| 691 | - deprecated: v10.0.0 | ||
| 692 | - --> | ||
| 693 | - | ||
| 694 | - > Stability: 0 - Deprecated: Use [`zlib.bytesWritten`][] instead. | ||
| 695 | - | ||
| 696 | - * {number} | ||
| 697 | - | ||
| 698 | - Deprecated alias for [`zlib.bytesWritten`][]. This original name was chosen | ||
| 699 | - because it also made sense to interpret the value as the number of bytes | ||
| 700 | - read by the engine, but is inconsistent with other streams in Node.js that | ||
| 701 | - expose values under these names. | ||
| 702 | - | ||
| 703 | 687 | ### `zlib.bytesWritten` | |
| 704 | 688 | ||
| 705 | 689 | <!-- YAML | |
@@ -1307,7 +1291,6 @@ Decompress a chunk of data with [`Unzip`][]. | |||
| 1307 | 1291 | [`buffer.kMaxLength`]: buffer.md#bufferkmaxlength | |
| 1308 | 1292 | [`deflateInit2` and `inflateInit2`]: https://zlib.net/manual.html#Advanced | |
| 1309 | 1293 | [`stream.Transform`]: stream.md#class-streamtransform | |
| 1310 | - [`zlib.bytesWritten`]: #zlibbyteswritten | ||
| 1311 | 1294 | [convenience methods]: #convenience-methods | |
| 1312 | 1295 | [zlib documentation]: https://zlib.net/manual.html#Constants | |
| 1313 | 1296 | [zlib.createGzip example]: #zlib | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -46,9 +46,6 @@ const { | |||
| 46 | 46 | genericNodeError, | |
| 47 | 47 | } = require('internal/errors'); | |
| 48 | 48 | const { Transform, finished } = require('stream'); | |
| 49 | - const { | ||
| 50 | - deprecate, | ||
| 51 | - } = require('internal/util'); | ||
| 52 | 49 | const { | |
| 53 | 50 | isArrayBufferView, | |
| 54 | 51 | isAnyArrayBuffer, | |
@@ -271,24 +268,6 @@ ObjectDefineProperty(ZlibBase.prototype, '_closed', { | |||
| 271 | 268 | }, | |
| 272 | 269 | }); | |
| 273 | 270 | ||
| 274 | - // `bytesRead` made sense as a name when looking from the zlib engine's | ||
| 275 | - // perspective, but it is inconsistent with all other streams exposed by Node.js | ||
| 276 | - // that have this concept, where it stands for the number of bytes read | ||
| 277 | - // *from* the stream (that is, net.Socket/tls.Socket & file system streams). | ||
| 278 | - ObjectDefineProperty(ZlibBase.prototype, 'bytesRead', { | ||
| 279 | - __proto__: null, | ||
| 280 | - configurable: true, | ||
| 281 | - enumerable: true, | ||
| 282 | - get: deprecate(function() { | ||
| 283 | - return this.bytesWritten; | ||
| 284 | - }, 'zlib.bytesRead is deprecated and will change its meaning in the ' + | ||
| 285 | - 'future. Use zlib.bytesWritten instead.', 'DEP0108'), | ||
| 286 | - set: deprecate(function(value) { | ||
| 287 | - this.bytesWritten = value; | ||
| 288 | - }, 'Setting zlib.bytesRead is deprecated. ' + | ||
| 289 | - 'This feature will be removed in the future.', 'DEP0108'), | ||
| 290 | - }); | ||
| 291 | - | ||
| 292 | 271 | /** | |
| 293 | 272 | * @this ZlibBase | |
| 294 | 273 | * @returns {void} | |
This file was deleted.
0 commit comments