feat(readme): extend readme with a retry section

EME-6117 Co-authored-by: Benjamin Gehl <[email protected]> Co-authored-by: Zoltan Kiss <[email protected]>
emartech · Apr 11, 2023 · a125002 · a125002
1 parent 49b3a0d
commit a125002
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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