This class provides methods to implement fetch with retries. The retries use exponential backoff strategy with defaults set to max of 3 retries and initial Delay as 100ms
This provides a wrapper for fetch that facilitates proxy auth authorization.
functionReturn the appropriate Fetch function depending on proxy settings.
numberParse the Retry-After header Spec: https://tools.ietf.org/html/rfc7231#section-7.1.3
objectFetch Retry Options
objectProxy Auth Options
Promise.<Response>
### new HttpExponentialBackoff([options])
Creates an instance of HttpExponentialBackoff
| Param | Type | Description |
| --- | --- | --- |
| [options] | object | configuration options |
| [options.logLevel] | string | the log level to use (default: process.env.LOG_LEVEL or 'info') |
| [options.logRetryAfterSeconds] | number | the number of seconds after which to log a warning if the Retry-After header is greater than the number of seconds. Set to 0 to disable. |
### httpExponentialBackoff.exponentialBackoff(url, requestOptions, [retryOptions], [retryOn], [retryDelay]) ⇒ Promise.<Response>
This function will retry connecting to a url end-point, with
exponential backoff. Returns a Promise.
**Kind**: instance method of [HttpExponentialBackoff](#HttpExponentialBackoff)
**Returns**: Promise.<Response> - Promise object representing the http response
| Param | Type | Description |
| --- | --- | --- |
| url | string | endpoint url |
| requestOptions | object \| Request | request options |
| [retryOptions] | [RetryOptions](#RetryOptions) | (optional) retry options |
| [retryOn] | function \| Array | (optional) Function or Array. If provided, will be used instead of the default |
| [retryDelay] | function \| number | (optional) Function or number. If provided, will be used instead of the default |
## ProxyFetch
This provides a wrapper for fetch that facilitates proxy auth authorization.
**Kind**: global class
* [ProxyFetch](#ProxyFetch)
* [new ProxyFetch(proxyOptions)](#new_ProxyFetch_new)
* [.fetch(resource, options)](#ProxyFetch+fetch) ⇒ Promise.<Response>
### new ProxyFetch(proxyOptions)
Initialize this class with Proxy auth options
| Param | Type | Description |
| --- | --- | --- |
| proxyOptions | [ProxyOptions](#ProxyOptions) | the auth options to connect with |
### proxyFetch.fetch(resource, options) ⇒ Promise.<Response>
Fetch function, using the configured fetch options, and proxy options (set in the constructor).
**Kind**: instance method of [ProxyFetch](#ProxyFetch)
**Returns**: Promise.<Response> - Promise object representing the http response
| Param | Type | Description |
| --- | --- | --- |
| resource | string \| Request | the url or Request object to fetch from |
| options | object | the fetch options |
## createFetch([proxyOptions]) ⇒ function
Return the appropriate Fetch function depending on proxy settings.
**Kind**: global function
**Returns**: function - the Fetch API function
| Param | Type | Description |
| --- | --- | --- |
| [proxyOptions] | [ProxyOptions](#ProxyOptions) | the proxy options |
## parseRetryAfterHeader(header) ⇒ number
Parse the Retry-After header
Spec: [https://tools.ietf.org/html/rfc7231#section-7.1.3](https://tools.ietf.org/html/rfc7231#section-7.1.3)
**Kind**: global function
**Returns**: number - Number of milliseconds to sleep until the next call to getEventsFromJournal
| Param | Type | Description |
| --- | --- | --- |
| header | string | Retry-After header value |
## RetryOptions : object
Fetch Retry Options
**Kind**: global typedef
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| maxRetries | number | the maximum number of retries to try (default:3) |
| initialDelayInMillis | number | the initial delay in milliseconds (default:100ms) |
| proxy | [ProxyOptions](#ProxyOptions) | the (optional) proxy auth options |
## ProxyOptions : object
Proxy Auth Options
**Kind**: global typedef
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| proxyUrl | string | the proxy's url |
| [username] | string | the username for basic auth |
| [password] | string | the password for basic auth |
| rejectUnauthorized | boolean | set to false to not reject unauthorized server certs |
| [logLevel] | string | the log level to use (default: process.env.LOG_LEVEL or 'info') |
### Debug Logs
```bash
LOG_LEVEL=debug