Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: stability index 2 = stable in fs.markdown, fixes #1754 #1775

Closed
wants to merge 4 commits into from
Closed

doc: stability index 2 = stable in fs.markdown, fixes #1754 #1775

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad12cc2
doc: stability index 2 = stable (fs)
Trott May 23, 2015
25bd352
doc: rm redundant stability index indication in fs.markdown
Trott May 23, 2015
0cc60e5
doc: rm redundant inline stability notices, incorporate advisory text…
Trott May 24, 2015
97120bc
doc: set off note in styling consistent with existing docs
Trott May 26, 2015
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
14 changes: 8 additions & 6 deletions doc/api/fs.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,8 +534,6 @@ The synchronous version of `fs.appendFile`.

## 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.

Expand All @@ -558,9 +556,11 @@ 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])
_Note: `fs.watch` is more efficient than `fs.watchFile` and `fs.unwatchFile`.
`fs.watch` should be used instead of `fs.watchFile` and `fs.unwatchFile`
when possible._

Stability: 2 - Unstable. Use fs.watch instead, if possible.
## fs.unwatchFile(filename[, listener])

Stop watching for changes on `filename`. If `listener` is specified, only that
particular listener is removed. Otherwise, *all* listeners are removed and you
Expand All @@ -569,9 +569,11 @@ 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])
_Note: `fs.watch` is more efficient than `fs.watchFile` and `fs.unwatchFile`.
`fs.watch` should be used instead of `fs.watchFile` and `fs.unwatchFile`
when possible._

Stability: 2 - Unstable.
## fs.watch(filename[, options][, listener])

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).
Expand Down