| { |
| "source": "doc/api/fs.markdown", |
| "modules": [ |
| { |
| "textRaw": "File System", |
| "name": "fs", |
| "stability": 3, |
| "stabilityText": "Stable", |
| "desc": "<p>File I/O is provided by simple wrappers around standard POSIX functions. To\nuse this module do <code>require('fs')</code>. All the methods have asynchronous and\nsynchronous forms.\n\n</p>\n<p>The asynchronous form always take a completion callback as its last argument.\nThe arguments passed to the completion callback depend on the method, but the\nfirst argument is always reserved for an exception. If the operation was\ncompleted successfully, then the first argument will be <code>null</code> or <code>undefined</code>.\n\n</p>\n<p>When using the synchronous form any exceptions are immediately thrown.\nYou can use try/catch to handle exceptions or allow them to bubble up.\n\n</p>\n<p>Here is an example of the asynchronous version:\n\n</p>\n<pre><code>var fs = require('fs');\n\nfs.unlink('/tmp/hello', function (err) {\n if (err) throw err;\n console.log('successfully deleted /tmp/hello');\n});</code></pre>\n<p>Here is the synchronous version:\n\n</p>\n<pre><code>var fs = require('fs');\n\nfs.unlinkSync('/tmp/hello')\nconsole.log('successfully deleted /tmp/hello');</code></pre>\n<p>With the asynchronous methods there is no guaranteed ordering. So the\nfollowing is prone to error:\n\n</p>\n<pre><code>fs.rename('/tmp/hello', '/tmp/world', function (err) {\n if (err) throw err;\n console.log('renamed complete');\n});\nfs.stat('/tmp/world', function (err, stats) {\n if (err) throw err;\n console.log('stats: ' + JSON.stringify(stats));\n});</code></pre>\n<p>It could be that <code>fs.stat</code> is executed before <code>fs.rename</code>.\nThe correct way to do this is to chain the callbacks.\n\n</p>\n<pre><code>fs.rename('/tmp/hello', '/tmp/world', function (err) {\n if (err) throw err;\n fs.stat('/tmp/world', function (err, stats) {\n if (err) throw err;\n console.log('stats: ' + JSON.stringify(stats));\n });\n});</code></pre>\n<p>In busy processes, the programmer is <em>strongly encouraged</em> to use the\nasynchronous versions of these calls. The synchronous versions will block\nthe entire process until they complete--halting all connections.\n\n</p>\n<p>Relative path to filename can be used, remember however that this path will be\nrelative to <code>process.cwd()</code>.\n\n</p>\n<p>Most fs functions let you omit the callback argument. If you do, a default\ncallback is used that ignores errors, but prints a deprecation\nwarning.\n\n</p>\n<p><strong>IMPORTANT</strong>: Omitting the callback is deprecated. v0.12 will throw the\nerrors as exceptions.\n\n\n</p>\n", |
| "methods": [ |
| { |
| "textRaw": "fs.rename(oldPath, newPath, callback)", |
| "type": "method", |
| "name": "rename", |
| "desc": "<p>Asynchronous rename(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "oldPath" |
| }, |
| { |
| "name": "newPath" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.renameSync(oldPath, newPath)", |
| "type": "method", |
| "name": "renameSync", |
| "desc": "<p>Synchronous rename(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "oldPath" |
| }, |
| { |
| "name": "newPath" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.ftruncate(fd, len, callback)", |
| "type": "method", |
| "name": "ftruncate", |
| "desc": "<p>Asynchronous ftruncate(2). No arguments other than a possible exception are\ngiven to the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "len" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.ftruncateSync(fd, len)", |
| "type": "method", |
| "name": "ftruncateSync", |
| "desc": "<p>Synchronous ftruncate(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "len" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.truncate(path, len, callback)", |
| "type": "method", |
| "name": "truncate", |
| "desc": "<p>Asynchronous truncate(2). No arguments other than a possible exception are\ngiven to the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "len" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.truncateSync(path, len)", |
| "type": "method", |
| "name": "truncateSync", |
| "desc": "<p>Synchronous truncate(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "len" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.chown(path, uid, gid, callback)", |
| "type": "method", |
| "name": "chown", |
| "desc": "<p>Asynchronous chown(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.chownSync(path, uid, gid)", |
| "type": "method", |
| "name": "chownSync", |
| "desc": "<p>Synchronous chown(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fchown(fd, uid, gid, callback)", |
| "type": "method", |
| "name": "fchown", |
| "desc": "<p>Asynchronous fchown(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fchownSync(fd, uid, gid)", |
| "type": "method", |
| "name": "fchownSync", |
| "desc": "<p>Synchronous fchown(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lchown(path, uid, gid, callback)", |
| "type": "method", |
| "name": "lchown", |
| "desc": "<p>Asynchronous lchown(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lchownSync(path, uid, gid)", |
| "type": "method", |
| "name": "lchownSync", |
| "desc": "<p>Synchronous lchown(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "uid" |
| }, |
| { |
| "name": "gid" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.chmod(path, mode, callback)", |
| "type": "method", |
| "name": "chmod", |
| "desc": "<p>Asynchronous chmod(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.chmodSync(path, mode)", |
| "type": "method", |
| "name": "chmodSync", |
| "desc": "<p>Synchronous chmod(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fchmod(fd, mode, callback)", |
| "type": "method", |
| "name": "fchmod", |
| "desc": "<p>Asynchronous fchmod(2). No arguments other than a possible exception\nare given to the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "mode" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fchmodSync(fd, mode)", |
| "type": "method", |
| "name": "fchmodSync", |
| "desc": "<p>Synchronous fchmod(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "mode" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lchmod(path, mode, callback)", |
| "type": "method", |
| "name": "lchmod", |
| "desc": "<p>Asynchronous lchmod(2). No arguments other than a possible exception\nare given to the completion callback.\n\n</p>\n<p>Only available on Mac OS X.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lchmodSync(path, mode)", |
| "type": "method", |
| "name": "lchmodSync", |
| "desc": "<p>Synchronous lchmod(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.stat(path, callback)", |
| "type": "method", |
| "name": "stat", |
| "desc": "<p>Asynchronous stat(2). The callback gets two arguments <code>(err, stats)</code> where\n<code>stats</code> is a <a href=\"#fs_class_fs_stats\">fs.Stats</a> object. See the <a href=\"#fs_class_fs_stats\">fs.Stats</a>\nsection below for more information.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lstat(path, callback)", |
| "type": "method", |
| "name": "lstat", |
| "desc": "<p>Asynchronous lstat(2). The callback gets two arguments <code>(err, stats)</code> where\n<code>stats</code> is a <code>fs.Stats</code> object. <code>lstat()</code> is identical to <code>stat()</code>, except that if\n<code>path</code> is a symbolic link, then the link itself is stat-ed, not the file that it\nrefers to.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fstat(fd, callback)", |
| "type": "method", |
| "name": "fstat", |
| "desc": "<p>Asynchronous fstat(2). The callback gets two arguments <code>(err, stats)</code> where\n<code>stats</code> is a <code>fs.Stats</code> object. <code>fstat()</code> is identical to <code>stat()</code>, except that\nthe file to be stat-ed is specified by the file descriptor <code>fd</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.statSync(path)", |
| "type": "method", |
| "name": "statSync", |
| "desc": "<p>Synchronous stat(2). Returns an instance of <code>fs.Stats</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.lstatSync(path)", |
| "type": "method", |
| "name": "lstatSync", |
| "desc": "<p>Synchronous lstat(2). Returns an instance of <code>fs.Stats</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fstatSync(fd)", |
| "type": "method", |
| "name": "fstatSync", |
| "desc": "<p>Synchronous fstat(2). Returns an instance of <code>fs.Stats</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.link(srcpath, dstpath, callback)", |
| "type": "method", |
| "name": "link", |
| "desc": "<p>Asynchronous link(2). No arguments other than a possible exception are given to\nthe completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "srcpath" |
| }, |
| { |
| "name": "dstpath" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.linkSync(srcpath, dstpath)", |
| "type": "method", |
| "name": "linkSync", |
| "desc": "<p>Synchronous link(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "srcpath" |
| }, |
| { |
| "name": "dstpath" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.symlink(srcpath, dstpath, [type], callback)", |
| "type": "method", |
| "name": "symlink", |
| "desc": "<p>Asynchronous symlink(2). No arguments other than a possible exception are given\nto the completion callback.\nThe <code>type</code> argument can be set to <code>'dir'</code>, <code>'file'</code>, or <code>'junction'</code> (default\nis <code>'file'</code>) and is only available on Windows (ignored on other platforms).\nNote that Windows junction points require the destination path to be absolute. When using\n<code>'junction'</code>, the <code>destination</code> argument will automatically be normalized to absolute path.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "srcpath" |
| }, |
| { |
| "name": "dstpath" |
| }, |
| { |
| "name": "type", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.symlinkSync(srcpath, dstpath, [type])", |
| "type": "method", |
| "name": "symlinkSync", |
| "desc": "<p>Synchronous symlink(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "srcpath" |
| }, |
| { |
| "name": "dstpath" |
| }, |
| { |
| "name": "type", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readlink(path, callback)", |
| "type": "method", |
| "name": "readlink", |
| "desc": "<p>Asynchronous readlink(2). The callback gets two arguments <code>(err,\nlinkString)</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readlinkSync(path)", |
| "type": "method", |
| "name": "readlinkSync", |
| "desc": "<p>Synchronous readlink(2). Returns the symbolic link's string value.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.realpath(path, [cache], callback)", |
| "type": "method", |
| "name": "realpath", |
| "desc": "<p>Asynchronous realpath(2). The <code>callback</code> gets two arguments <code>(err,\nresolvedPath)</code>. May use <code>process.cwd</code> to resolve relative paths. <code>cache</code> is an\nobject literal of mapped paths that can be used to force a specific path\nresolution or avoid additional <code>fs.stat</code> calls for known real paths.\n\n</p>\n<p>Example:\n\n</p>\n<pre><code>var cache = {'/etc':'/private/etc'};\nfs.realpath('/etc/passwd', cache, function (err, resolvedPath) {\n if (err) throw err;\n console.log(resolvedPath);\n});</code></pre>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "cache", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.realpathSync(path, [cache])", |
| "type": "method", |
| "name": "realpathSync", |
| "desc": "<p>Synchronous realpath(2). Returns the resolved path.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "cache", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.unlink(path, callback)", |
| "type": "method", |
| "name": "unlink", |
| "desc": "<p>Asynchronous unlink(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.unlinkSync(path)", |
| "type": "method", |
| "name": "unlinkSync", |
| "desc": "<p>Synchronous unlink(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.rmdir(path, callback)", |
| "type": "method", |
| "name": "rmdir", |
| "desc": "<p>Asynchronous rmdir(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.rmdirSync(path)", |
| "type": "method", |
| "name": "rmdirSync", |
| "desc": "<p>Synchronous rmdir(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.mkdir(path, [mode], callback)", |
| "type": "method", |
| "name": "mkdir", |
| "desc": "<p>Asynchronous mkdir(2). No arguments other than a possible exception are given\nto the completion callback. <code>mode</code> defaults to <code>0777</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.mkdirSync(path, [mode])", |
| "type": "method", |
| "name": "mkdirSync", |
| "desc": "<p>Synchronous mkdir(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "mode", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readdir(path, callback)", |
| "type": "method", |
| "name": "readdir", |
| "desc": "<p>Asynchronous readdir(3). Reads the contents of a directory.\nThe callback gets two arguments <code>(err, files)</code> where <code>files</code> is an array of\nthe names of the files in the directory excluding <code>'.'</code> and <code>'..'</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readdirSync(path)", |
| "type": "method", |
| "name": "readdirSync", |
| "desc": "<p>Synchronous readdir(3). Returns an array of filenames excluding <code>'.'</code> and\n<code>'..'</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.close(fd, callback)", |
| "type": "method", |
| "name": "close", |
| "desc": "<p>Asynchronous close(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.closeSync(fd)", |
| "type": "method", |
| "name": "closeSync", |
| "desc": "<p>Synchronous close(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.open(path, flags, [mode], callback)", |
| "type": "method", |
| "name": "open", |
| "desc": "<p>Asynchronous file open. See open(2). <code>flags</code> can be:\n\n</p>\n<ul>\n<li><p><code>'r'</code> - Open file for reading.\nAn exception occurs if the file does not exist.</p>\n</li>\n<li><p><code>'r+'</code> - Open file for reading and writing.\nAn exception occurs if the file does not exist.</p>\n</li>\n<li><p><code>'rs'</code> - Open file for reading in synchronous mode. Instructs the operating\nsystem to bypass the local file system cache.</p>\n<p>This is primarily useful for opening files on NFS mounts as it allows you to\nskip the potentially stale local cache. It has a very real impact on I/O\nperformance so don't use this flag unless you need it.</p>\n<p>Note that this doesn't turn <code>fs.open()</code> into a synchronous blocking call.\nIf that's what you want then you should be using <code>fs.openSync()</code></p>\n</li>\n<li><p><code>'rs+'</code> - Open file for reading and writing, telling the OS to open it\nsynchronously. See notes for <code>'rs'</code> about using this with caution.</p>\n</li>\n<li><p><code>'w'</code> - Open file for writing.\nThe file is created (if it does not exist) or truncated (if it exists).</p>\n</li>\n<li><p><code>'wx'</code> - Like <code>'w'</code> but fails if <code>path</code> exists.</p>\n</li>\n<li><p><code>'w+'</code> - Open file for reading and writing.\nThe file is created (if it does not exist) or truncated (if it exists).</p>\n</li>\n<li><p><code>'wx+'</code> - Like <code>'w+'</code> but fails if <code>path</code> exists.</p>\n</li>\n<li><p><code>'a'</code> - Open file for appending.\nThe file is created if it does not exist.</p>\n</li>\n<li><p><code>'ax'</code> - Like <code>'a'</code> but fails if <code>path</code> exists.</p>\n</li>\n<li><p><code>'a+'</code> - Open file for reading and appending.\nThe file is created if it does not exist.</p>\n</li>\n<li><p><code>'ax+'</code> - Like <code>'a+'</code> but fails if <code>path</code> exists.</p>\n</li>\n</ul>\n<p><code>mode</code> sets the file mode (permission and sticky bits), but only if the file was\ncreated. It defaults to <code>0666</code>, readable and writeable.\n\n</p>\n<p>The callback gets two arguments <code>(err, fd)</code>.\n\n</p>\n<p>The exclusive flag <code>'x'</code> (<code>O_EXCL</code> flag in open(2)) ensures that <code>path</code> is newly\ncreated. On POSIX systems, <code>path</code> is considered to exist even if it is a symlink\nto a non-existent file. The exclusive flag may or may not work with network file\nsystems.\n\n</p>\n<p>On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "flags" |
| }, |
| { |
| "name": "mode", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.openSync(path, flags, [mode])", |
| "type": "method", |
| "name": "openSync", |
| "desc": "<p>Synchronous version of <code>fs.open()</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "flags" |
| }, |
| { |
| "name": "mode", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.utimes(path, atime, mtime, callback)", |
| "type": "method", |
| "name": "utimes", |
| "desc": "<p>Change file timestamps of the file referenced by the supplied path.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| } |
| ] |
| }, |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.utimesSync(path, atime, mtime)", |
| "type": "method", |
| "name": "utimesSync", |
| "desc": "<p>Change file timestamps of the file referenced by the supplied path.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.futimes(fd, atime, mtime, callback)", |
| "type": "method", |
| "name": "futimes", |
| "desc": "<p>Change the file timestamps of a file referenced by the supplied file\ndescriptor.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| } |
| ] |
| }, |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.futimesSync(fd, atime, mtime)", |
| "type": "method", |
| "name": "futimesSync", |
| "desc": "<p>Change the file timestamps of a file referenced by the supplied file\ndescriptor.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "atime" |
| }, |
| { |
| "name": "mtime" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fsync(fd, callback)", |
| "type": "method", |
| "name": "fsync", |
| "desc": "<p>Asynchronous fsync(2). No arguments other than a possible exception are given\nto the completion callback.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.fsyncSync(fd)", |
| "type": "method", |
| "name": "fsyncSync", |
| "desc": "<p>Synchronous fsync(2).\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.write(fd, buffer, offset, length, position, callback)", |
| "type": "method", |
| "name": "write", |
| "desc": "<p>Write <code>buffer</code> to the file specified by <code>fd</code>.\n\n</p>\n<p><code>offset</code> and <code>length</code> determine the part of the buffer to be written.\n\n</p>\n<p><code>position</code> refers to the offset from the beginning of the file where this data\nshould be written. If <code>position</code> is <code>null</code>, the data will be written at the\ncurrent position.\nSee pwrite(2).\n\n</p>\n<p>The callback will be given three arguments <code>(err, written, buffer)</code> where <code>written</code>\nspecifies how many <em>bytes</em> were written from <code>buffer</code>.\n\n</p>\n<p>Note that it is unsafe to use <code>fs.write</code> multiple times on the same file\nwithout waiting for the callback. For this scenario,\n<code>fs.createWriteStream</code> is strongly recommended.\n\n</p>\n<p>On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "buffer" |
| }, |
| { |
| "name": "offset" |
| }, |
| { |
| "name": "length" |
| }, |
| { |
| "name": "position" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.writeSync(fd, buffer, offset, length, position)", |
| "type": "method", |
| "name": "writeSync", |
| "desc": "<p>Synchronous version of <code>fs.write()</code>. Returns the number of bytes written.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "buffer" |
| }, |
| { |
| "name": "offset" |
| }, |
| { |
| "name": "length" |
| }, |
| { |
| "name": "position" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.read(fd, buffer, offset, length, position, callback)", |
| "type": "method", |
| "name": "read", |
| "desc": "<p>Read data from the file specified by <code>fd</code>.\n\n</p>\n<p><code>buffer</code> is the buffer that the data will be written to.\n\n</p>\n<p><code>offset</code> is the offset in the buffer to start writing at.\n\n</p>\n<p><code>length</code> is an integer specifying the number of bytes to read.\n\n</p>\n<p><code>position</code> is an integer specifying where to begin reading from in the file.\nIf <code>position</code> is <code>null</code>, data will be read from the current file position.\n\n</p>\n<p>The callback is given the three arguments, <code>(err, bytesRead, buffer)</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "buffer" |
| }, |
| { |
| "name": "offset" |
| }, |
| { |
| "name": "length" |
| }, |
| { |
| "name": "position" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readSync(fd, buffer, offset, length, position)", |
| "type": "method", |
| "name": "readSync", |
| "desc": "<p>Synchronous version of <code>fs.read</code>. Returns the number of <code>bytesRead</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "fd" |
| }, |
| { |
| "name": "buffer" |
| }, |
| { |
| "name": "offset" |
| }, |
| { |
| "name": "length" |
| }, |
| { |
| "name": "position" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.readFile(filename, [options], callback)", |
| "type": "method", |
| "name": "readFile", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "textRaw": "`filename` {String} ", |
| "name": "filename", |
| "type": "String" |
| }, |
| { |
| "textRaw": "`options` {Object} ", |
| "options": [ |
| { |
| "textRaw": "`encoding` {String | Null} default = `null` ", |
| "name": "encoding", |
| "type": "String | Null", |
| "desc": "default = `null`" |
| }, |
| { |
| "textRaw": "`flag` {String} default = `'r'` ", |
| "name": "flag", |
| "type": "String", |
| "desc": "default = `'r'`" |
| } |
| ], |
| "name": "options", |
| "type": "Object", |
| "optional": true |
| }, |
| { |
| "textRaw": "`callback` {Function} ", |
| "name": "callback", |
| "type": "Function" |
| } |
| ] |
| }, |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ], |
| "desc": "<p>Asynchronously reads the entire contents of a file. Example:\n\n</p>\n<pre><code>fs.readFile('/etc/passwd', function (err, data) {\n if (err) throw err;\n console.log(data);\n});</code></pre>\n<p>The callback is passed two arguments <code>(err, data)</code>, where <code>data</code> is the\ncontents of the file.\n\n</p>\n<p>If no encoding is specified, then the raw buffer is returned.\n\n\n</p>\n" |
| }, |
| { |
| "textRaw": "fs.readFileSync(filename, [options])", |
| "type": "method", |
| "name": "readFileSync", |
| "desc": "<p>Synchronous version of <code>fs.readFile</code>. Returns the contents of the <code>filename</code>.\n\n</p>\n<p>If the <code>encoding</code> option is specified then this function returns a\nstring. Otherwise it returns a buffer.\n\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.writeFile(filename, data, [options], callback)", |
| "type": "method", |
| "name": "writeFile", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "textRaw": "`filename` {String} ", |
| "name": "filename", |
| "type": "String" |
| }, |
| { |
| "textRaw": "`data` {String | Buffer} ", |
| "name": "data", |
| "type": "String | Buffer" |
| }, |
| { |
| "textRaw": "`options` {Object} ", |
| "options": [ |
| { |
| "textRaw": "`encoding` {String | Null} default = `'utf8'` ", |
| "name": "encoding", |
| "type": "String | Null", |
| "desc": "default = `'utf8'`" |
| }, |
| { |
| "textRaw": "`mode` {Number} default = `438` (aka `0666` in Octal) ", |
| "name": "mode", |
| "type": "Number", |
| "desc": "default = `438` (aka `0666` in Octal)" |
| }, |
| { |
| "textRaw": "`flag` {String} default = `'w'` ", |
| "name": "flag", |
| "type": "String", |
| "desc": "default = `'w'`" |
| } |
| ], |
| "name": "options", |
| "type": "Object", |
| "optional": true |
| }, |
| { |
| "textRaw": "`callback` {Function} ", |
| "name": "callback", |
| "type": "Function" |
| } |
| ] |
| }, |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "data" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ], |
| "desc": "<p>Asynchronously writes data to a file, replacing the file if it already exists.\n<code>data</code> can be a string or a buffer.\n\n</p>\n<p>The <code>encoding</code> option is ignored if <code>data</code> is a buffer. It defaults\nto <code>'utf8'</code>.\n\n</p>\n<p>Example:\n\n</p>\n<pre><code>fs.writeFile('message.txt', 'Hello Node', function (err) {\n if (err) throw err;\n console.log('It\\'s saved!');\n});</code></pre>\n" |
| }, |
| { |
| "textRaw": "fs.writeFileSync(filename, data, [options])", |
| "type": "method", |
| "name": "writeFileSync", |
| "desc": "<p>The synchronous version of <code>fs.writeFile</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "data" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.appendFile(filename, data, [options], callback)", |
| "type": "method", |
| "name": "appendFile", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "textRaw": "`filename` {String} ", |
| "name": "filename", |
| "type": "String" |
| }, |
| { |
| "textRaw": "`data` {String | Buffer} ", |
| "name": "data", |
| "type": "String | Buffer" |
| }, |
| { |
| "textRaw": "`options` {Object} ", |
| "options": [ |
| { |
| "textRaw": "`encoding` {String | Null} default = `'utf8'` ", |
| "name": "encoding", |
| "type": "String | Null", |
| "desc": "default = `'utf8'`" |
| }, |
| { |
| "textRaw": "`mode` {Number} default = `438` (aka `0666` in Octal) ", |
| "name": "mode", |
| "type": "Number", |
| "desc": "default = `438` (aka `0666` in Octal)" |
| }, |
| { |
| "textRaw": "`flag` {String} default = `'a'` ", |
| "name": "flag", |
| "type": "String", |
| "desc": "default = `'a'`" |
| } |
| ], |
| "name": "options", |
| "type": "Object", |
| "optional": true |
| }, |
| { |
| "textRaw": "`callback` {Function} ", |
| "name": "callback", |
| "type": "Function" |
| } |
| ] |
| }, |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "data" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ], |
| "desc": "<p>Asynchronously append data to a file, creating the file if it not yet exists.\n<code>data</code> can be a string or a buffer.\n\n</p>\n<p>Example:\n\n</p>\n<pre><code>fs.appendFile('message.txt', 'data to append', function (err) {\n if (err) throw err;\n console.log('The "data to append" was appended to file!');\n});</code></pre>\n" |
| }, |
| { |
| "textRaw": "fs.appendFileSync(filename, data, [options])", |
| "type": "method", |
| "name": "appendFileSync", |
| "desc": "<p>The synchronous version of <code>fs.appendFile</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "data" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.watchFile(filename, [options], listener)", |
| "type": "method", |
| "name": "watchFile", |
| "stability": 2, |
| "stabilityText": "Unstable. Use fs.watch instead, if possible.", |
| "desc": "<p>Watch for changes on <code>filename</code>. The callback <code>listener</code> will be called each\ntime the file is accessed.\n\n</p>\n<p>The second argument is optional. The <code>options</code> if provided should be an object\ncontaining two members a boolean, <code>persistent</code>, and <code>interval</code>. <code>persistent</code>\nindicates whether the process should continue to run as long as files are\nbeing watched. <code>interval</code> indicates how often the target should be polled,\nin milliseconds. The default is <code>{ persistent: true, interval: 5007 }</code>.\n\n</p>\n<p>The <code>listener</code> gets two arguments the current stat object and the previous\nstat object:\n\n</p>\n<pre><code>fs.watchFile('message.text', function (curr, prev) {\n console.log('the current mtime is: ' + curr.mtime);\n console.log('the previous mtime was: ' + prev.mtime);\n});</code></pre>\n<p>These stat objects are instances of <code>fs.Stat</code>.\n\n</p>\n<p>If you want to be notified when the file was modified, not just accessed\nyou need to compare <code>curr.mtime</code> and <code>prev.mtime</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| }, |
| { |
| "name": "listener" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.unwatchFile(filename, [listener])", |
| "type": "method", |
| "name": "unwatchFile", |
| "stability": 2, |
| "stabilityText": "Unstable. Use fs.watch instead, if possible.", |
| "desc": "<p>Stop watching for changes on <code>filename</code>. If <code>listener</code> is specified, only that\nparticular listener is removed. Otherwise, <em>all</em> listeners are removed and you\nhave effectively stopped watching <code>filename</code>.\n\n</p>\n<p>Calling <code>fs.unwatchFile()</code> with a filename that is not being watched is a\nno-op, not an error.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "listener", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.watch(filename, [options], [listener])", |
| "type": "method", |
| "name": "watch", |
| "stability": 2, |
| "stabilityText": "Unstable.", |
| "desc": "<p>Watch for changes on <code>filename</code>, where <code>filename</code> is either a file or a\ndirectory. The returned object is a <a href=\"#fs_class_fs_fswatcher\">fs.FSWatcher</a>.\n\n</p>\n<p>The second argument is optional. The <code>options</code> if provided should be an object\ncontaining a boolean member <code>persistent</code>, which indicates whether the process\nshould continue to run as long as files are being watched. The default is\n<code>{ persistent: true }</code>.\n\n</p>\n<p>The listener callback gets two arguments <code>(event, filename)</code>. <code>event</code> is either\n'rename' or 'change', and <code>filename</code> is the name of the file which triggered\nthe event.\n\n</p>\n", |
| "miscs": [ |
| { |
| "textRaw": "Caveats", |
| "name": "Caveats", |
| "type": "misc", |
| "desc": "<p>The <code>fs.watch</code> API is not 100% consistent across platforms, and is\nunavailable in some situations.\n\n</p>\n", |
| "miscs": [ |
| { |
| "textRaw": "Availability", |
| "name": "Availability", |
| "type": "misc", |
| "desc": "<p>This feature depends on the underlying operating system providing a way\nto be notified of filesystem changes.\n\n</p>\n<ul>\n<li>On Linux systems, this uses <code>inotify</code>.</li>\n<li>On BSD systems (including OS X), this uses <code>kqueue</code>.</li>\n<li>On SunOS systems (including Solaris and SmartOS), this uses <code>event ports</code>.</li>\n<li>On Windows systems, this feature depends on <code>ReadDirectoryChangesW</code>.</li>\n</ul>\n<p>If the underlying functionality is not available for some reason, then\n<code>fs.watch</code> will not be able to function. For example, watching files or\ndirectories on network file systems (NFS, SMB, etc.) often doesn't work\nreliably or at all.\n\n</p>\n<p>You can still use <code>fs.watchFile</code>, which uses stat polling, but it is slower and\nless reliable.\n\n</p>\n" |
| }, |
| { |
| "textRaw": "Filename Argument", |
| "name": "Filename Argument", |
| "type": "misc", |
| "desc": "<p>Providing <code>filename</code> argument in the callback is not supported\non every platform (currently it's only supported on Linux and Windows). Even\non supported platforms <code>filename</code> is not always guaranteed to be provided.\nTherefore, don't assume that <code>filename</code> argument is always provided in the\ncallback, and have some fallback logic if it is null.\n\n</p>\n<pre><code>fs.watch('somedir', function (event, filename) {\n console.log('event is: ' + event);\n if (filename) {\n console.log('filename provided: ' + filename);\n } else {\n console.log('filename not provided');\n }\n});</code></pre>\n" |
| } |
| ] |
| } |
| ], |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "filename" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| }, |
| { |
| "name": "listener", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.exists(path, callback)", |
| "type": "method", |
| "name": "exists", |
| "desc": "<p>Test whether or not the given path exists by checking with the file system.\nThen call the <code>callback</code> argument with either true or false. Example:\n\n</p>\n<pre><code>fs.exists('/etc/passwd', function (exists) {\n util.debug(exists ? "it's there" : "no passwd!");\n});</code></pre>\n<p><code>fs.exists()</code> is an anachronism and exists only for historical reasons.\nThere should almost never be a reason to use it in your own code.\n\n</p>\n<p>In particular, checking if a file exists before opening it is an anti-pattern\nthat leaves you vulnerable to race conditions: another process may remove the\nfile between the calls to <code>fs.exists()</code> and <code>fs.open()</code>. Just open the file\nand handle the error when it's not there.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "callback" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.existsSync(path)", |
| "type": "method", |
| "name": "existsSync", |
| "desc": "<p>Synchronous version of <code>fs.exists</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.createReadStream(path, [options])", |
| "type": "method", |
| "name": "createReadStream", |
| "desc": "<p>Returns a new ReadStream object (See <code>Readable Stream</code>).\n\n</p>\n<p><code>options</code> is an object with the following defaults:\n\n</p>\n<pre><code>{ flags: 'r',\n encoding: null,\n fd: null,\n mode: 0666,\n autoClose: true\n}</code></pre>\n<p><code>options</code> can include <code>start</code> and <code>end</code> values to read a range of bytes from\nthe file instead of the entire file. Both <code>start</code> and <code>end</code> are inclusive and\nstart at 0. The <code>encoding</code> can be <code>'utf8'</code>, <code>'ascii'</code>, or <code>'base64'</code>.\n\n</p>\n<p>If <code>autoClose</code> is false, then the file descriptor won't be closed, even if\nthere's an error. It is your responsiblity to close it and make sure\nthere's no file descriptor leak. If <code>autoClose</code> is set to true (default\nbehavior), on <code>error</code> or <code>end</code> the file descriptor will be closed\nautomatically.\n\n</p>\n<p>An example to read the last 10 bytes of a file which is 100 bytes long:\n\n</p>\n<pre><code>fs.createReadStream('sample.txt', {start: 90, end: 99});</code></pre>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| }, |
| { |
| "textRaw": "fs.createWriteStream(path, [options])", |
| "type": "method", |
| "name": "createWriteStream", |
| "desc": "<p>Returns a new WriteStream object (See <code>Writable Stream</code>).\n\n</p>\n<p><code>options</code> is an object with the following defaults:\n\n</p>\n<pre><code>{ flags: 'w',\n encoding: null,\n mode: 0666 }</code></pre>\n<p><code>options</code> may also include a <code>start</code> option to allow writing data at\nsome position past the beginning of the file. Modifying a file rather\nthan replacing it may require a <code>flags</code> mode of <code>r+</code> rather than the\ndefault mode <code>w</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [ |
| { |
| "name": "path" |
| }, |
| { |
| "name": "options", |
| "optional": true |
| } |
| ] |
| } |
| ] |
| } |
| ], |
| "classes": [ |
| { |
| "textRaw": "Class: fs.Stats", |
| "type": "class", |
| "name": "fs.Stats", |
| "desc": "<p>Objects returned from <code>fs.stat()</code>, <code>fs.lstat()</code> and <code>fs.fstat()</code> and their\nsynchronous counterparts are of this type.\n\n</p>\n<ul>\n<li><code>stats.isFile()</code></li>\n<li><code>stats.isDirectory()</code></li>\n<li><code>stats.isBlockDevice()</code></li>\n<li><code>stats.isCharacterDevice()</code></li>\n<li><code>stats.isSymbolicLink()</code> (only valid with <code>fs.lstat()</code>)</li>\n<li><code>stats.isFIFO()</code></li>\n<li><code>stats.isSocket()</code></li>\n</ul>\n<p>For a regular file <code>util.inspect(stats)</code> would return a string very\nsimilar to this:\n\n</p>\n<pre><code>{ dev: 2114,\n ino: 48064969,\n mode: 33188,\n nlink: 1,\n uid: 85,\n gid: 100,\n rdev: 0,\n size: 527,\n blksize: 4096,\n blocks: 8,\n atime: Mon, 10 Oct 2011 23:24:11 GMT,\n mtime: Mon, 10 Oct 2011 23:24:11 GMT,\n ctime: Mon, 10 Oct 2011 23:24:11 GMT }</code></pre>\n<p>Please note that <code>atime</code>, <code>mtime</code> and <code>ctime</code> are instances\nof [Date][MDN-Date] object and to compare the values of\nthese objects you should use appropriate methods. For most\ngeneral uses [getTime()][MDN-Date-getTime] will return\nthe number of milliseconds elapsed since <em>1 January 1970\n00:00:00 UTC</em> and this integer should be sufficient for\nany comparison, however there additional methods which can\nbe used for displaying fuzzy information. More details can\nbe found in the [MDN JavaScript Reference][MDN-Date] page.\n\n</p>\n" |
| }, |
| { |
| "textRaw": "Class: fs.ReadStream", |
| "type": "class", |
| "name": "fs.ReadStream", |
| "desc": "<p><code>ReadStream</code> is a <a href=\"stream.html#stream_class_stream_readable\">Readable Stream</a>.\n\n</p>\n", |
| "events": [ |
| { |
| "textRaw": "Event: 'open'", |
| "type": "event", |
| "name": "open", |
| "params": [], |
| "desc": "<p>Emitted when the ReadStream's file is opened.\n\n\n</p>\n" |
| } |
| ] |
| }, |
| { |
| "textRaw": "Class: fs.WriteStream", |
| "type": "class", |
| "name": "fs.WriteStream", |
| "desc": "<p><code>WriteStream</code> is a <a href=\"stream.html#stream_class_stream_writable\">Writable Stream</a>.\n\n</p>\n", |
| "events": [ |
| { |
| "textRaw": "Event: 'open'", |
| "type": "event", |
| "name": "open", |
| "params": [], |
| "desc": "<p>Emitted when the WriteStream's file is opened.\n\n</p>\n" |
| } |
| ], |
| "properties": [ |
| { |
| "textRaw": "file.bytesWritten", |
| "name": "bytesWritten", |
| "desc": "<p>The number of bytes written so far. Does not include data that is still queued\nfor writing.\n\n</p>\n" |
| } |
| ] |
| }, |
| { |
| "textRaw": "Class: fs.FSWatcher", |
| "type": "class", |
| "name": "fs.FSWatcher", |
| "desc": "<p>Objects returned from <code>fs.watch()</code> are of this type.\n\n</p>\n", |
| "methods": [ |
| { |
| "textRaw": "watcher.close()", |
| "type": "method", |
| "name": "close", |
| "desc": "<p>Stop watching for changes on the given <code>fs.FSWatcher</code>.\n\n</p>\n", |
| "signatures": [ |
| { |
| "params": [] |
| } |
| ] |
| } |
| ], |
| "events": [ |
| { |
| "textRaw": "Event: 'change'", |
| "type": "event", |
| "name": "change", |
| "params": [], |
| "desc": "<p>Emitted when something changes in a watched directory or file.\nSee more details in <a href=\"#fs_fs_watch_filename_options_listener\">fs.watch</a>.\n\n</p>\n" |
| }, |
| { |
| "textRaw": "Event: 'error'", |
| "type": "event", |
| "name": "error", |
| "params": [], |
| "desc": "<p>Emitted when an error occurs.\n</p>\n" |
| } |
| ] |
| } |
| ], |
| "type": "module", |
| "displayName": "fs" |
| } |
| ] |
| } |
