Skip to content

Commit 71059ca

Browse files
committed
fix(readme): Document correct timeout default: 1000ms
This value was changed in #30 but the readme was not updated.
1 parent 79e103c commit 71059ca

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The [ServiceConfiguration](https://github.com/pelias/microservice-wrapper/blob/m
3737
| property | required | default | description |
3838
| --- | --- | --- | --- |
3939
| `baseUrl` | no | none | the base URL used for contacting a service, causes `isEnabled()` to return `false` when an empty string |
40-
| `timeout` | no | `250` | the number of milliseconds a request should wait for a server response before timing out |
40+
| `timeout` | no | `1000` | the number of milliseconds a request should wait for a server response before timing out |
4141
| `retries` | no | `3` | the number of retries to attempt before returning an error |
4242

4343
Requests are logged at the `debug` level when enabled in [pelias-config](https://github.com/pelias/config).
@@ -99,7 +99,7 @@ demoService.getHeaders(req) === {
9999
| `getUrl` | yes | value of `getBaseUrl` unless overridden | used for appending other value to the baseUrl (but not request parameters) |
100100
| `getParameters` | yes| `{}` unless overridden | any request parameters to pass to the microservice |
101101
| `getHeaders` | yes | `{}` unless overridden | any request headers to pass to the microservice |
102-
| `getTimeout` | not recommended | `250` or value passed to constructor | how long a request should wait for a server response before timing out |
102+
| `getTimeout` | not recommended | `1000` or value passed to constructor | how long a request should wait for a server response before timing out |
103103
| `getRetries` | not recommended | `3` or value passed to constructor | how many attempts should be made before returning an error |
104104

105105
#### Recommended `ServiceConfiguration` Method Overrides

0 commit comments

Comments
 (0)