Skip to content

Commit f9ee370

Browse files
committed
add to proxy option description in README
1 parent f9a1bca commit f9ee370

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -244,10 +244,24 @@ waitOn(opts, [cb]) - function which triggers resource checks
244244
- opts.cert: [ /* strings or binaries */ ],
245245
- opts.key: [ /* strings or binaries */ ],
246246
- opts.passphrase: 'yourpassphrase',
247-
- opts.auth: { user, pass }
248-
- opts.strictSSL: false,
249-
- opts.followRedirect: false, // defaults to true
250-
- opts.headers: { 'x-custom': 'headers' },
247+
- opts.proxy: undefined, false, or object as defined in axios. Default is undefined. If not set axios detects proxy from env vars http_proxy and https_proxy. https://github.com/axios/axios#config-defaults
248+
249+
```js
250+
// example proxy object
251+
{
252+
host: '127.0.0.1',
253+
port: 9000,
254+
auth: {
255+
username: 'mikeymike',
256+
password: 'rapunz3l'
257+
}
258+
}
259+
```
260+
261+
- opts.auth: { user, pass }
262+
- opts.strictSSL: false,
263+
- opts.followRedirect: false, // defaults to true
264+
- opts.headers: { 'x-custom': 'headers' },
251265

252266
- cb(err) - if err is provided then, resource checks did not succeed
253267

0 commit comments

Comments
 (0)