Skip to content

doc: clarify QUIC stream state wording #63660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EduardF1 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −5
Open

doc: clarify QUIC stream state wording #63660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions doc/api/quic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1253,8 +1253,8 @@ added: v23.8.0
* `body` {string | ArrayBuffer | SharedArrayBuffer | ArrayBufferView |
Blob | FileHandle | AsyncIterable | Iterable | Promise | null}
The outbound body source. See [`stream.setBody()`][] for details on
supported types. When omitted, the stream starts half-closed (writable
side open, no body queued).
supported types. When omitted, the stream starts half-open (writable
side open, no body queued; no FIN is sent immediately).
* `headers` {Object} Initial request or response headers to send. Only
used when the session supports headers (e.g. HTTP/3). If `body` is not
specified and `headers` is provided, the stream is treated as
Expand All @@ -1281,7 +1281,8 @@ added: v23.8.0
* Returns: {Promise} for a {quic.QuicStream}

Open a new bidirectional stream. If the `body` option is not specified,
the outgoing stream will be half-closed. The `priority` and `incremental`
the outgoing stream will be half-open (writable side open, no FIN sent).
The `priority` and `incremental`
options are only used when the session supports priority (e.g. HTTP/3).
The `headers`, `onheaders`, `ontrailers`, `oninfo`, and `onwanttrailers`
options are only used when the session supports headers (e.g. HTTP/3).
Expand All @@ -1296,7 +1297,8 @@ added: v23.8.0
* `body` {string | ArrayBuffer | SharedArrayBuffer | ArrayBufferView |
Blob | FileHandle | AsyncIterable | Iterable | Promise | null}
The outbound body source. See [`stream.setBody()`][] for details on
supported types. When omitted, the stream is closed immediately.
supported types. When omitted, the stream starts half-open (writable
side open, no body queued; no FIN is sent immediately).
* `headers` {Object} Initial request headers to send.
* `priority` {string} The priority level of the stream. One of `'high'`,
`'default'`, or `'low'`. **Default:** `'default'`.
Expand All @@ -1318,7 +1320,8 @@ added: v23.8.0
* Returns: {Promise} for a {quic.QuicStream}

Open a new unidirectional stream. If the `body` option is not specified,
the outgoing stream will be closed. The `priority` and `incremental`
the outgoing stream will be half-open (writable side open, no FIN sent).
The `priority` and `incremental`
options are only used when the session supports priority (e.g. HTTP/3).

### `session.path`
Expand Down