Skip to content

Commit 8f27aee

Browse files
extend proxy definition
1 parent 7528e5c commit 8f27aee

File tree

1 file changed

+51
-9
lines changed

1 file changed

+51
-9
lines changed

index.html

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1620,10 +1620,10 @@ <h3>Proxy</h3>
16201620

16211621
<tr>
16221622
<td><code>httpProxy</code>
1623-
<td>string
1623+
<td>string or JSON <a>Object</a>
16241624
<td>Defines the proxy <a>host</a> for HTTP traffic when
16251625
the <a><code>proxyType</code></a> is "<code>manual</code>".
1626-
<td>A <a>host and optional port</a> for
1626+
<td>A <a>proxy specifier</a> for
16271627
scheme "<code>http</code>".
16281628
</tr>
16291629

@@ -1637,19 +1637,19 @@ <h3>Proxy</h3>
16371637

16381638
<tr>
16391639
<td><code>sslProxy</code>
1640-
<td>string
1640+
<td>string or JSON <a>Object</a>
16411641
<td>Defines the proxy <a>host</a> for encrypted TLS traffic
16421642
when the <a><code>proxyType</code></a> is "<code>manual</code>".
1643-
<td>A <a>host and optional port</a> for
1643+
<td>A <a>proxy specifier</a> for
16441644
scheme "<code>https</code>".
16451645
</tr>
16461646

16471647
<tr>
16481648
<td><code>socksProxy</code>
1649-
<td>string
1649+
<td>string or JSON <a>Object</a>
16501650
<td>Defines the proxy <a>host</a> for a <a>SOCKS proxy</a>
16511651
when the <a><code>proxyType</code></a> is "<code>manual</code>".
1652-
<td>A <a>host and optional port</a> with an <a>undefined</a> scheme.
1652+
<td>A <a>proxy specifier</a> with an <a>undefined</a> scheme.
16531653
</tr>
16541654

16551655
<tr>
@@ -1662,6 +1662,48 @@ <h3>Proxy</h3>
16621662

16631663
</table>
16641664

1665+
<p>A <dfn>proxy specifier</dfn> for a <var>scheme</var> is either a
1666+
<a>host and optional port</a> for a <var>scheme</var>, or a JSON
1667+
<a>Object</a> with the following properties:
1668+
1669+
<table class=simple>
1670+
<thead>
1671+
<tr>
1672+
<th>Key
1673+
<th>Value Type
1674+
<th>Description
1675+
<th>Valid values
1676+
</tr>
1677+
</thead>
1678+
1679+
<tr>
1680+
<td><code>protocol</code>
1681+
<td>string
1682+
<td>The protocol used to communicate with the proxy.
1683+
<td>"<code>http</code>",
1684+
"<code>ssl</code>",
1685+
"<code>socks4</code>",
1686+
"<code>socks5</code>".
1687+
</tr>
1688+
1689+
<tr>
1690+
<td><code>host</code>
1691+
<td>string
1692+
<td>The host used to connect to the proxy.
1693+
<td>Any <a>host</a> with optional
1694+
<a data-lt="includes credentials">credentials</a>.
1695+
</tr>
1696+
1697+
<tr>
1698+
<td><code>port</code>
1699+
<td>number
1700+
<td>The port used to connect to the proxy.
1701+
<td>Any valid <a>port</a>. If <code>protocol</code> is
1702+
"<code>socks4</code>" or "<code>socks5</code>", this field must be
1703+
omitted.
1704+
</tr>
1705+
</table>
1706+
16651707
<p>A <dfn>host and optional port</dfn> for a <var>scheme</var> is
16661708
defined as being a valid <a>host</a>, optionally followed by a colon
16671709
and a valid <a>port</a>. The <a>host</a> may
@@ -1721,9 +1763,9 @@ <h3>Proxy</h3>
17211763
an <a>error</a> with <a>error code</a> <a>invalid argument</a>.
17221764

17231765
<li><p>If <var>proxy</var> has an <a>own property</a> for
1724-
"<code>socksProxy</code>" and does not have an <a>own property</a>
1725-
for "<code>socksVersion</code>" return an <a>error</a> with <a>error
1726-
code</a> <a>invalid argument</a>.
1766+
"<code>socksProxy</code>" which is a string, and does not have an
1767+
<a>own property</a> for "<code>socksVersion</code>" return an
1768+
<a>error</a> with <a>error code</a> <a>invalid argument</a>.
17271769

17281770
<li><p>Return <a>success</a> with data <var>proxy</var>.
17291771
</ol>

0 commit comments

Comments
 (0)