You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

738 lines
22 KiB

13 years ago
# File System
Stability: 3 - Stable
<!--name=fs-->
File I/O is provided by simple wrappers around standard POSIX functions. To
use this module do `require('fs')`. All the methods have asynchronous and
synchronous forms.
The asynchronous form always take a completion callback as its last argument.
The arguments passed to the completion callback depend on the method, but the
first argument is always reserved for an exception. If the operation was
completed successfully, then the first argument will be `null` or `undefined`.
When using the synchronous form any exceptions are immediately thrown.
You can use try/catch to handle exceptions or allow them to bubble up.
Here is an example of the asynchronous version:
var fs = require('fs');
fs.unlink('/tmp/hello', function (err) {
if (err) throw err;
console.log('successfully deleted /tmp/hello');
});
Here is the synchronous version:
var fs = require('fs');
fs.unlinkSync('/tmp/hello')
console.log('successfully deleted /tmp/hello');
With the asynchronous methods there is no guaranteed ordering. So the
following is prone to error:
fs.rename('/tmp/hello', '/tmp/world', function (err) {
if (err) throw err;
console.log('renamed complete');
});
fs.stat('/tmp/world', function (err, stats) {
if (err) throw err;
console.log('stats: ' + JSON.stringify(stats));
});
It could be that `fs.stat` is executed before `fs.rename`.
The correct way to do this is to chain the callbacks.
fs.rename('/tmp/hello', '/tmp/world', function (err) {
if (err) throw err;
fs.stat('/tmp/world', function (err, stats) {
if (err) throw err;
console.log('stats: ' + JSON.stringify(stats));
});
});
In busy processes, the programmer is _strongly encouraged_ to use the
asynchronous versions of these calls. The synchronous versions will block
the entire process until they complete--halting all connections.
Relative path to filename can be used, remember however that this path will be
relative to `process.cwd()`.
Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the NODE_DEBUG environment variable:
$ cat script.js
function bad() {
require('fs').readFile('/');
}
bad();
$ env NODE_DEBUG=fs node script.js
fs.js:66
throw err;
^
Error: EISDIR, read
at rethrow (fs.js:61:21)
at maybeCallback (fs.js:79:42)
at Object.fs.readFile (fs.js:153:18)
at bad (/path/to/script.js:2:17)
at Object.<anonymous> (/path/to/script.js:5:1)
<etc.>
## fs.rename(oldPath, newPath, [callback])
Asynchronous rename(2). No arguments other than a possible exception are given
to the completion callback.
## fs.renameSync(oldPath, newPath)
Synchronous rename(2).
## fs.ftruncate(fd, len, [callback])
Asynchronous ftruncate(2). No arguments other than a possible exception are
given to the completion callback.
## fs.ftruncateSync(fd, len)
Synchronous ftruncate(2).
## fs.truncate(path, len, [callback])
Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback.
## fs.truncateSync(path, len)
Synchronous truncate(2).
13 years ago
## fs.chown(path, uid, gid, [callback])
Asynchronous chown(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.chownSync(path, uid, gid)
Synchronous chown(2).
13 years ago
## fs.fchown(fd, uid, gid, [callback])
Asynchronous fchown(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.fchownSync(fd, uid, gid)
Synchronous fchown(2).
13 years ago
## fs.lchown(path, uid, gid, [callback])
Asynchronous lchown(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.lchownSync(path, uid, gid)
Synchronous lchown(2).
13 years ago
## fs.chmod(path, mode, [callback])
Asynchronous chmod(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.chmodSync(path, mode)
Synchronous chmod(2).
13 years ago
## fs.fchmod(fd, mode, [callback])
Asynchronous fchmod(2). No arguments other than a possible exception
are given to the completion callback.
13 years ago
## fs.fchmodSync(fd, mode)
Synchronous fchmod(2).
13 years ago
## fs.lchmod(path, mode, [callback])
Asynchronous lchmod(2). No arguments other than a possible exception
are given to the completion callback.
Only available on Mac OS X.
13 years ago
## fs.lchmodSync(path, mode)
Synchronous lchmod(2).
13 years ago
## fs.stat(path, [callback])
Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
`stats` is a [fs.Stats](#fs_class_fs_stats) object. See the [fs.Stats](#fs_class_fs_stats)
section below for more information.
13 years ago
## fs.lstat(path, [callback])
Asynchronous lstat(2). The callback gets two arguments `(err, stats)` where
`stats` is a `fs.Stats` object. `lstat()` is identical to `stat()`, except that if
`path` is a symbolic link, then the link itself is stat-ed, not the file that it
refers to.
13 years ago
## fs.fstat(fd, [callback])
Asynchronous fstat(2). The callback gets two arguments `(err, stats)` where
`stats` is a `fs.Stats` object. `fstat()` is identical to `stat()`, except that
the file to be stat-ed is specified by the file descriptor `fd`.
13 years ago
## fs.statSync(path)
Synchronous stat(2). Returns an instance of `fs.Stats`.
13 years ago
## fs.lstatSync(path)
Synchronous lstat(2). Returns an instance of `fs.Stats`.
13 years ago
## fs.fstatSync(fd)
Synchronous fstat(2). Returns an instance of `fs.Stats`.
13 years ago
## fs.link(srcpath, dstpath, [callback])
Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.
13 years ago
## fs.linkSync(srcpath, dstpath)
Synchronous link(2).
## fs.symlink(srcpath, dstpath, [type], [callback])
Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback.
`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only
used on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute. When using
`'junction'`, the `destination` argument will automatically be normalized to absolute path.
## fs.symlinkSync(srcpath, dstpath, [type])
Synchronous symlink(2).
13 years ago
## fs.readlink(path, [callback])
Asynchronous readlink(2). The callback gets two arguments `(err,
linkString)`.
13 years ago
## fs.readlinkSync(path)
Synchronous readlink(2). Returns the symbolic link's string value.
## fs.realpath(path, [cache], callback)
Asynchronous realpath(2). The `callback` gets two arguments `(err,
resolvedPath)`. May use `process.cwd` to resolve relative paths. `cache` is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional `fs.stat` calls for known real paths.
Example:
var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
if (err) throw err;
console.log(resolvedPath);
});
## fs.realpathSync(path, [cache])
Synchronous realpath(2). Returns the resolved path.
13 years ago
## fs.unlink(path, [callback])
Asynchronous unlink(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.unlinkSync(path)
Synchronous unlink(2).
13 years ago
## fs.rmdir(path, [callback])
Asynchronous rmdir(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.rmdirSync(path)
Synchronous rmdir(2).
13 years ago
## fs.mkdir(path, [mode], [callback])
Asynchronous mkdir(2). No arguments other than a possible exception are given
to the completion callback. `mode` defaults to `0777`.
13 years ago
## fs.mkdirSync(path, [mode])
Synchronous mkdir(2).
13 years ago
## fs.readdir(path, [callback])
Asynchronous readdir(3). Reads the contents of a directory.
The callback gets two arguments `(err, files)` where `files` is an array of
the names of the files in the directory excluding `'.'` and `'..'`.
13 years ago
## fs.readdirSync(path)
Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`.
13 years ago
## fs.close(fd, [callback])
Asynchronous close(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.closeSync(fd)
Synchronous close(2).
13 years ago
## fs.open(path, flags, [mode], [callback])
Asynchronous file open. See open(2). `flags` can be:
* `'r'` - Open file for reading.
An exception occurs if the file does not exist.
* `'r+'` - Open file for reading and writing.
An exception occurs if the file does not exist.
* `'rs'` - Open file for reading in synchronous mode. Instructs the operating
system to bypass the local file system cache.
This is primarily useful for opening files on NFS mounts as it allows you to
skip the potentially stale local cache. It has a very real impact on I/O
performance so don't use this mode unless you need it.
Note that this doesn't turn `fs.open()` into a synchronous blocking call.
If that's what you want then you should be using `fs.openSync()`
* `'rs+'` - Open file for reading and writing, telling the OS to open it
synchronously. See notes for `'rs'` about using this with caution.
* `'w'` - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists).
* `'wx'` - Like `'w'` but opens the file in exclusive mode.
* `'w+'` - Open file for reading and writing.
The file is created (if it does not exist) or truncated (if it exists).
* `'wx+'` - Like `'w+'` but opens the file in exclusive mode.
* `'a'` - Open file for appending.
The file is created if it does not exist.
* `'ax'` - Like `'a'` but opens the file in exclusive mode.
* `'a+'` - Open file for reading and appending.
The file is created if it does not exist.
* `'ax+'` - Like `'a+'` but opens the file in exclusive mode.
`mode` defaults to `0666`. The callback gets two arguments `(err, fd)`.
Exclusive mode (`O_EXCL`) ensures that `path` is newly created. `fs.open()`
fails if a file by that name already exists. On POSIX systems, symlinks are
not followed. Exclusive mode may or may not work with network file systems.
13 years ago
## fs.openSync(path, flags, [mode])
Synchronous open(2).
13 years ago
## fs.utimes(path, atime, mtime, [callback])
## fs.utimesSync(path, atime, mtime)
Change file timestamps of the file referenced by the supplied path.
13 years ago
## fs.futimes(fd, atime, mtime, [callback])
## fs.futimesSync(fd, atime, mtime)
Change the file timestamps of a file referenced by the supplied file
descriptor.
13 years ago
## fs.fsync(fd, [callback])
Asynchronous fsync(2). No arguments other than a possible exception are given
to the completion callback.
13 years ago
## fs.fsyncSync(fd)
Synchronous fsync(2).
13 years ago
## fs.write(fd, buffer, offset, length, position, [callback])
Write `buffer` to the file specified by `fd`.
`offset` and `length` determine the part of the buffer to be written.
`position` refers to the offset from the beginning of the file where this data
should be written. If `position` is `null`, the data will be written at the
current position.
See pwrite(2).
The callback will be given three arguments `(err, written, buffer)` where `written`
specifies how many _bytes_ were written from `buffer`.
Note that it is unsafe to use `fs.write` multiple times on the same file
without waiting for the callback. For this scenario,
`fs.createWriteStream` is strongly recommended.
13 years ago
## fs.writeSync(fd, buffer, offset, length, position)
Synchronous version of `fs.write()`. Returns the number of bytes written.
13 years ago
## fs.read(fd, buffer, offset, length, position, [callback])
Read data from the file specified by `fd`.
`buffer` is the buffer that the data will be written to.
`offset` is offset within the buffer where reading will start.
`length` is an integer specifying the number of bytes to read.
`position` is an integer specifying where to begin reading from in the file.
If `position` is `null`, data will be read from the current file position.
The callback is given the three arguments, `(err, bytesRead, buffer)`.
13 years ago
## fs.readSync(fd, buffer, offset, length, position)
Synchronous version of `fs.read`. Returns the number of `bytesRead`.
## fs.readFile(filename, [options], [callback])
* `filename` {String}
* `options` {Object}
* `encoding` {String | Null} default = `null`
* `flag` {String} default = `'r'`
Asynchronously reads the entire contents of a file. Example:
fs.readFile('/etc/passwd', function (err, data) {
if (err) throw err;
console.log(data);
});
The callback is passed two arguments `(err, data)`, where `data` is the
contents of the file.
If no encoding is specified, then the raw buffer is returned.
## fs.readFileSync(filename, [options])
Synchronous version of `fs.readFile`. Returns the contents of the `filename`.
If the `encoding` option is specified then this function returns a
string. Otherwise it returns a buffer.
## fs.writeFile(filename, data, [options], [callback])
* `filename` {String}
* `data` {String | Buffer}
* `options` {Object}
* `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `438` (aka `0666` in Octal)
* `flag` {String} default = `'w'`
Asynchronously writes data to a file, replacing the file if it already exists.
`data` can be a string or a buffer.
The `encoding` option is ignored if `data` is a buffer. It defaults
to `'utf8'`.
Example:
fs.writeFile('message.txt', 'Hello Node', function (err) {
if (err) throw err;
console.log('It\'s saved!');
});
## fs.writeFileSync(filename, data, [options])
The synchronous version of `fs.writeFile`.
## fs.appendFile(filename, data, [options], [callback])
* `filename` {String}
* `data` {String | Buffer}
* `options` {Object}
* `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `438` (aka `0666` in Octal)
* `flag` {String} default = `'a'`
Asynchronously append data to a file, creating the file if it not yet exists.
`data` can be a string or a buffer.
Example:
fs.appendFile('message.txt', 'data to append', function (err) {
if (err) throw err;
console.log('The "data to append" was appended to file!');
});
## fs.appendFileSync(filename, data, [options])
The synchronous version of `fs.appendFile`.
13 years ago
## fs.watchFile(filename, [options], listener)
Stability: 2 - Unstable. Use fs.watch instead, if possible.
Watch for changes on `filename`. The callback `listener` will be called each
time the file is accessed.
The second argument is optional. The `options` if provided should be an object
containing two members a boolean, `persistent`, and `interval`. `persistent`
indicates whether the process should continue to run as long as files are
being watched. `interval` indicates how often the target should be polled,
in milliseconds. The default is `{ persistent: true, interval: 5007 }`.
The `listener` gets two arguments the current stat object and the previous
stat object:
fs.watchFile('message.text', function (curr, prev) {
console.log('the current mtime is: ' + curr.mtime);
console.log('the previous mtime was: ' + prev.mtime);
});
These stat objects are instances of `fs.Stat`.
If you want to be notified when the file was modified, not just accessed
you need to compare `curr.mtime` and `prev.mtime`.
## fs.unwatchFile(filename, [listener])
Stability: 2 - Unstable. Use fs.watch instead, if available.
Stop watching for changes on `filename`. If `listener` is specified, only that
particular listener is removed. Otherwise, *all* listeners are removed and you
have effectively stopped watching `filename`.
Calling `fs.unwatchFile()` with a filename that is not being watched is a
no-op, not an error.
## fs.watch(filename, [options], [listener])
Stability: 2 - Unstable.
Watch for changes on `filename`, where `filename` is either a file or a
directory. The returned object is a [fs.FSWatcher](#fs_class_fs_fswatcher).
The second argument is optional. The `options` if provided should be an object
containing a boolean member `persistent`, which indicates whether the process
should continue to run as long as files are being watched. The default is
`{ persistent: true }`.
The listener callback gets two arguments `(event, filename)`. `event` is either
'rename' or 'change', and `filename` is the name of the file which triggered
the event.
### Caveats
<!--type=misc-->
The `fs.watch` API is not 100% consistent across platforms, and is
unavailable in some situations.
#### Availability
<!--type=misc-->
This feature depends on the underlying operating system providing a way
to be notified of filesystem changes.
* On Linux systems, this uses `inotify`.
* On BSD systems (including OS X), this uses `kqueue`.
* On SunOS systems (including Solaris and SmartOS), this uses `event ports`.
* On Windows systems, this feature depends on `ReadDirectoryChangesW`.
If the underlying functionality is not available for some reason, then
`fs.watch` will not be able to function. For example, watching files or
directories on network file systems (NFS, SMB, etc.) often doesn't work
reliably or at all.
You can still use `fs.watchFile`, which uses stat polling, but it is slower and
less reliable.
#### Filename Argument
<!--type=misc-->
Providing `filename` argument in the callback is not supported
on every platform (currently it's only supported on Linux and Windows). Even
on supported platforms `filename` is not always guaranteed to be provided.
Therefore, don't assume that `filename` argument is always provided in the
callback, and have some fallback logic if it is null.
fs.watch('somedir', function (event, filename) {
console.log('event is: ' + event);
if (filename) {
console.log('filename provided: ' + filename);
} else {
console.log('filename not provided');
}
});
## fs.exists(path, [callback])
Test whether or not the given path exists by checking with the file system.
Then call the `callback` argument with either true or false. Example:
fs.exists('/etc/passwd', function (exists) {
util.debug(exists ? "it's there" : "no passwd!");
});
## fs.existsSync(path)
Synchronous version of `fs.exists`.
13 years ago
## Class: fs.Stats
Objects returned from `fs.stat()`, `fs.lstat()` and `fs.fstat()` and their
synchronous counterparts are of this type.
- `stats.isFile()`
- `stats.isDirectory()`
- `stats.isBlockDevice()`
- `stats.isCharacterDevice()`
- `stats.isSymbolicLink()` (only valid with `fs.lstat()`)
- `stats.isFIFO()`
- `stats.isSocket()`
For a regular file `util.inspect(stats)` would return a string very
similar to this:
{ dev: 2114,
ino: 48064969,
mode: 33188,
nlink: 1,
uid: 85,
gid: 100,
rdev: 0,
size: 527,
blksize: 4096,
blocks: 8,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT }
Please note that `atime`, `mtime` and `ctime` are instances
of [Date][MDN-Date] object and to compare the values of
these objects you should use appropriate methods. For most
general uses [getTime()][MDN-Date-getTime] will return
the number of milliseconds elapsed since _1 January 1970
00:00:00 UTC_ and this integer should be sufficient for
any comparison, however there additional methods which can
be used for displaying fuzzy information. More details can
be found in the [MDN JavaScript Reference][MDN-Date] page.
[MDN-Date]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date
[MDN-Date-getTime]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date/getTime
13 years ago
## fs.createReadStream(path, [options])
Returns a new ReadStream object (See `Readable Stream`).
`options` is an object with the following defaults:
{ flags: 'r',
encoding: null,
fd: null,
mode: 0666,
bufferSize: 64 * 1024,
autoClose: true
}
`options` can include `start` and `end` values to read a range of bytes from
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 `autoClose` is false, then the file descriptor won't be closed, even if
there's an error. It is your responsiblity to close it and make sure
there's no file descriptor leak. If `autoClose` is set to true (default
behavior), on `error` or `end` the file descriptor will be closed
automatically.
An example to read the last 10 bytes of a file which is 100 bytes long:
fs.createReadStream('sample.txt', {start: 90, end: 99});
13 years ago
## Class: fs.ReadStream
`ReadStream` is a [Readable Stream](stream.html#stream_readable_stream).
### Event: 'open'
* `fd` {Integer} file descriptor used by the ReadStream.
Emitted when the ReadStream's file is opened.
13 years ago
## fs.createWriteStream(path, [options])
Returns a new WriteStream object (See `Writable Stream`).
`options` is an object with the following defaults:
{ flags: 'w',
encoding: 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`.
13 years ago
## fs.WriteStream
`WriteStream` is a [Writable Stream](stream.html#stream_writable_stream).
13 years ago
### Event: 'open'
Merge remote-tracking branch &#39;ry/v0.6&#39; into v0.6-merge Conflicts: ChangeLog Makefile deps/npm/AUTHORS deps/npm/html/api/bin.html deps/npm/html/api/bugs.html deps/npm/html/api/commands.html deps/npm/html/api/config.html deps/npm/html/api/deprecate.html deps/npm/html/api/docs.html deps/npm/html/api/edit.html deps/npm/html/api/explore.html deps/npm/html/api/help-search.html deps/npm/html/api/init.html deps/npm/html/api/install.html deps/npm/html/api/link.html deps/npm/html/api/load.html deps/npm/html/api/ls.html deps/npm/html/api/npm.html deps/npm/html/api/outdated.html deps/npm/html/api/owner.html deps/npm/html/api/pack.html deps/npm/html/api/prefix.html deps/npm/html/api/prune.html deps/npm/html/api/publish.html deps/npm/html/api/rebuild.html deps/npm/html/api/restart.html deps/npm/html/api/root.html deps/npm/html/api/run-script.html deps/npm/html/api/search.html deps/npm/html/api/shrinkwrap.html deps/npm/html/api/start.html deps/npm/html/api/stop.html deps/npm/html/api/submodule.html deps/npm/html/api/tag.html deps/npm/html/api/test.html deps/npm/html/api/uninstall.html deps/npm/html/api/unpublish.html deps/npm/html/api/update.html deps/npm/html/api/version.html deps/npm/html/api/view.html deps/npm/html/api/whoami.html deps/npm/html/doc/README.html deps/npm/html/doc/adduser.html deps/npm/html/doc/bin.html deps/npm/html/doc/bugs.html deps/npm/html/doc/build.html deps/npm/html/doc/bundle.html deps/npm/html/doc/cache.html deps/npm/html/doc/changelog.html deps/npm/html/doc/coding-style.html deps/npm/html/doc/completion.html deps/npm/html/doc/config.html deps/npm/html/doc/deprecate.html deps/npm/html/doc/developers.html deps/npm/html/doc/disputes.html deps/npm/html/doc/docs.html deps/npm/html/doc/edit.html deps/npm/html/doc/explore.html deps/npm/html/doc/faq.html deps/npm/html/doc/folders.html deps/npm/html/doc/help-search.html deps/npm/html/doc/help.html deps/npm/html/doc/index.html deps/npm/html/doc/init.html deps/npm/html/doc/install.html deps/npm/html/doc/json.html deps/npm/html/doc/link.html deps/npm/html/doc/list.html deps/npm/html/doc/npm.html deps/npm/html/doc/outdated.html deps/npm/html/doc/owner.html deps/npm/html/doc/pack.html deps/npm/html/doc/prefix.html deps/npm/html/doc/prune.html deps/npm/html/doc/publish.html deps/npm/html/doc/rebuild.html deps/npm/html/doc/registry.html deps/npm/html/doc/removing-npm.html deps/npm/html/doc/restart.html deps/npm/html/doc/root.html deps/npm/html/doc/run-script.html deps/npm/html/doc/scripts.html deps/npm/html/doc/search.html deps/npm/html/doc/semver.html deps/npm/html/doc/shrinkwrap.html deps/npm/html/doc/star.html deps/npm/html/doc/start.html deps/npm/html/doc/stop.html deps/npm/html/doc/submodule.html deps/npm/html/doc/tag.html deps/npm/html/doc/test.html deps/npm/html/doc/uninstall.html deps/npm/html/doc/unpublish.html deps/npm/html/doc/update.html deps/npm/html/doc/version.html deps/npm/html/doc/view.html deps/npm/html/doc/whoami.html deps/npm/lib/install.js deps/npm/lib/ls.js deps/npm/man/man1/npm.1 deps/npm/man/man1/shrinkwrap.1 deps/npm/man/man3/npm.3 deps/npm/man/man3/shrinkwrap.3 deps/npm/node_modules/request/main.js deps/npm/node_modules/request/package.json deps/npm/package.json deps/uv/src/unix/core.c deps/v8/src/conversions-inl.h deps/v8/src/elements.cc deps/v8/src/version.cc doc/about/index.html doc/api/assert.markdown doc/api/child_process.markdown doc/api/cluster.markdown doc/api/crypto.markdown doc/api/debugger.markdown doc/api/dgram.markdown doc/api/dns.markdown doc/api/documentation.markdown doc/api/events.markdown doc/api/fs.markdown doc/api/globals.markdown doc/api/http.markdown doc/api/https.markdown doc/api/modules.markdown doc/api/net.markdown doc/api/os.markdown doc/api/path.markdown doc/api/process.markdown doc/api/querystring.markdown doc/api/readline.markdown doc/api/stdio.markdown doc/api/stream.markdown doc/api/timers.markdown doc/api/tls.markdown doc/api/tty.markdown doc/api/url.markdown doc/api/util.markdown doc/api/vm.markdown doc/api/zlib.markdown doc/api_assets/style.css doc/community/index.html doc/index.html doc/logos/index.html doc/template.html src/node_version.h tools/doc/html.js tools/gyp/test/mac/app-bundle/empty.c
13 years ago
* `fd` {Integer} file descriptor used by the WriteStream.
13 years ago
Emitted when the WriteStream's file is opened.
13 years ago
### file.bytesWritten
The number of bytes written so far. Does not include data that is still queued
for writing.
## Class: fs.FSWatcher
Objects returned from `fs.watch()` are of this type.
13 years ago
### watcher.close()
Stop watching for changes on the given `fs.FSWatcher`.
13 years ago
### Event: 'change'
13 years ago
* `event` {String} The type of fs change
* `filename` {String} The filename that changed (if relevant/available)
Emitted when something changes in a watched directory or file.
See more details in [fs.watch](#fs_fs_watch_filename_options_listener).
13 years ago
### Event: 'error'
* `error` {Error object}
Emitted when an error occurs.