Commit 830d160
doc: clarify QUIC stream state wording
When the body option is omitted, no FIN is sent immediately and the
stream's outgoing side remains writable. The stream can still be
written later via stream.setBody() or the writer.
Avoid describing the outgoing stream itself as half-closed, since the
outgoing side is one half of the stream state.
Fixes: #63655
Signed-off-by: EduardF1 <50618110+EduardF1@users.noreply.github.com>
PR-URL: #63660
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 9e17171 commit 830d160
1 file changed
Lines changed: 8 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1260,8 +1260,8 @@ added: v23.8.0 | |||
| 1260 | 1260 | * `body` {string | ArrayBuffer | SharedArrayBuffer | ArrayBufferView | | |
| 1261 | 1261 | Blob | FileHandle | AsyncIterable | Iterable | Promise | null} | |
| 1262 | 1262 | The outbound body source. See [`stream.setBody()`][] for details on | |
| 1263 | - supported types. When omitted, the stream starts half-closed (writable | ||
| 1264 | - side open, no body queued). | ||
| 1263 | + supported types. When omitted, the stream's outgoing side remains | ||
| 1264 | + writable with no body queued; no FIN is sent immediately. | ||
| 1265 | 1265 | * `headers` {Object} Initial request or response headers to send. Only | |
| 1266 | 1266 | used when the session supports headers (e.g. HTTP/3). If `body` is not | |
| 1267 | 1267 | specified and `headers` is provided, the stream is treated as | |
@@ -1288,7 +1288,8 @@ added: v23.8.0 | |||
| 1288 | 1288 | * Returns: {Promise} for a {quic.QuicStream} | |
| 1289 | 1289 | ||
| 1290 | 1290 | Open a new bidirectional stream. If the `body` option is not specified, | |
| 1291 | - the outgoing stream will be half-closed. The `priority` and `incremental` | ||
| 1291 | + the stream's outgoing side remains writable and no FIN is sent | ||
| 1292 | + immediately. The `priority` and `incremental` | ||
| 1292 | 1293 | options are only used when the session supports priority (e.g. HTTP/3). | |
| 1293 | 1294 | The `headers`, `onheaders`, `ontrailers`, `oninfo`, and `onwanttrailers` | |
| 1294 | 1295 | options are only used when the session supports headers (e.g. HTTP/3). | |
@@ -1303,7 +1304,8 @@ added: v23.8.0 | |||
| 1303 | 1304 | * `body` {string | ArrayBuffer | SharedArrayBuffer | ArrayBufferView | | |
| 1304 | 1305 | Blob | FileHandle | AsyncIterable | Iterable | Promise | null} | |
| 1305 | 1306 | The outbound body source. See [`stream.setBody()`][] for details on | |
| 1306 | - supported types. When omitted, the stream is closed immediately. | ||
| 1307 | + supported types. When omitted, the stream's outgoing side remains | ||
| 1308 | + writable with no body queued; no FIN is sent immediately. | ||
| 1307 | 1309 | * `headers` {Object} Initial request headers to send. | |
| 1308 | 1310 | * `priority` {string} The priority level of the stream. One of `'high'`, | |
| 1309 | 1311 | `'default'`, or `'low'`. **Default:** `'default'`. | |
@@ -1325,7 +1327,8 @@ added: v23.8.0 | |||
| 1325 | 1327 | * Returns: {Promise} for a {quic.QuicStream} | |
| 1326 | 1328 | ||
| 1327 | 1329 | Open a new unidirectional stream. If the `body` option is not specified, | |
| 1328 | - the outgoing stream will be closed. The `priority` and `incremental` | ||
| 1330 | + the stream's outgoing side remains writable and no FIN is sent | ||
| 1331 | + immediately. The `priority` and `incremental` | ||
| 1329 | 1332 | options are only used when the session supports priority (e.g. HTTP/3). | |
| 1330 | 1333 | ||
| 1331 | 1334 | ### `session.path` | |
0 commit comments