Skip to content

doc: correct default highWaterMark values #64617

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

Open
umuoy1 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −6
Open

doc: correct default highWaterMark values #64617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,9 @@
<!-- YAML
added: v16.11.0
changes:
- version: v22.0.0
pr-url: https://github.com/nodejs/node/pull/52037

Check warning on line 327 in doc/api/fs.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: bump default highWaterMark.
- version:
- v21.0.0
- v20.10.0
Expand All @@ -335,7 +338,8 @@
* `autoClose` {boolean} **Default:** `true`
* `emitClose` {boolean} **Default:** `true`
* `start` {integer}
* `highWaterMark` {number} **Default:** `16384`
* `highWaterMark` {number} **Default:** See
[`stream.getDefaultHighWaterMark()`][].
* `flush` {boolean} If `true`, the underlying file descriptor is flushed
prior to closing it. **Default:** `false`.
* Returns: {fs.WriteStream}
Expand Down Expand Up @@ -3057,6 +3061,9 @@
<!-- YAML
added: v0.1.31
changes:
- version: v22.0.0
pr-url: https://github.com/nodejs/node/pull/52037

Check warning on line 3065 in doc/api/fs.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: bump default highWaterMark.
- version:
- v21.0.0
- v20.10.0
Expand Down Expand Up @@ -3114,7 +3121,8 @@
* `start` {integer}
* `fs` {Object|null} **Default:** `null`
* `signal` {AbortSignal|null} **Default:** `null`
* `highWaterMark` {number} **Default:** `16384`
* `highWaterMark` {number} **Default:** See
[`stream.getDefaultHighWaterMark()`][].
* `flush` {boolean} If `true`, the underlying file descriptor is flushed
prior to closing it. **Default:** `false`.
* Returns: {fs.WriteStream}
Expand Down Expand Up @@ -9330,6 +9338,7 @@
[`minimatch`]: https://github.com/isaacs/minimatch
[`node:stream/iter`]: stream_iter.md
[`statfs.bsize`]: #statfsbsize
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
Expand Down
10 changes: 6 additions & 4 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3637,8 +3637,9 @@ added:
* `objectMode` {boolean}
* Returns: {integer}

Returns the default highWaterMark used by streams.
Defaults to `65536` (64 KiB), or `16` for `objectMode`.
Returns the default highWaterMark used by streams. Defaults to `16` for
`objectMode`. For byte streams, it defaults to `65536` (64 KiB) on non-Windows
platforms and `16384` (16 KiB) on Windows.

### `stream.setDefaultHighWaterMark(objectMode, value)`

Expand Down Expand Up @@ -3768,7 +3769,7 @@ changes:
* `options` {Object}
* `highWaterMark` {number} Buffer level when
[`stream.write()`][stream-write] starts returning `false`. **Default:**
`65536` (64 KiB), or `16` for `objectMode` streams.
See [`stream.getDefaultHighWaterMark()`][].
* `decodeStrings` {boolean} Whether to encode `string`s passed to
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
specified in the [`stream.write()`][stream-write] call) before passing
Expand Down Expand Up @@ -4142,7 +4143,7 @@ changes:
* `options` {Object}
* `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
in the internal buffer before ceasing to read from the underlying resource.
**Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
**Default:** See [`stream.getDefaultHighWaterMark()`][].
* `encoding` {string} If specified, then buffers will be decoded to
strings using the specified encoding. **Default:** `null`.
* `objectMode` {boolean} Whether this stream should behave
Expand Down Expand Up @@ -5083,6 +5084,7 @@ contain multi-byte characters.
[`stream.cork()`]: #writablecork
[`stream.duplexPair()`]: #streamduplexpairoptions
[`stream.finished()`]: #streamfinishedstream-options-callback
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
[`stream.pipe()`]: #readablepipedestination-options
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
[`stream.uncork()`]: #writableuncork
Expand Down
Loading