Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
4dc660e
build: do not generate support for libuv's probes
Dec 3, 2014
20a7088
deps: update libuv to 1.0.2
saghul Dec 9, 2014
8708c7a
test: mark more tests as flaky
orangemocha Dec 10, 2014
946cec7
lib,src: fix spawnSync ignoring its 'env' option
juamedgod Oct 14, 2014
4bba870
test: add test for spawnSync() env option
cjihrig Dec 9, 2014
5b9e5bd
doc: clarify create{Read,Write}Stream fd option
benjamincburns Jul 26, 2014
6f6a979
zlib: support concatenated gzip files
eendeego Sep 9, 2014
e93ff4f
debugger: fix unhandled error in setBreakpoint
bajtos Nov 4, 2013
93533e9
src: fix windows build error
bnoordhuis Nov 11, 2014
9158666
stream: switch _writableState.buffer to queue
chrisdickinson Dec 4, 2014
890baa0
doc: add details for http res/req end callback
JacksonTian Dec 10, 2014
6a03fce
url: improve parsing speed
CGavrila Oct 28, 2014
d8586ea
lib: introduce process module
Dec 30, 2014
8b04161
doc: util: document --trace-deprecation
bnoordhuis Dec 21, 2014
d5c7a97
doc: added TC meeting minutes 2014-12-17
rvagg Dec 17, 2014
a308395
build: i18n: add icu config options
srl295 Nov 13, 2014
261706e
doc: added TC meeting minutes 2014-12-30
rvagg Jan 2, 2015
8cfbeed
docs: update to authors file
srl295 Jan 3, 2015
b636ba8
net: make connect() input validation synchronous
cjihrig Jan 3, 2015
372a2f5
smalloc: fix bad assert for zero length data
trevnorris Jan 5, 2015
94e1475
Merge remote-tracking branch 'joyent/v0.12' into v1.x
bnoordhuis Jan 5, 2015
eaed2a1
deps: update libuv to 1.2.0
bnoordhuis Jan 5, 2015
52e600a
test: don't assume broadcast traffic is unfiltered
bnoordhuis Dec 29, 2014
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: clarify create{Read,Write}Stream fd option
Clarify the fd option: it is preferred to the path parameter, omits
the "open" event if given, and is available on WriteStreams as well.

PR-URL: nodejs/node-v0.x-archive#7707
Fixes: nodejs/node-v0.x-archive#7707
Fixes: nodejs/node-v0.x-archive#7708
Fixes: nodejs/node-v0.x-archive#4367
Reviewed-By: Chris Dickinson <[email protected]>
  • Loading branch information
benjamincburns authored and chrisdickinson committed Dec 16, 2014
commit 5b9e5bdd03ef5c53f370e414c5a964fccb4ac030
9 changes: 9 additions & 0 deletions doc/api/fs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,9 @@ Returns a new ReadStream object (See `Readable Stream`).
the file instead of the entire file. Both `start` and `end` are inclusive and
start at 0. The `encoding` can be `'utf8'`, `'ascii'`, or `'base64'`.

If `fd` is specified, `ReadStream` will ignore the `path` argument and will use
the specified file descriptor. This means that no `open` event will be emitted.

If `autoClose` is false, then the file descriptor won't be closed, even if
there's an error. It is your responsibility to close it and make sure
there's no file descriptor leak. If `autoClose` is set to true (default
Expand Down Expand Up @@ -775,13 +778,19 @@ Returns a new WriteStream object (See `Writable Stream`).

{ flags: 'w',
encoding: null,
fd: null,
mode: 0666 }

`options` may also include a `start` option to allow writing data at
some position past the beginning of the file. Modifying a file rather
than replacing it may require a `flags` mode of `r+` rather than the
default mode `w`.

Like `ReadStream` above, if `fd` is specified, `WriteStream` will ignore the
`path` argument and will use the specified file descriptor. This means that no
`open` event will be emitted.


## Class: fs.WriteStream

`WriteStream` is a [Writable Stream](stream.html#stream_class_stream_writable).
Expand Down