Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The stream/promises API is poorly documented #45821

Closed
NemoStein opened this issue Dec 11, 2022 · 1 comment · Fixed by #45832
Closed

The stream/promises API is poorly documented #45821

NemoStein opened this issue Dec 11, 2022 · 1 comment · Fixed by #45832
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Comments

@NemoStein
Copy link

Affected URL(s)

https://nodejs.org/api/stream.html#streams-promises-api

Description of the problem

The stream docs page doesn't describe the signature of node:stream/promises pipeline & finished functions.

This is aggravated by the fact that the promise version of stream.pipeline() accepts an options object as last parameter, but the docs doesn't document its properties properly.

The only reference to it is the following paragraph:

The pipeline API provides a promise version, which can also receive an options argument as the last parameter with a signal <AbortSignal> property. When the signal is aborted, destroy will be called on the underlying pipeline, with an AbortError.

Although its note about the options.signal property, the paragraph leaves the property end: boolean (#34805 (comment)) completely undocumented.
@NemoStein NemoStein added the doc Issues and PRs related to the documentations. label Dec 11, 2022
@aduh95
Copy link
Contributor

aduh95 commented Dec 11, 2022

Would you like to send a PR to fix that?

@VoltrexKeyva VoltrexKeyva added the stream Issues and PRs related to the stream subsystem. label Dec 12, 2022
@marco-ippolito marco-ippolito mentioned this issue Dec 12, 2022
Merged
@aduh95 aduh95 mentioned this issue Dec 15, 2022
Closed
nodejs-github-bot pushed a commit that referenced this issue Dec 15, 2022
@marco-ippolito
doc: add stream/promises pipeline and finished to doc
4166d40 
PR-URL: #45832
Fixes: #45821
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this issue Jan 1, 2023
@marco-ippolito @targos
doc: add stream/promises pipeline and finished to doc
b93a967 
PR-URL: #45832
Fixes: #45821
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
juanarbol pushed a commit that referenced this issue Jan 26, 2023
@marco-ippolito @juanarbol
doc: add stream/promises pipeline and finished to doc
5eb93f1 
PR-URL: #45832
Fixes: #45821
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
aloisklink added a commit to aloisklink/node that referenced this issue Jul 30, 2023
@aloisklink
doc: document pipeline with end option
7a279a1 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
@aloisklink aloisklink mentioned this issue Jul 30, 2023
Merged
aduh95 pushed a commit to aloisklink/node that referenced this issue May 11, 2024
@aloisklink @aduh95
doc: document pipeline with end option
7ea65be 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
aduh95 pushed a commit to aloisklink/node that referenced this issue May 12, 2024
@aloisklink @aduh95
doc: document pipeline with end option
ca2f874 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
PR-URL: nodejs#48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos pushed a commit that referenced this issue May 12, 2024
@aloisklink @targos
doc: document pipeline with end option
80fa675 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: #40886
Refs: #34805 (comment)
Fixes: #45821
PR-URL: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito pushed a commit that referenced this issue Jun 17, 2024
@aloisklink @marco-ippolito
doc: document pipeline with end option
66575c9 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: #40886
Refs: #34805 (comment)
Fixes: #45821
PR-URL: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito pushed a commit that referenced this issue Jun 17, 2024
@aloisklink @marco-ippolito
doc: document pipeline with end option
8665441 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: #40886
Refs: #34805 (comment)
Fixes: #45821
PR-URL: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito pushed a commit that referenced this issue Jun 17, 2024
@aloisklink @marco-ippolito
doc: document pipeline with end option
e62c6e2 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: #40886
Refs: #34805 (comment)
Fixes: #45821
PR-URL: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
eliphazbouye pushed a commit to eliphazbouye/node that referenced this issue Jun 20, 2024
@aloisklink @eliphazbouye
doc: document pipeline with end option
65567fa 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
PR-URL: nodejs#48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
bmeck pushed a commit to bmeck/node that referenced this issue Jun 22, 2024
@aloisklink @bmeck
doc: document pipeline with end option
4b68ad0 
There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
PR-URL: nodejs#48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: add pipeline and finished to stream/promises doc marco-ippolito/node
3 participants
@NemoStein @aduh95 @VoltrexKeyva