Commit 3b8a0ba

Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark. The fixed 16 KiB value became stale when that default changed. Also document the Windows-specific byte-stream default. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64617 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
- version: v22.0.0
327+
pr-url: https://github.com/nodejs/node/pull/52037
328+
description: bump default highWaterMark.
326329
- version:
327330
- v21.0.0
328331
- v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
* `autoClose` {boolean} **Default:** `true`
336339
* `emitClose` {boolean} **Default:** `true`
337340
* `start` {integer}
338-
* `highWaterMark` {number} **Default:** `16384`
341+
* `highWaterMark` {number} **Default:** See
342+
[`stream.getDefaultHighWaterMark()`][].
339343
* `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
- version: v22.0.0
3063+
pr-url: https://github.com/nodejs/node/pull/52037
3064+
description: bump default highWaterMark.
30583065
- version:
30593066
- v21.0.0
30603067
- v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
* `start` {integer}
31133120
* `fs` {Object|null} **Default:** `null`
31143121
* `signal` {AbortSignal|null} **Default:** `null`
3115-
* `highWaterMark` {number} **Default:** `16384`
3122+
* `highWaterMark` {number} **Default:** See
3123+
[`stream.getDefaultHighWaterMark()`][].
31163124
* `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms

‎doc/api/stream.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
- v19.9.0
36453645
- v18.17.0
3646+
changes:
3647+
- version: v22.0.0
3648+
pr-url: https://github.com/nodejs/node/pull/52037
3649+
description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
* `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
in the internal buffer before ceasing to read from the underlying resource.
4156-
**Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
**Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
* `encoding` {string} If specified, then buffers will be decoded to
41584163
strings using the specified encoding. **Default:** `null`.
41594164
* `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Commit 3b8a0ba
Browse files
umuoy1aduh95
umuoy1
authored and
aduh95
committed
doc: correct default highWaterMark values
File write streams inherit the default byte-stream highWaterMark.
The fixed 16 KiB value became stale when that default changed.
Also document the Windows-specific byte-stream default.
Signed-off-by: umuoy1 <burningdian@gmail.com>
PR-URL: #64617
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent b6fa9c1 commit 3b8a0ba
2 files changed
Lines changed: 21 additions & 6 deletions
File tree
‎doc/api/fs.md‎
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });
323323
<!-- YAML
324324
added: v16.11.0
325325
changes:
326+
 - version: v22.0.0
327+
 pr-url: https://github.com/nodejs/node/pull/52037
328+
 description: bump default highWaterMark.
326329
 - version:
327330
 - v21.0.0
328331
 - v20.10.0
@@ -335,7 +338,8 @@ changes:
335338
 * `autoClose` {boolean} **Default:** `true`
336339
 * `emitClose` {boolean} **Default:** `true`
337340
 * `start` {integer}
338-
 * `highWaterMark` {number} **Default:** `16384`
341+
 * `highWaterMark` {number} **Default:** See
342+
 [`stream.getDefaultHighWaterMark()`][].
339343
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
340344
 prior to closing it. **Default:** `false`.
341345
* Returns: {fs.WriteStream}
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
30553059
<!-- YAML
30563060
added: v0.1.31
30573061
changes:
3062+
 - version: v22.0.0
3063+
 pr-url: https://github.com/nodejs/node/pull/52037
3064+
 description: bump default highWaterMark.
30583065
 - version:
30593066
 - v21.0.0
30603067
 - v20.10.0
@@ -3112,7 +3119,8 @@ changes:
31123119
 * `start` {integer}
31133120
 * `fs` {Object|null} **Default:** `null`
31143121
 * `signal` {AbortSignal|null} **Default:** `null`
3115-
 * `highWaterMark` {number} **Default:** `16384`
3122+
 * `highWaterMark` {number} **Default:** See
3123+
 [`stream.getDefaultHighWaterMark()`][].
31163124
 * `flush` {boolean} If `true`, the underlying file descriptor is flushed
31173125
 prior to closing it. **Default:** `false`.
31183126
* Returns: {fs.WriteStream}
@@ -9334,6 +9342,7 @@ the file contents.
93349342
[`minimatch`]: https://github.com/isaacs/minimatch
93359343
[`node:stream/iter`]: stream_iter.md
93369344
[`statfs.bsize`]: #statfsbsize
9345+
[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
93379346
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93389347
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93399348
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
‎doc/api/stream.md‎
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {
36433643
added:
36443644
 - v19.9.0
36453645
 - v18.17.0
3646+
changes:
3647+
 - version: v22.0.0
3648+
 pr-url: https://github.com/nodejs/node/pull/52037
3649+
 description: bump default highWaterMark.
36463650
-->
36473651

36483652
*`objectMode` {boolean}
36493653
* Returns: {integer}
36503654

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

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

@@ -3779,7 +3784,7 @@ changes:
37793784
*`options` {Object}
37803785
*`highWaterMark` {number} Buffer level when
37813786
[`stream.write()`][stream-write] starts returning `false`. **Default:**
3782-
`65536` (64 KiB), or `16` for `objectMode` streams.
3787+
See [`stream.getDefaultHighWaterMark()`][].
37833788
*`decodeStrings` {boolean} Whether to encode `string`s passed to
37843789
[`stream.write()`][stream-write] to `Buffer`s (with the encoding
37853790
 specified in the [`stream.write()`][stream-write] call) before passing
@@ -4153,7 +4158,7 @@ changes:
41534158
* `options` {Object}
41544159
 * `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
41554160
 in the internal buffer before ceasing to read from the underlying resource.
4156-
 **Default:** `65536` (64 KiB), or `16` for `objectMode` streams.
4161+
 **Default:** See [`stream.getDefaultHighWaterMark()`][].
41574162
 * `encoding` {string} If specified, then buffers will be decoded to
41584163
 strings using the specified encoding. **Default:** `null`.
41594164
 * `objectMode` {boolean} Whether this stream should behave
@@ -5094,6 +5099,7 @@ contain multi-byte characters.
50945099
[`stream.cork()`]: #writablecork
50955100
[`stream.duplexPair()`]: #streamduplexpairoptions
50965101
[`stream.finished()`]: #streamfinishedstream-options-callback
5102+
[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
50975103
[`stream.pipe()`]: #readablepipedestination-options
50985104
[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
50995105
[`stream.uncork()`]: #writableuncork
0 commit comments
Comments
 (0)