Commit 8516602
doc: clarify http2.connect authority details
Fixes: #31827
PR-URL: #31828
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Signed-off-by: James M Snell <jasnell@gmail.com>1 parent f62967c commit 8516602
1 file changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2206,7 +2206,11 @@ changes: | |||
| 2206 | 2206 | 128 header pairs. | |
| 2207 | 2207 | --> | |
| 2208 | 2208 | ||
| 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. | ||
| 2210 | 2214 | * `options` {Object} | |
| 2211 | 2215 | * `maxDeflateDynamicTableSize` {number} Sets the maximum dynamic table size | |
| 2212 | 2216 | for deflating header fields. **Default:** `4Kib`. | |
0 commit comments