Skip to content

Commit

Permalink
add to proxy option description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffbski committed Jul 10, 2020
1 parent f9a1bca commit f9ee370
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,10 +244,24 @@ waitOn(opts, [cb]) - function which triggers resource checks
- opts.cert: [ /* strings or binaries */ ],
- opts.key: [ /* strings or binaries */ ],
- opts.passphrase: 'yourpassphrase',
- opts.auth: { user, pass }
- opts.strictSSL: false,
- opts.followRedirect: false, // defaults to true
- opts.headers: { 'x-custom': 'headers' },
- 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

```js
// example proxy object
{
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
}
```

- opts.auth: { user, pass }
- opts.strictSSL: false,
- opts.followRedirect: false, // defaults to true
- opts.headers: { 'x-custom': 'headers' },

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

Expand Down

0 comments on commit f9ee370

Please sign in to comment.