Skip to content

Commit

Permalink
feat(readme): extend readme with a retry section
Browse files Browse the repository at this point in the history
EME-6117

Co-authored-by: Benjamin Gehl <gehl.benjamin@gmail.com>
Co-authored-by: Zoltan Kiss <zoli9668@gmail.com>
  • Loading branch information
3 people committed Apr 11, 2023
1 parent 49b3a0d commit a125002
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,16 @@ const heroes = await request.post<{ name: string; }[]>('/heroes', {
});
console.log(heroes);
```

### Retry

You can specify an optional retry config in the constructor of the EscherRequestOption's second parameter:
```typescript
const options = new EscherRequestOption('example.host.com', {
credentialScope: 'eu/service/ems_request',
retryConfig: {
retries: 5
}
});
```
The type of the `retryConfig` property is `IAxiosRetryConfig`, you can find the detailed list of available parameters here: https://github.com/softonic/axios-retry#options

0 comments on commit a125002

Please sign in to comment.