Commit f39fb8c
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>1 parent 7a9af38 commit f39fb8c
3 files changed
Lines changed: 11 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -629,7 +629,7 @@ added: v16.5.0 | |||
| 629 | 629 | Returns the amount of data remaining to fill the {ReadableStream}'s | |
| 630 | 630 | queue. | |
| 631 | 631 | ||
| 632 | - #### `readableStreamDefaultController.enqueue(chunk)` | ||
| 632 | + #### `readableStreamDefaultController.enqueue([chunk])` | ||
| 633 | 633 | ||
| 634 | 634 | <!-- YAML | |
| 635 | 635 | added: v16.5.0 | |
@@ -639,7 +639,7 @@ added: v16.5.0 | |||
| 639 | 639 | ||
| 640 | 640 | Appends a new chunk of data to the {ReadableStream}'s queue. | |
| 641 | 641 | ||
| 642 | - #### `readableStreamDefaultController.error(error)` | ||
| 642 | + #### `readableStreamDefaultController.error([error])` | ||
| 643 | 643 | ||
| 644 | 644 | <!-- YAML | |
| 645 | 645 | added: v16.5.0 | |
@@ -700,7 +700,7 @@ added: v16.5.0 | |||
| 700 | 700 | ||
| 701 | 701 | Appends a new chunk of data to the {ReadableStream}'s queue. | |
| 702 | 702 | ||
| 703 | - #### `readableByteStreamController.error(error)` | ||
| 703 | + #### `readableByteStreamController.error([error])` | ||
| 704 | 704 | ||
| 705 | 705 | <!-- YAML | |
| 706 | 706 | added: v16.5.0 | |
@@ -984,7 +984,7 @@ changes: | |||
| 984 | 984 | The `WritableStreamDefaultController` manage's the {WritableStream}'s | |
| 985 | 985 | internal state. | |
| 986 | 986 | ||
| 987 | - #### `writableStreamDefaultController.error(error)` | ||
| 987 | + #### `writableStreamDefaultController.error([error])` | ||
| 988 | 988 | ||
| 989 | 989 | <!-- YAML | |
| 990 | 990 | added: v16.5.0 | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -861,7 +861,7 @@ class ReadableStreamDefaultReader { | |||
| 861 | 861 | } | |
| 862 | 862 | ||
| 863 | 863 | /** | |
| 864 | - * @param {any} reason | ||
| 864 | + * @param {any} [reason] | ||
| 865 | 865 | * @returns {Promise<void>} | |
| 866 | 866 | */ | |
| 867 | 867 | cancel(reason = undefined) { | |
@@ -977,7 +977,7 @@ class ReadableStreamBYOBReader { | |||
| 977 | 977 | } | |
| 978 | 978 | ||
| 979 | 979 | /** | |
| 980 | - * @param {any} reason | ||
| 980 | + * @param {any} [reason] | ||
| 981 | 981 | * @returns {Promise<void>} | |
| 982 | 982 | */ | |
| 983 | 983 | cancel(reason = undefined) { | |
@@ -1029,7 +1029,7 @@ class ReadableStreamDefaultController { | |||
| 1029 | 1029 | } | |
| 1030 | 1030 | ||
| 1031 | 1031 | /** | |
| 1032 | - * @param {any} chunk | ||
| 1032 | + * @param {any} [chunk] | ||
| 1033 | 1033 | */ | |
| 1034 | 1034 | enqueue(chunk = undefined) { | |
| 1035 | 1035 | if (!readableStreamDefaultControllerCanCloseOrEnqueue(this)) | |
@@ -1038,7 +1038,7 @@ class ReadableStreamDefaultController { | |||
| 1038 | 1038 | } | |
| 1039 | 1039 | ||
| 1040 | 1040 | /** | |
| 1041 | - * @param {any} error | ||
| 1041 | + * @param {any} [error] | ||
| 1042 | 1042 | */ | |
| 1043 | 1043 | error(error = undefined) { | |
| 1044 | 1044 | readableStreamDefaultControllerError(this, error); | |
@@ -1152,7 +1152,7 @@ class ReadableByteStreamController { | |||
| 1152 | 1152 | } | |
| 1153 | 1153 | ||
| 1154 | 1154 | /** | |
| 1155 | - * @param {any} error | ||
| 1155 | + * @param {any} [error] | ||
| 1156 | 1156 | */ | |
| 1157 | 1157 | error(error = undefined) { | |
| 1158 | 1158 | if (!isReadableByteStreamController(this)) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -435,7 +435,7 @@ class WritableStreamDefaultWriter { | |||
| 435 | 435 | } | |
| 436 | 436 | ||
| 437 | 437 | /** | |
| 438 | - * @param {any} reason | ||
| 438 | + * @param {any} [reason] | ||
| 439 | 439 | * @returns {Promise<void>} | |
| 440 | 440 | */ | |
| 441 | 441 | abort(reason = undefined) { | |
@@ -545,7 +545,7 @@ class WritableStreamDefaultController { | |||
| 545 | 545 | } | |
| 546 | 546 | ||
| 547 | 547 | /** | |
| 548 | - * @param {any} error | ||
| 548 | + * @param {any} [error] | ||
| 549 | 549 | */ | |
| 550 | 550 | error(error = undefined) { | |
| 551 | 551 | if (!isWritableStreamDefaultController(this)) | |
0 commit comments