Skip to content

Commit 8f2fdd1

Browse files
committed
quic: update docs
Signed-off-by: Efe Karasakal <hi@efe.dev>
1 parent e54ff55 commit 8f2fdd1

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

‎doc/api/quic.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -987,7 +987,8 @@ added: v23.8.0
987987
is application-specific. **Default:** `'transport'`.
988988
* `reason` {string} An optional human-readable reason string included in
989989
the `CONNECTION_CLOSE` frame. Per RFC 9000, this is for diagnostic purposes
990-
only and should not be used for machine-readable error descriptions.
990+
only and should not be used for machine-readable error descriptions. If its
991+
UTF-8 encoding exceeds 256 bytes, it is truncated to at most 256 bytes.
991992
* Returns: {Promise}
992993

993994
Initiate a graceful close of the session. Existing streams will be allowed
@@ -1066,7 +1067,9 @@ added: v23.8.0
10661067
* `type` {string} Either `'transport'` or `'application'`. **Default:**
10671068
`'transport'`.
10681069
* `reason` {string} An optional human-readable reason string included in
1069-
the `CONNECTION_CLOSE` frame.
1070+
the `CONNECTION_CLOSE` frame. Per RFC 9000, this is for diagnostic purposes
1071+
only and should not be used for machine-readable error descriptions. If its
1072+
UTF-8 encoding exceeds 256 bytes, it is truncated to at most 256 bytes.
10701073

10711074
Immediately destroy the session. All streams will be destroyed and the
10721075
session will be closed. If `error` is provided and [`session.onerror`][] is

0 commit comments

Comments
 (0)