1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify options for fs.watchFile()

Browse Source 
The explanation for the `options` argument to `fs.watchFile()` had
missing punctuation. I took the opportunity to try to rewrite the
paragraph for greater clarity.

PR-URL: https://github.com/nodejs/node/pull/2425
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
This commit is contained in:
Rich Trott 2015-08-18 08:38:20 -07:00
parent 522f8a8071
commit 3ba9793d53
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/fs.markdown
View File

@ -557,11 +557,12 @@ The synchronous version of `fs.appendFile`. Returns `undefined`.
Watch for changes on `filename`. The callback `listener` will be called each Watch for changes on `filename`. The callback `listener` will be called each
time the file is accessed. time the file is accessed.
The second argument is optional. The `options` if provided should be an object The `options` argument may be omitted. If provided, it should be an object. The
containing two members a boolean, `persistent`, and `interval`. `persistent` `options` object may contain a boolean named `persistent` that indicates
indicates whether the process should continue to run as long as files are whether the process should continue to run as long as files are being watched.
being watched. `interval` indicates how often the target should be polled, The `options` object may specify an `interval` property indicating how often the
in milliseconds. The default is `{ persistent: true, interval: 5007 }`. 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 The `listener` gets two arguments the current stat object and the previous
stat object: stat object: