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

doc: undocumented properties are mentioned in the stream doc #28592

Closed
vsemozhetbyt opened this issue Jul 7, 2019 · 4 comments
Closed

doc: undocumented properties are mentioned in the stream doc #28592

vsemozhetbyt opened this issue Jul 7, 2019 · 4 comments
Labels
doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. stream Issues and PRs related to the stream subsystem.

Comments

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 7, 2019 •
edited
Loading

writable.writableBuffer and readable.readableBuffer are mentioned https://nodejs.org/api/stream.html#stream_buffering but are undocumented in the appropriate sections.

Not sure if this need to be addressed. Please close if this is OK.
@Trott Trott added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jul 8, 2019
@lpinca
Copy link
Member

lpinca commented Jul 10, 2019

I'm not sure if it makes sense to document them because the getters return an internal type (BufferList) which should not be public.

@lpinca
Copy link
Member

lpinca commented Jul 10, 2019

cc: @nodejs/streams

@lpinca
Copy link
Member

lpinca commented Jul 10, 2019

I guess the whole point for adding the getters was to give users the ability to easily access the BufferList so ¯_(ツ)_/¯.

@reergymerej
Copy link

If nothing else, the language is confusing.

internal buffer that can be retrieved using writable.writableBuffer

but it returns a BufferList.

@jasnell jasnell added the help wanted Issues that need assistance from volunteers or PRs that need help to proceed. label Jun 26, 2020
@jasnell jasnell mentioned this issue Dec 31, 2020
Closed
3 tasks
jasnell added a commit to jasnell/node that referenced this issue Jan 2, 2021
@jasnell
doc: clarify undocumented stream properties
dc2e838 
Fixes: nodejs#28592
Signed-off-by: James M Snell <jasnell@gmail.com>
@jasnell jasnell closed this as completed in 7cfa1be Jan 3, 2021
danielleadams pushed a commit that referenced this issue Jan 12, 2021
@jasnell @danielleadams
doc: clarify undocumented stream properties
214dbac 
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
targos pushed a commit that referenced this issue May 1, 2021
@jasnell @targos
doc: clarify undocumented stream properties
71b94e1 
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.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. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. 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: clarify undocumented stream properties jasnell/node
5 participants
@jasnell @Trott @lpinca @reergymerej @vsemozhetbyt