GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: correct default highWaterMark values · nodejs/node@3b8a0ba

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- fs.md
- stream.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/fs.md‎`

Copy file name to clipboardExpand all lines: doc/api/fs.md

+11-2Lines changed: 11 additions & 2 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -323,6 +323,9 @@ fd.createReadStream({ start: 90, end: 99 });`
`323`	`323`	`<!-- YAML`
`324`	`324`	`added: v16.11.0`
`325`	`325`	`changes:`
	`326`	`+ - version: v22.0.0`
	`327`	`+ pr-url: https://github.com/nodejs/node/pull/52037`
	`328`	`+ description: bump default highWaterMark.`
`326`	`329`	`- version:`
`327`	`330`	`- v21.0.0`
`328`	`331`	`- v20.10.0`
`@@ -335,7 +338,8 @@ changes:`
`335`	`338`	* `autoClose` {boolean} Default: `true`
`336`	`339`	* `emitClose` {boolean} Default: `true`
`337`	`340`	* `start` {integer}
`338`		- * `highWaterMark` {number} Default: `16384`
	`341`	+ * `highWaterMark` {number} Default: See
	`342`	+ [`stream.getDefaultHighWaterMark()`][].
`339`	`343`	* `flush` {boolean} If `true`, the underlying file descriptor is flushed
`340`	`344`	prior to closing it. Default: `false`.
`341`	`345`	`* Returns: {fs.WriteStream}`
@@ -3055,6 +3059,9 @@ If `options` is a string, then it specifies the encoding.
`3055`	`3059`	`<!-- YAML`
`3056`	`3060`	`added: v0.1.31`
`3057`	`3061`	`changes:`
	`3062`	`+ - version: v22.0.0`
	`3063`	`+ pr-url: https://github.com/nodejs/node/pull/52037`
	`3064`	`+ description: bump default highWaterMark.`
`3058`	`3065`	`- version:`
`3059`	`3066`	`- v21.0.0`
`3060`	`3067`	`- v20.10.0`
`@@ -3112,7 +3119,8 @@ changes:`
`3112`	`3119`	* `start` {integer}
`3113`	`3120`	* `fs` {Object\|null} Default: `null`
`3114`	`3121`	* `signal` {AbortSignal\|null} Default: `null`
`3115`		- * `highWaterMark` {number} Default: `16384`
	`3122`	+ * `highWaterMark` {number} Default: See
	`3123`	+ [`stream.getDefaultHighWaterMark()`][].
`3116`	`3124`	* `flush` {boolean} If `true`, the underlying file descriptor is flushed
`3117`	`3125`	prior to closing it. Default: `false`.
`3118`	`3126`	`* Returns: {fs.WriteStream}`
`@@ -9334,6 +9342,7 @@ the file contents.`
`9334`	`9342`	[`minimatch`]: https://github.com/isaacs/minimatch
`9335`	`9343`	[`node:stream/iter`]: stream_iter.md
`9336`	`9344`	[`statfs.bsize`]: #statfsbsize
	`9345`	+[`stream.getDefaultHighWaterMark()`]: stream.md#streamgetdefaulthighwatermarkobjectmode
`9337`	`9346`	[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
`9338`	`9347`	[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
`9339`	`9348`	[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms

Collapse file

`‎doc/api/stream.md‎`

Copy file name to clipboardExpand all lines: doc/api/stream.md

+10-4Lines changed: 10 additions & 4 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -3643,13 +3643,18 @@ reader.read().then(({ value, done }) => {`
`3643`	`3643`	`added:`
`3644`	`3644`	`- v19.9.0`
`3645`	`3645`	`- 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.`
`3646`	`3650`	`-->`
`3647`	`3651`
`3648`	`3652`	* `objectMode` {boolean}
`3649`	`3653`	`* Returns: {integer}`
`3650`	`3654`
`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.
`3653`	`3658`
`3654`	`3659`	### `stream.setDefaultHighWaterMark(objectMode, value)`
`3655`	`3660`
`@@ -3779,7 +3784,7 @@ changes:`
`3779`	`3784`	* `options` {Object}
`3780`	`3785`	* `highWaterMark` {number} Buffer level when
`3781`	`3786`	[`stream.write()`][stream-write] starts returning `false`. Default:
`3782`		- `65536` (64 KiB), or `16` for `objectMode` streams.
	`3787`	+ See [`stream.getDefaultHighWaterMark()`][].
`3783`	`3788`	* `decodeStrings` {boolean} Whether to encode `string`s passed to
`3784`	`3789`	[`stream.write()`][stream-write] to `Buffer`s (with the encoding
`3785`	`3790`	specified in the [`stream.write()`][stream-write] call) before passing
`@@ -4153,7 +4158,7 @@ changes:`
`4153`	`4158`	* `options` {Object}
`4154`	`4159`	* `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
`4155`	`4160`	`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()`][].
`4157`	`4162`	* `encoding` {string} If specified, then buffers will be decoded to
`4158`	`4163`	strings using the specified encoding. Default: `null`.
`4159`	`4164`	* `objectMode` {boolean} Whether this stream should behave
`@@ -5094,6 +5099,7 @@ contain multi-byte characters.`
`5094`	`5099`	[`stream.cork()`]: #writablecork
`5095`	`5100`	[`stream.duplexPair()`]: #streamduplexpairoptions
`5096`	`5101`	[`stream.finished()`]: #streamfinishedstream-options-callback
	`5102`	+[`stream.getDefaultHighWaterMark()`]: #streamgetdefaulthighwatermarkobjectmode
`5097`	`5103`	[`stream.pipe()`]: #readablepipedestination-options
`5098`	`5104`	[`stream.pipeline()`]: #streampipelinesource-transforms-destination-callback
`5099`	`5105`	[`stream.uncork()`]: #writableuncork

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.