doc: mark some parameters as optional in webstreams

Some parameters are described as optional in spec, so update mismatched parameter. Refs: https://streams.spec.whatwg.org/ PR-URL: #46269 Refs: https://streams.spec.whatwg.org/ Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
nodejs · Jan 21, 2023 · 05296d9 · 05296d9
1 parent c9ea952
commit 05296d9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md
@@ -629,7 +629,7 @@ added: v16.5.0
 Returns the amount of data remaining to fill the {ReadableStream}'s
 queue.
 
-#### `readableStreamDefaultController.enqueue(chunk)`
+#### `readableStreamDefaultController.enqueue([chunk])`
 
 <!-- YAML
 added: v16.5.0
@@ -639,7 +639,7 @@ added: v16.5.0
 
 Appends a new chunk of data to the {ReadableStream}'s queue.
 
-#### `readableStreamDefaultController.error(error)`
+#### `readableStreamDefaultController.error([error])`
 
 <!-- YAML
 added: v16.5.0
@@ -700,7 +700,7 @@ added: v16.5.0
 
 Appends a new chunk of data to the {ReadableStream}'s queue.
 
-#### `readableByteStreamController.error(error)`
+#### `readableByteStreamController.error([error])`
 
 <!-- YAML
 added: v16.5.0
@@ -984,7 +984,7 @@ changes:
 The `WritableStreamDefaultController` manage's the {WritableStream}'s
 internal state.
 
-#### `writableStreamDefaultController.error(error)`
+#### `writableStreamDefaultController.error([error])`
 
 <!-- YAML
 added: v16.5.0

diff --git a/lib/internal/webstreams/readablestream.js b/lib/internal/webstreams/readablestream.js
@@ -861,7 +861,7 @@ class ReadableStreamDefaultReader {
   }
 
   /**
-   * @param {any} reason
+   * @param {any} [reason]
    * @returns {Promise<void>}
    */
   cancel(reason = undefined) {
@@ -977,7 +977,7 @@ class ReadableStreamBYOBReader {
   }
 
   /**
-   * @param {any} reason
+   * @param {any} [reason]
    * @returns {Promise<void>}
    */
   cancel(reason = undefined) {
@@ -1029,7 +1029,7 @@ class ReadableStreamDefaultController {
   }
 
   /**
-   * @param {any} chunk
+   * @param {any} [chunk]
    */
   enqueue(chunk = undefined) {
     if (!readableStreamDefaultControllerCanCloseOrEnqueue(this))
@@ -1038,7 +1038,7 @@ class ReadableStreamDefaultController {
   }
 
   /**
-   * @param {any} error
+   * @param {any} [error]
    */
   error(error = undefined) {
     readableStreamDefaultControllerError(this, error);
@@ -1152,7 +1152,7 @@ class ReadableByteStreamController {
   }
 
   /**
-   * @param {any} error
+   * @param {any} [error]
    */
   error(error = undefined) {
     if (!isReadableByteStreamController(this))

diff --git a/lib/internal/webstreams/writablestream.js b/lib/internal/webstreams/writablestream.js
@@ -435,7 +435,7 @@ class WritableStreamDefaultWriter {
   }
 
   /**
-   * @param {any} reason
+   * @param {any} [reason]
    * @returns {Promise<void>}
    */
   abort(reason = undefined) {
@@ -545,7 +545,7 @@ class WritableStreamDefaultController {
   }
 
   /**
-   * @param {any} error
+   * @param {any} [error]
    */
   error(error = undefined) {
     if (!isWritableStreamDefaultController(this))