Skip to content

Commit 5b4521f

Browse files
mradbourneaduh95
authored andcommitted
doc: fix fsPromises.watch overflow value
Updates the fsPromises.watch overflow option description to use 'error' instead of 'throw', which matches the implementation. Signed-off-by: Matt Radbourne <1254508+mradbourne@users.noreply.github.com> PR-URL: #64605 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent ba1b440 commit 5b4521f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

doc/api/fs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2229,9 +2229,9 @@ added:
22292229
should stop.
22302230
* `maxQueue` {number} Specifies the number of events to queue between iterations
22312231
of the {AsyncIterator} returned. **Default:** `2048`.
2232-
* `overflow` {string} Either `'ignore'` or `'throw'` when there are more events to be
2232+
* `overflow` {string} Either `'ignore'` or `'error'` when there are more events to be
22332233
queued than `maxQueue` allows. `'ignore'` means overflow events are dropped and a
2234-
warning is emitted, while `'throw'` means to throw an exception. **Default:** `'ignore'`.
2234+
warning is emitted, while `'error'` means to throw an exception. **Default:** `'ignore'`.
22352235
* `ignore` {string|RegExp|Function|Array} Pattern(s) to ignore. Strings are
22362236
glob patterns (using [`minimatch`][]), RegExp patterns are tested against
22372237
the filename, and functions receive the filename and return `true` to

0 commit comments

Comments
 (0)