doc: add description of autoAllocateChunkSize in ReadableStream · nodejs/node@f18b287 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 632
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit f18b287

Browse filesBrowse the repository at this point in the historyBrowse files

debadree25

authored and

ruyadorno

committed

doc: add description of autoAllocateChunkSize in ReadableStream

Refs: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream PR-URL: #48004 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

1 parent f2ce8e0 commit f18b287
Copy full SHA for f18b287

1 file changed

+4-1Lines changed: 4 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • webstreams.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/webstreams.md‎

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

+4-1Lines changed: 4 additions & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -124,7 +124,10 @@ added: v16.5.0
124	124	* Returns: A promise fulfilled with `undefined`.
125	125	* `type` {string} Must be `'bytes'` or `undefined`.
126	126	* `autoAllocateChunkSize` {number} Used only when `type` is equal to
127		- `'bytes'`.
	127	+ `'bytes'`. When set to a non-zero value a view buffer is automatically
	128	+ allocated to `ReadableByteStreamController.byobRequest`. When not set
	129	+ one must use stream's internal queues to transfer data via the default
	130	+ reader `ReadableStreamDefaultReader`.
128	131	* `strategy` {Object}
129	132	* `highWaterMark` {number} The maximum internal queue size before backpressure
130	133	is applied.

0 commit comments

Comments

0 (0)