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.

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

feat: add explicit declaration of fd with null val #40704

Closed
wants to merge 1 commit into from
Closed

feat: add explicit declaration of fd with null val #40704

wants to merge 1 commit into from

Conversation

Gena888
Copy link
Contributor

@Gena888 Gena888 commented Nov 2, 2021

In example of implementing a writable stream with extending on Writable add explicit declaration of 'fd' (file descriptor) variable with null value.
It will make this example more similar to readable stream's one. And will make it easier to figure out in topic.

Screenshot 2021-11-02 at 21 53 58

@Gena888
feat: add explicit declaration of fd with null val
3aaa09e 
In example of implementing a writable stream with extending on Writable add explicit declaration of 'fd' (file descriptor) variable with null value.
It will make this example more similar to readable stream's one. And will make it easier to figure out in topic.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Nov 2, 2021
@tniessen tniessen requested a review from ronag November 3, 2021 13:13
@tniessen
Copy link
Member

tniessen commented Nov 3, 2021

Thank you @Gena888!

To add to the screenshot above, the relevant reference is

node/doc/api/stream.md

Lines 2908 to 2912 in 2e2a6fe

constructor(filename) {
super();
this.filename = filename;
this.fd = null;
}

@tniessen
Copy link
Member

tniessen commented Nov 3, 2021

cc @nodejs/streams

mcollina
mcollina reviewed Nov 3, 2021
View reviewed changes
doc/api/stream.md
@@ -2558,6 +2558,7 @@ class WriteStream extends Writable {
constructor(filename) {
super();
this.filename = filename;
this.fd = null;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that a file descriptor is a number, using -1 might seems a better default.

@mcollina
Copy link
Member

mcollina commented Nov 9, 2021

Could you add a test?

@Gena888
Copy link
Contributor Author

Gena888 commented Nov 9, 2021 •
edited

Could you add a test?

How can i write test for code example?)
Is it necessary ?

@mcollina
Copy link
Member

mcollina commented Nov 9, 2021

Ah I missed it, sorry.

@Gena888
Copy link
Contributor Author

Gena888 commented Nov 9, 2021

Ah I missed it, sorry.

Any time :)

mcollina
mcollina approved these changes Dec 4, 2021
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

mcollina pushed a commit that referenced this pull request Dec 4, 2021
@Gena888 @mcollina
doc: add explicit declaration of fd with null val
069d2bd 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@mcollina
Copy link
Member

mcollina commented Dec 4, 2021

Landed in 069d2bd"

@mcollina mcollina closed this Dec 4, 2021
danielleadams pushed a commit that referenced this pull request Dec 13, 2021
@Gena888 @danielleadams
doc: add explicit declaration of fd with null val
cd68bb0 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
danielleadams pushed a commit that referenced this pull request Dec 14, 2021
@Gena888 @danielleadams
doc: add explicit declaration of fd with null val
94d0911 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@danielleadams danielleadams mentioned this pull request Dec 14, 2021
Merged
danielleadams pushed a commit that referenced this pull request Jan 31, 2022
@Gena888 @danielleadams
doc: add explicit declaration of fd with null val
93666d3 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
danielleadams pushed a commit that referenced this pull request Jan 31, 2022
@Gena888 @danielleadams
doc: add explicit declaration of fd with null val
d9331e4 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Linkgoron pushed a commit to Linkgoron/node that referenced this pull request Jan 31, 2022
@Gena888 @Linkgoron
doc: add explicit declaration of fd with null val
cc35aaa 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: nodejs#40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
danielleadams pushed a commit that referenced this pull request Feb 1, 2022
@Gena888 @danielleadams
doc: add explicit declaration of fd with null val
6a9db2e 
In example of implementing a writable stream with extending on
Writable add explicit declaration of 'fd' (file descriptor)
variable with null value.
It will make this example more similar to readable stream's one.
And will make it easier to figure out in topic.

PR-URL: #40704
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@danielleadams danielleadams mentioned this pull request Feb 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcollina mcollina mcollina approved these changes

@jasnell jasnell jasnell approved these changes

@lpinca lpinca lpinca approved these changes

@tniessen tniessen tniessen approved these changes

@JungMinu JungMinu JungMinu approved these changes

@ronag ronag Awaiting requested review from ronag

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 this pull request may close these issues.

None yet
7 participants
@Gena888 @tniessen @mcollina @jasnell @lpinca @JungMinu @nodejs-github-bot