Skip to content

Commit 9e99d4f

Browse files
author
Pooya Parsa
committed
docs: add retry docs
#77
1 parent 033f0da commit 9e99d4f

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ If you are coming from an older release please be sure to read [Migration Guide]
4040

4141
✓ Fetch Style requests
4242

43-
Automatically integrate with Nuxt.js progress bar
43+
Integrated with Nuxt.js Progressbar while making requests
4444

45-
✓ Easily integrate with [Proxy Module](https://github.com/nuxt-community/proxy-module)
45+
✓ Integrated with [Proxy Module](https://github.com/nuxt-community/proxy-module)
46+
47+
✓ Auto retry requests with [axios-retry](https://github.com/softonic/axios-retry)
4648

4749
# Table of Contents
4850

@@ -63,6 +65,7 @@ If you are coming from an older release please be sure to read [Migration Guide]
6365
* [browserBaseURL](#browserbaseurl)
6466
* [progress](#progress)
6567
* [proxy](#proxy)
68+
* [retry](#retry)
6669
* [credentials](#credentials)
6770
* [debug](#debug)
6871
* [proxyHeaders](#proxyheaders)
@@ -344,6 +347,20 @@ proxy: {
344347
}
345348
```
346349

350+
### `retry`
351+
352+
* Default: `false`
353+
354+
Automatically intercept failed requests and retries them whenever posible using [axios-retry](https://github.com/softonic/axios-retry).
355+
356+
By default, number of retries will be **3 times**, if `retry` value is set to `true`. You can change it by passing an object like this:
357+
358+
```js
359+
axios: {
360+
retry: { retries: 3 }
361+
}
362+
```
363+
347364
### `credentials`
348365

349366
* Default: `false`

0 commit comments

Comments
 (0)