node/doc/api
Johannes Wüller 0803962860 fs: add file descriptor support to *File() funcs
These changes affect the following functions and their synchronous
counterparts:

 * fs.readFile()
 * fs.writeFile()
 * fs.appendFile()

If the first parameter is a uint32, it is treated as a file descriptor.
In all other cases, the original implementation is used to ensure
backwards compatibility. File descriptor ownership is never taken from
the user.

The documentation was adjusted to reflect these API changes. A note was
added to make the user aware of file descriptor ownership and the
conditions under which a file descriptor can be used by each of these
functions.

Tests were extended to test for file descriptor parameters under the
conditions noted in the relevant documentation.

PR-URL: https://github.com/nodejs/node/pull/3163
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2015-10-16 17:14:21 -06:00
..
_toc.markdown deps: update v8 to 4.4.63.9 2015-08-04 11:56:14 -07:00
addons.markdown doc: replace node-gyp link with nodejs/node-gyp 2015-10-11 17:03:30 +02:00
all.markdown deps: update v8 to 4.4.63.9 2015-08-04 11:56:14 -07:00
assert.markdown doc: update the assert module summary 2015-10-11 19:24:39 +02:00
buffer.markdown doc: fix spelling in Buffer documentation 2015-10-06 19:09:54 -05:00
child_process.markdown doc: add method links in child_process.markdown 2015-10-09 18:41:09 +02:00
cluster.markdown doc: remove old note, 'cluster' is marked stable 2015-10-10 13:37:15 -07:00
console.markdown console: rename argument of time and timeEnd 2015-10-16 21:03:44 +02:00
crypto.markdown doc: fix outdated 'try/catch' statement in sync 2015-09-30 19:59:10 -07:00
debugger.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
dgram.markdown doc: port is optional for socket.bind() 2015-08-25 18:52:20 -07:00
dns.markdown doc: add method links in dns.markdown 2015-10-09 18:39:11 +02:00
documentation.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
domain.markdown doc: small typo in domain.markdown 2015-08-25 18:52:05 -07:00
errors.markdown doc: fix typos in cluster & errors 2015-09-23 22:06:43 +02:00
events.markdown doc: recommend Infinity on emitter.setMaxListeners 2015-10-09 19:01:29 +02:00
fs.markdown fs: add file descriptor support to *File() funcs 2015-10-16 17:14:21 -06:00
globals.markdown doc: minor additional corrections and improvements 2015-08-25 18:52:52 -07:00
http.markdown http: add checkIsHttpToken check for header fields 2015-09-25 08:37:57 -07:00
https.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
index.markdown Remove util.print from docs 2010-11-07 17:22:56 -08:00
modules.markdown doc: remove usage of events.EventEmitter 2015-09-23 00:22:11 +05:30
net.markdown doc: Amend capitalization of word JavaScript 2015-10-09 18:42:58 +02:00
os.markdown os: add homedir() 2015-06-05 22:58:14 -04:00
path.markdown doc: update path.extname documentation 2015-08-25 18:51:41 -07:00
process.markdown src: add process.versions.icu 2015-09-29 08:18:03 -05:00
punycode.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
querystring.markdown doc: add explanations for querystring 2015-03-03 10:03:42 -05:00
readline.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
repl.markdown doc: fix broken link in repl.markdown 2015-09-14 17:29:01 -04:00
stream.markdown doc: fix two doc errors in stream and process 2015-09-14 09:39:59 -04:00
string_decoder.markdown doc: update stability index 2015-02-27 14:23:01 -08:00
synopsis.markdown node: additional cleanup for node rename 2015-08-23 17:59:43 -04:00
timers.markdown timer: ref/unref return self 2015-09-16 10:29:13 -07:00
tls.markdown tls: add minDHSize option to tls.connect() 2015-10-16 11:39:54 +09:00
tty.markdown doc: make the deprecations consistent 2015-08-24 13:38:37 +05:30
url.markdown doc: update url doc to account for escaping 2015-09-06 21:37:59 +10:00
util.markdown doc: remove usage of events.EventEmitter 2015-09-23 00:22:11 +05:30
v8.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00
vm.markdown doc: fix vm module examples 2015-03-13 23:14:20 +01:00
zlib.markdown node: rename from io.js to node 2015-08-23 17:59:43 -04:00