Commit 193d1d0
doc: document fs.watchFile() bigint option
This commit documents the bigint option to fs.watchFile(), which
has been supported since v10.5.0.
PR-URL: #32128
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>1 parent 74b00cc commit 193d1d0
1 file changed
Lines changed: 6 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3369,6 +3369,9 @@ fs.watch('somedir', (eventType, filename) => { | |||
| 3369 | 3369 | <!-- YAML | |
| 3370 | 3370 | added: v0.1.31 | |
| 3371 | 3371 | changes: | |
| 3372 | + - version: v10.5.0 | ||
| 3373 | + pr-url: https://github.com/nodejs/node/pull/20220 | ||
| 3374 | + description: The `bigint` option is now supported. | ||
| 3372 | 3375 | - version: v7.6.0 | |
| 3373 | 3376 | pr-url: https://github.com/nodejs/node/pull/10739 | |
| 3374 | 3377 | description: The `filename` parameter can be a WHATWG `URL` object using | |
@@ -3377,6 +3380,7 @@ changes: | |||
| 3377 | 3380 | ||
| 3378 | 3381 | * `filename` {string|Buffer|URL} | |
| 3379 | 3382 | * `options` {Object} | |
| 3383 | + * `bigint` {boolean} **Default:** `false` | ||
| 3380 | 3384 | * `persistent` {boolean} **Default:** `true` | |
| 3381 | 3385 | * `interval` {integer} **Default:** `5007` | |
| 3382 | 3386 | * `listener` {Function} | |
@@ -3402,7 +3406,8 @@ fs.watchFile('message.text', (curr, prev) => { | |||
| 3402 | 3406 | }); | |
| 3403 | 3407 | ``` | |
| 3404 | 3408 | ||
| 3405 | - These stat objects are instances of `fs.Stat`. | ||
| 3409 | + These stat objects are instances of `fs.Stat`. If the `bigint` option is `true`, | ||
| 3410 | + the numeric values in these objects are specified as `BigInt`s. | ||
| 3406 | 3411 | ||
| 3407 | 3412 | To be notified when the file was modified, not just accessed, it is necessary | |
| 3408 | 3413 | to compare `curr.mtime` and `prev.mtime`. | |
0 commit comments