Skip to content

Cherrypick v0.12 doc updates #2302

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

Closed
jasnell wants to merge 17 commits into from
Closed

Cherrypick v0.12 doc updates #2302

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b259be7
doc: improve http.abort description
jasnell Jun 24, 2015
60b4239
doc: mention that mode is ignored if file exists
jasnell Jun 24, 2015
f32f822
docs: Fix default options for fs.createWriteStream()
jasnell Aug 4, 2015
e603452
Documentation update about Buffer initialization
jasnell Aug 4, 2015
66047a5
doc: add a note about readable in flowing mode
jasnell Jun 26, 2015
93c489e
doc: Document http.request protocol option
jasnell Aug 4, 2015
46396cc
doc, comments: Grammar and spelling fixes
jasnell Aug 4, 2015
4a8fbf3
updated documentation for fs.createReadStream
jasnell Aug 4, 2015
41b8908
Update child_process.markdown, spelling
jalexanderfox Jun 24, 2015
d3407bc
doc: Clarified read method with specified size argument.
plafer Jun 28, 2015
c6d7974
docs:events clarify emitter.listener() behavior
bsteephenson Mar 3, 2015
034b4d5
doc: two minor stream doc improvements
jasnell Jul 1, 2015
d0b54ea
doc: clarify Readable._read and Readable.push
fresheneesz Jun 25, 2015
de79062
doc: stream.unshift does not reset reading state
jasnell Jul 6, 2015
3d6d8e9
doc: readable event clarification
jasnell Jul 6, 2015
2fa7736
doc: additional refinement to readable event
jasnell Jul 9, 2015
c071d7a
doc: minor edits based on feedback
jasnell Aug 4, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: Clarified read method with specified size argument. 
Made explicitely clear that when size bytes are not available,
it will return null, unless we've ended, in which case the data
remaining in the buffer will be returned.

Fixes #7273

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
  • Loading branch information
@plafer @jasnell
plafer authored and jasnell committed Aug 4, 2015
commit d3407bc7610e82467236350c2ecac27e3af7e46c
4 changes: 3 additions & 1 deletion doc/api/stream.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,9 @@ returns it. If there is no data available, then it will return
`null`.

If you pass in a `size` argument, then it will return that many
bytes. If `size` bytes are not available, then it will return `null`.
bytes. If `size` bytes are not available, then it will return `null`,
unless we've ended, in which case it will return the data remaining
in the buffer.

If you do not specify a `size` argument, then it will return all the
data in the internal buffer.
Expand Down