Skip to content

Commit 6fb74a9

Browse files
Flarnadanielleadams
authored andcommitted
doc, http: add Uint8Array as allowed type
OutgoingMessage.write()/end() and their derived classes support also Uint8Array besides string and Buffer. PR-URL: #45167 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 70244d0 commit 6fb74a9

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

doc/api/http.md

+26-6
Original file line numberDiff line numberDiff line change
@@ -748,12 +748,15 @@ See [`writable.cork()`][].
748748
<!-- YAML
749749
added: v0.1.90
750750
changes:
751+
- version: v15.0.0
752+
pr-url: https://github.com/nodejs/node/pull/33155
753+
description: The `data` parameter can now be a `Uint8Array`.
751754
- version: v10.0.0
752755
pr-url: https://github.com/nodejs/node/pull/18780
753756
description: This method now returns a reference to `ClientRequest`.
754757
-->
755758

756-
* `data` {string|Buffer}
759+
* `data` {string|Buffer|Uint8Array}
757760
* `encoding` {string}
758761
* `callback` {Function}
759762
* Returns: {this}
@@ -1203,9 +1206,13 @@ before the [`'finish'`][] event is emitted.
12031206

12041207
<!-- YAML
12051208
added: v0.1.29
1209+
changes:
1210+
- version: v15.0.0
1211+
pr-url: https://github.com/nodejs/node/pull/33155
1212+
description: The `chunk` parameter can now be a `Uint8Array`.
12061213
-->
12071214

1208-
* `chunk` {string|Buffer}
1215+
* `chunk` {string|Buffer|Uint8Array}
12091216
* `encoding` {string}
12101217
* `callback` {Function}
12111218
* Returns: {boolean}
@@ -1727,12 +1734,15 @@ See [`writable.cork()`][].
17271734
<!-- YAML
17281735
added: v0.1.90
17291736
changes:
1737+
- version: v15.0.0
1738+
pr-url: https://github.com/nodejs/node/pull/33155
1739+
description: The `data` parameter can now be a `Uint8Array`.
17301740
- version: v10.0.0
17311741
pr-url: https://github.com/nodejs/node/pull/18780
17321742
description: This method now returns a reference to `ServerResponse`.
17331743
-->
17341744

1735-
* `data` {string|Buffer}
1745+
* `data` {string|Buffer|Uint8Array}
17361746
* `encoding` {string}
17371747
* `callback` {Function}
17381748
* Returns: {this}
@@ -2081,9 +2091,13 @@ before the [`'finish'`][] event is emitted.
20812091

20822092
<!-- YAML
20832093
added: v0.1.29
2094+
changes:
2095+
- version: v15.0.0
2096+
pr-url: https://github.com/nodejs/node/pull/33155
2097+
description: The `chunk` parameter can now be a `Uint8Array`.
20842098
-->
20852099

2086-
* `chunk` {string|Buffer}
2100+
* `chunk` {string|Buffer|Uint8Array}
20872101
* `encoding` {string} **Default:** `'utf8'`
20882102
* `callback` {Function}
20892103
* Returns: {boolean}
@@ -2765,11 +2779,14 @@ and is connected, that socket will be destroyed as well.
27652779
<!-- YAML
27662780
added: v0.1.90
27672781
changes:
2782+
- version: v15.0.0
2783+
pr-url: https://github.com/nodejs/node/pull/33155
2784+
description: The `chunk` parameter can now be a `Uint8Array`.
27682785
- version: v0.11.6
27692786
description: add `callback` argument.
27702787
-->
27712788

2772-
* `chunk` {string | Buffer}
2789+
* `chunk` {string|Buffer|Uint8Array}
27732790
* `encoding` {string} Optional, **Default**: `utf8`
27742791
* `callback` {Function} Optional
27752792
* Returns: {this}
@@ -3025,11 +3042,14 @@ Always `false`.
30253042
<!-- YAML
30263043
added: v0.1.29
30273044
changes:
3045+
- version: v15.0.0
3046+
pr-url: https://github.com/nodejs/node/pull/33155
3047+
description: The `chunk` parameter can now be a `Uint8Array`.
30283048
- version: v0.11.6
30293049
description: The `callback` argument was added.
30303050
-->
30313051

3032-
* `chunk` {string | Buffer}
3052+
* `chunk` {string|Buffer|Uint8Array}
30333053
* `encoding` {string} **Default**: `utf8`
30343054
* `callback` {Function}
30353055
* Returns {boolean}

0 commit comments

Comments
 (0)