Update `ses.resolveProxy` return type
authorJoão Moreno <mail@joaomoreno.com>
Tue, 7 Mar 2017 10:21:51 +0000 (11:21 +0100)
committerGitHub <noreply@github.com>
Tue, 7 Mar 2017 10:21:51 +0000 (11:21 +0100)
As far as I'm aware, after using the `ses.resolveProxy` API, it seems to return a string in the shape of `PROXY foopy:80;SOCKS5 bar.com:1080`, not an object. Correct me if I'm wrong.

docs/api/session.md

index 029b187..591ac14 100644 (file)
@@ -204,7 +204,7 @@ The `proxyBypassRules` is a comma separated list of rules described below:
 
 * `url` URL
 * `callback` Function
-  * `proxy` Object
+  * `proxy` string
 
 Resolves the proxy information for `url`. The `callback` will be called with
 `callback(proxy)` when the request is performed.