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: clarify fs.createReadStream options #10078

Closed
wants to merge 1 commit into from
Closed

doc: clarify fs.createReadStream options #10078

wants to merge 1 commit into from

Conversation

WesTyler
Copy link
Contributor

@WesTyler WesTyler commented Dec 1, 2016

Checklist
  • make -j8 test (UNIX), or vcbuild test nosign (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change
  • start/end start counting at 0
  • If fd is specified and start is omitted or undefined,
    fs.createReadStream() reads sequentially
    from the current file position.
  • Addresses Omission in the fs doc #7099

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Dec 1, 2016
addaleax
addaleax approved these changes Dec 2, 2016
View reviewed changes
doc/api/fs.md
@@ -602,7 +602,9 @@ default value of 64 kb for the same parameter.

`options` can include `start` and `end` values to read a range of bytes from
the file instead of the entire file. Both `start` and `end` are inclusive and
start at 0. The `encoding` can be any one of those accepted by [`Buffer`][].
start counting at 0. If `fd` is specified and `start` is omitted or undefined,
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Could you put undefined in backticks so it’s clear you are referring to the JS value?

Copy link
Contributor Author

@WesTyler WesTyler Dec 2, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

sure thing!

[edit] Done!

Copy link
Member

Choose a reason for hiding this comment

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

@WesTyler thanks!

@WesTyler
doc: clarify fs.createReadStream options
6cc35cd 
	* start/end start *counting* at 0
	* If fd is specified and start is omitted or undefined,
	  fs.createReadStream() reads sequentially
	  from the current file position.
	* Addresses #7099
@addaleax addaleax added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Dec 2, 2016
@silverwind
Copy link
Contributor

Thanks! Landed in 384dafe.

@silverwind silverwind closed this Dec 3, 2016
silverwind pushed a commit that referenced this pull request Dec 3, 2016
@WesTyler @silverwind
doc: clarify fs.createReadStream options
384dafe 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
addaleax pushed a commit that referenced this pull request Dec 5, 2016
@WesTyler @addaleax
doc: clarify fs.createReadStream options
78e188d 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
@Fishrock123 Fishrock123 mentioned this pull request Dec 5, 2016
Merged
2 tasks
jmdarling pushed a commit to jmdarling/node that referenced this pull request Dec 8, 2016
@WesTyler
doc: clarify fs.createReadStream options
d28d2e8 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: nodejs#7099
PR-URL: nodejs#10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
@WesTyler @MylesBorins
doc: clarify fs.createReadStream options
36b45c1 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
@WesTyler @MylesBorins
doc: clarify fs.createReadStream options
ad841a2 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@WesTyler @MylesBorins
doc: clarify fs.createReadStream options
a968dd0 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@WesTyler @MylesBorins
doc: clarify fs.createReadStream options
2424389 
* start/end start *counting* at 0
* If fd is specified and start is omitted or undefined,
  fs.createReadStream() reads sequentially from the current file
  position.

Fixes: #7099
PR-URL: #10078
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
This was referenced Dec 21, 2016
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addaleax addaleax addaleax approved these changes

@silverwind silverwind silverwind approved these changes

@bnoordhuis bnoordhuis bnoordhuis approved these changes

@gibfahn gibfahn gibfahn approved these changes

Assignees
No one assigned
Labels
code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@WesTyler @silverwind @bnoordhuis @addaleax @gibfahn @MylesBorins @nodejs-github-bot