Skip to content

Commit cbaae7a

Browse files
committed
doc: clarify http2.connect authority details
Fixes: #31827 PR-URL: #31828 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Yongsheng Zhang <[email protected]> Signed-off-by: James M Snell <[email protected]>
1 parent b44c63b commit cbaae7a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/http2.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2206,7 +2206,11 @@ changes:
22062206
128 header pairs.
22072207
-->
22082208

2209-
* `authority` {string|URL}
2209+
* `authority` {string|URL} The remote HTTP/2 server to connect to. This must
2210+
be in the form of a minimal, valid URL with the `http://` or `https://`
2211+
prefix, host name, and IP port (if a non-default port is used). Userinfo
2212+
(user ID and password), path, querystring, and fragment details in the
2213+
URL will be ignored.
22102214
* `options` {Object}
22112215
* `maxDeflateDynamicTableSize` {number} Sets the maximum dynamic table size
22122216
for deflating header fields. **Default:** `4Kib`.

0 commit comments

Comments
 (0)