From f0cee80de7f8e8bdbb7cf8d1ef6aacb80334131f Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Tue, 21 Feb 2017 23:38:45 +0100 Subject: [PATCH] doc: add changelogs for fs PR-URL: https://github.com/nodejs/node/pull/11489 Reviewed-By: Ben Noordhuis Reviewed-By: Sam Roberts Reviewed-By: Roman Reiss Reviewed-By: James M Snell Reviewed-By: Italo A. Casas --- doc/api/fs.md | 276 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 276 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 187c7d9edc..1a4233e81e 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -448,6 +448,17 @@ checks fail, and does nothing otherwise. ## fs.appendFile(file, data[, options], callback) * `file` {String | Buffer | Number} filename or file descriptor @@ -484,6 +495,13 @@ automatically._ ## fs.appendFileSync(file, data[, options]) * `file` {String | Buffer | Number} filename or file descriptor @@ -498,6 +516,11 @@ The synchronous version of [`fs.appendFile()`][]. Returns `undefined`. ## fs.chmod(path, mode, callback) * `path` {String | Buffer} @@ -520,6 +543,11 @@ Synchronous chmod(2). Returns `undefined`. ## fs.chown(path, uid, gid, callback) * `path` {String | Buffer} @@ -544,6 +572,11 @@ Synchronous chown(2). Returns `undefined`. ## fs.close(fd, callback) * `fd` {Integer} @@ -570,6 +603,13 @@ operations. The specific constants currently defined are described in ## fs.createReadStream(path[, options]) * `path` {String | Buffer} @@ -631,6 +671,16 @@ If `options` is a string, then it specifies the encoding. ## fs.createWriteStream(path[, options]) * `path` {String | Buffer} @@ -797,6 +847,11 @@ a callback.) ## fs.fchmod(fd, mode, callback) * `fd` {Integer} @@ -819,6 +874,11 @@ Synchronous fchmod(2). Returns `undefined`. ## fs.fchown(fd, uid, gid, callback) * `fd` {Integer} @@ -843,6 +903,11 @@ Synchronous fchown(2). Returns `undefined`. ## fs.fdatasync(fd, callback) * `fd` {Integer} @@ -863,6 +928,11 @@ Synchronous fdatasync(2). Returns `undefined`. ## fs.fstat(fd, callback) * `fd` {Integer} @@ -884,6 +954,11 @@ Synchronous fstat(2). Returns an instance of [`fs.Stats`][]. ## fs.fsync(fd, callback) * `fd` {Integer} @@ -904,6 +979,11 @@ Synchronous fsync(2). Returns `undefined`. ## fs.ftruncate(fd, len, callback) * `fd` {Integer} @@ -967,6 +1047,15 @@ Synchronous ftruncate(2). Returns `undefined`. ## fs.futimes(fd, atime, mtime, callback) * `fd` {Integer} @@ -980,6 +1069,11 @@ descriptor. ## fs.futimesSync(fd, atime, mtime) * `fd` {Integer} @@ -991,6 +1085,11 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`. ## fs.lchmod(path, mode, callback) * `path` {String | Buffer} @@ -1015,6 +1114,11 @@ Synchronous lchmod(2). Returns `undefined`. ## fs.lchown(path, uid, gid, callback) * `path` {String | Buffer} @@ -1039,6 +1143,11 @@ Synchronous lchown(2). Returns `undefined`. ## fs.link(existingPath, newPath, callback) * `existingPath` {String | Buffer} @@ -1061,6 +1170,11 @@ Synchronous link(2). Returns `undefined`. ## fs.lstat(path, callback) * `path` {String | Buffer} @@ -1083,6 +1197,11 @@ Synchronous lstat(2). Returns an instance of [`fs.Stats`][]. ## fs.mkdir(path[, mode], callback) * `path` {String | Buffer} @@ -1105,6 +1224,14 @@ Synchronous mkdir(2). Returns `undefined`. ## fs.mkdtemp(prefix[, options], callback) * `prefix` {String} @@ -1278,6 +1405,13 @@ descriptor. ## fs.read(fd, buffer, offset, length, position, callback) * `fd` {Integer} @@ -1303,6 +1437,11 @@ The callback is given the three arguments, `(err, bytesRead, buffer)`. ## fs.readdir(path[, options], callback) * `path` {String | Buffer} @@ -1339,6 +1478,18 @@ the filenames returned will be passed as `Buffer` objects. ## fs.readFile(file[, options], callback) * `file` {String | Buffer | Integer} filename or file descriptor @@ -1375,6 +1526,10 @@ automatically._ ## fs.readFileSync(file[, options]) * `file` {String | Buffer | Integer} filename or file descriptor @@ -1390,6 +1545,11 @@ string. Otherwise it returns a buffer. ## fs.readlink(path[, options], callback) * `path` {String | Buffer} @@ -1424,6 +1584,10 @@ the link path returned will be passed as a `Buffer` object. ## fs.readSync(fd, buffer, offset, length, position) * `fd` {Integer} @@ -1437,6 +1601,18 @@ Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`. ## fs.realpath(path[, options], callback) * `path` {String | Buffer} @@ -1457,6 +1633,14 @@ the path returned will be passed as a `Buffer` object. ## fs.realpathSync(path[, options]) * `path` {String | Buffer}; @@ -1475,6 +1659,11 @@ will be passed as a `Buffer` object. ## fs.rename(oldPath, newPath, callback) * `oldPath` {String | Buffer} @@ -1497,6 +1686,11 @@ Synchronous rename(2). Returns `undefined`. ## fs.rmdir(path, callback) * `path` {String | Buffer} @@ -1517,6 +1711,11 @@ Synchronous rmdir(2). Returns `undefined`. ## fs.stat(path, callback) * `path` {String | Buffer} @@ -1583,6 +1782,11 @@ Synchronous symlink(2). Returns `undefined`. ## fs.truncate(path, len, callback) * `path` {String | Buffer} @@ -1607,6 +1811,11 @@ passed as the first argument. In this case, `fs.ftruncateSync()` is called. ## fs.unlink(path, callback) * `path` {String | Buffer} @@ -1646,6 +1855,15 @@ when possible._ ## fs.utimes(path, atime, mtime, callback) * `path` {String | Buffer} @@ -1668,6 +1886,11 @@ follow these rules: ## fs.utimesSync(path, atime, mtime) * `path` {String | Buffer} @@ -1679,6 +1902,10 @@ Synchronous version of [`fs.utimes()`][]. Returns `undefined`. ## fs.watch(filename[, options][, listener]) * `filename` {String | Buffer} @@ -1828,6 +2055,17 @@ _Note: [`fs.watch()`][] is more efficient than `fs.watchFile` and ## fs.write(fd, buffer[, offset[, length[, position]]], callback) * `fd` {Integer} @@ -1860,6 +2098,14 @@ the end of the file. ## fs.write(fd, string[, position[, encoding]], callback) * `fd` {Integer} @@ -1896,6 +2142,17 @@ the end of the file. ## fs.writeFile(file, data[, options], callback) * `file` {String | Buffer | Integer} filename or file descriptor @@ -1939,6 +2196,13 @@ automatically._ ## fs.writeFileSync(file, data[, options]) * `file` {String | Buffer | Integer} filename or file descriptor @@ -1953,6 +2217,13 @@ The synchronous version of [`fs.writeFile()`][]. Returns `undefined`. ## fs.writeSync(fd, buffer[, offset[, length[, position]]]) * `fd` {Integer} @@ -1964,6 +2235,10 @@ added: v0.1.21 ## fs.writeSync(fd, string[, position[, encoding]]) * `fd` {Integer} @@ -2231,3 +2506,4 @@ The following constants are meant for use with the [`fs.Stats`][] object's [`ReadDirectoryChangesW`]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365465%28v=vs.85%29.aspx [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ [Common System Errors]: errors.html#errors_common_system_errors +[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array