Repository navigation
DecompressionStream and CompressionStream are documented as node v16.7.0 feature, but aren't available in any stable release #39895
Description
Version
v16.7.0
Platform
No response
Subsystem
docs
What steps will reproduce the bug?
- https://nodejs.org/api/webstreams.html?expand=1#webstreams_class_compressionstream claims "v16.7.0"
- https://nodejs.org/api/webstreams.html?expand=1#webstreams_class_decompressionstream claims "v16.7.0"
This is incorrect, because they were added in 09ad64d which doesn't have a stable release yet (commit is only part of the master branch).
So this isn't even part of v16.8.0 yet:
$ node
Welcome to Node.js v16.8.0.
Type ".help" for more information.
> const stream_web = require('stream/web');
undefined
> stream_web.TransformStream
[class TransformStream]
> stream_web.DecompressionStream
undefined
> stream_web.CompressionStream
undefined
How often does it reproduce? Is there a required condition?
No response
What is the expected behavior?
Shouldn't appear in documentation, or at least be documented as unimplemented in stable versions.
Entries with added: REPLACEME shouldn't be shown in docs (certainly not with a made-up version number).
I assume that "v16.7.0" for "REPLACEME" is used as an outdated placeholder as "next release version" somewhere.
This might also affect other classes like TextDecoderStream and TextEncoderStream which are available in stable releases, but still use "REPLACEME".
What do you see instead?
No response
Additional information
No response
Activity
Ayase-252 commentedon Aug 26, 2021
It seems that the document was released in f57a0e4, however, it is not in the origin PR #39594.
lpinca commentedon Aug 26, 2021
It seems to be a documentation issue. 09ad64d has not been backported to v16.x yet.
jasnell commentedon Aug 26, 2021
Yeah, looks like the backport commit picked up the wrong docs. Odd. Hopefully 09ad64d will get backported soon. Not entirely sure why it hasn't yet.
targos commentedon Aug 26, 2021
Just because nobody took the time to do it.
doc: remove {C,Dec}ompressionStream documentation
lpinca commentedon Sep 6, 2021
#39899 landed in 9e782eb. I'm closing this.