diff --git a/README.md b/README.md index a3bc584..d7a1e8f 100644 --- a/README.md +++ b/README.md @@ -653,6 +653,13 @@ const w = wretch().middlewares([retry(), dedupe()]) **Retries a request multiple times in case of an error (or until a custom condition is true).** +> **💡 By default, the request will be retried if the response status is not in the 2xx range.** +> +> ```js +> // Replace the default condition with a custom one to avoid retrying on 4xx errors: +> until: (response, error) => response && (response.ok || (response.status >= 400 && response.status < 500)) +> ``` + ```js import wretch from 'wretch' import { retry } from 'wretch/middlewares' diff --git a/docs/api/assets/highlight.css b/docs/api/assets/highlight.css index 3080ec8..bbb603e 100644 --- a/docs/api/assets/highlight.css +++ b/docs/api/assets/highlight.css @@ -21,6 +21,8 @@ --dark-hl-9: #D4D4D4; --light-hl-10: #267F99; --dark-hl-10: #4EC9B0; + --light-hl-11: #000000; + --dark-hl-11: #C8C8C8; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -37,6 +39,7 @@ --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); --code-background: var(--light-code-background); } } @@ -52,6 +55,7 @@ --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); --code-background: var(--dark-code-background); } } @@ -67,6 +71,7 @@ --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); --code-background: var(--light-code-background); } @@ -82,6 +87,7 @@ --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); --code-background: var(--dark-code-background); } @@ -96,4 +102,5 @@ .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } .hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } pre, code { background: var(--code-background); } diff --git a/docs/api/functions/addons_abort.default.html b/docs/api/functions/addons_abort.default.html index 407c229..793224a 100644 --- a/docs/api/functions/addons_abort.default.html +++ b/docs/api/functions/addons_abort.default.html @@ -30,7 +30,7 @@

Function default

Returns WretchAddon<AbortWretch, AbortResolver>

+
  • Defined in src/addons/abort.ts:110
    • diff --git a/docs/api/functions/addons_perfs.default.html b/docs/api/functions/addons_perfs.default.html index 2795fbc..45dbe71 100644 --- a/docs/api/functions/addons_perfs.default.html +++ b/docs/api/functions/addons_perfs.default.html @@ -34,7 +34,7 @@

    Function default

    Returns WretchAddon<unknown, PerfsAddon>

    +
  • Defined in src/addons/perfs.ts:58
    • diff --git a/docs/api/functions/addons_progress.default.html b/docs/api/functions/addons_progress.default.html index b854e82..80d1133 100644 --- a/docs/api/functions/addons_progress.default.html +++ b/docs/api/functions/addons_progress.default.html @@ -27,7 +27,7 @@

    Function default

    Returns WretchAddon<unknown, ProgressResolver>

    +
  • Defined in src/addons/progress.ts:45
    • diff --git a/docs/api/functions/index.default-1.html b/docs/api/functions/index.default-1.html index 9868459..66b976b 100644 --- a/docs/api/functions/index.default-1.html +++ b/docs/api/functions/index.default-1.html @@ -41,7 +41,7 @@
    _options: {}

    Returns Wretch

    +
  • Defined in src/index.ts:36
    • diff --git a/docs/api/functions/middlewares_dedupe.dedupe.html b/docs/api/functions/middlewares_dedupe.dedupe.html index 256d4ce..7dcc0a6 100644 --- a/docs/api/functions/middlewares_dedupe.dedupe.html +++ b/docs/api/functions/middlewares_dedupe.dedupe.html @@ -56,7 +56,7 @@

    Parameters

    Optional options: DedupeOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/dedupe.ts:33
    • diff --git a/docs/api/functions/middlewares_delay.delay.html b/docs/api/functions/middlewares_delay.delay.html index f0f05a4..b680c2a 100644 --- a/docs/api/functions/middlewares_delay.delay.html +++ b/docs/api/functions/middlewares_delay.delay.html @@ -43,7 +43,7 @@

    Parameters

    time: number

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/delay.ts:16
    • diff --git a/docs/api/functions/middlewares_retry.retry.html b/docs/api/functions/middlewares_retry.retry.html index 3c45b8a..e58a0a0 100644 --- a/docs/api/functions/middlewares_retry.retry.html +++ b/docs/api/functions/middlewares_retry.retry.html @@ -28,6 +28,11 @@

    Retry middleware

    Retries a request multiple times in case of an error (or until a custom condition is true).

     +
    +

    💡 By default, the request will be retried if the response status is not in the 2xx range.

    +
    // Replace the default condition with a custom one to avoid retrying on 4xx errors:
    until: (response, error) => response && (response.ok || (response.status >= 400 && response.status < 500))
+
    +
    import wretch from 'wretch'
    import { retry } from 'wretch/middlewares'

    wretch().middlewares([
      retry({
        // Options - defaults below
        delayTimer: 500,
        delayRamp: (delay, nbOfAttempts) => delay * nbOfAttempts,
        maxAttempts: 10,
        until: (response, error) => response && response.ok,
        onRetry: null,
        retryOnNetworkError: false,
        resolveWithLatestResponse: false,
        skip: undefined
      })
    ])

    // You can also return a Promise, which is useful if you want to inspect the body:
    wretch().middlewares([
      retry({
        until: response =>
          response.clone().json().then(body =>
            body.field === 'something'
          )
      })
    ])
    @@ -38,7 +43,7 @@

    Parameters

    Optional options: RetryOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/retry.ts:119
    • diff --git a/docs/api/functions/middlewares_throttlingCache.throttlingCache.html b/docs/api/functions/middlewares_throttlingCache.throttlingCache.html index fdf8925..b3e5b20 100644 --- a/docs/api/functions/middlewares_throttlingCache.throttlingCache.html +++ b/docs/api/functions/middlewares_throttlingCache.throttlingCache.html @@ -79,7 +79,7 @@

    Parameters

    Optional options: ThrottlingCacheOptions

    Returns ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse(key: any, response: any): void;
    }

    +
  • Defined in src/middlewares/throttlingCache.ts:56
    • diff --git a/docs/api/interfaces/addons_abort.AbortResolver.html b/docs/api/interfaces/addons_abort.AbortResolver.html index 786c6fd..318239e 100644 --- a/docs/api/interfaces/addons_abort.AbortResolver.html +++ b/docs/api/interfaces/addons_abort.AbortResolver.html @@ -21,7 +21,7 @@

    Hierarchy

    • AbortResolver
    +
  • Defined in src/addons/abort.ts:34
    • @@ -65,7 +65,7 @@

    Parameters

    this: C & WretchResponseChain<T, C, R>

    Returns [any, AbortResolver]

    +
  • Defined in src/addons/abort.ts:68

    • onAbort

    onAbort: (<T, C, R>(this: C & WretchResponseChain<T, C, R>, cb: WretchErrorCallback<T, C, R>) => AbortResolver)
    @@ -96,7 +96,7 @@
    this: Ccb: WretchErrorCallback<T, C, R>

    Returns AbortResolver

    +
  • Defined in src/addons/abort.ts:72

    • setTimeout

    setTimeout: (<T, C, R>(this: C & WretchResponseChain<T, C, R>, time: number, controller?: AbortController) => AbortResolver)
    @@ -136,7 +136,7 @@
    Optional controller:

    Returns AbortResolver

    +
  • Defined in src/addons/abort.ts:50
    • diff --git a/docs/api/interfaces/addons_abort.AbortWretch.html b/docs/api/interfaces/addons_abort.AbortWretch.html index e26678c..71210e5 100644 --- a/docs/api/interfaces/addons_abort.AbortWretch.html +++ b/docs/api/interfaces/addons_abort.AbortWretch.html @@ -21,7 +21,7 @@

    Hierarchy

    • AbortWretch
    +
  • Defined in src/addons/abort.ts:3
    • @@ -69,7 +69,7 @@
    controller: AbortController

    Returns AbortWretch

    +
  • Defined in src/addons/abort.ts:31
    • diff --git a/docs/api/interfaces/addons_formData.FormDataAddon.html b/docs/api/interfaces/addons_formData.FormDataAddon.html index fefe70e..6f5772d 100644 --- a/docs/api/interfaces/addons_formData.FormDataAddon.html +++ b/docs/api/interfaces/addons_formData.FormDataAddon.html @@ -21,7 +21,7 @@

    Hierarchy

    • FormDataAddon
    +
  • Defined in src/addons/formData.ts:37
    • @@ -76,7 +76,7 @@
    Optional recursive:

    Returns FormDataAddon

    +
  • Defined in src/addons/formData.ts:80
    • diff --git a/docs/api/interfaces/addons_formUrl.FormUrlAddon.html b/docs/api/interfaces/addons_formUrl.FormUrlAddon.html index 5ef4819..99a22ec 100644 --- a/docs/api/interfaces/addons_formUrl.FormUrlAddon.html +++ b/docs/api/interfaces/addons_formUrl.FormUrlAddon.html @@ -21,7 +21,7 @@

    Hierarchy

    • FormUrlAddon
    +
  • Defined in src/addons/formUrl.ts:24
    • @@ -64,7 +64,7 @@
    input: stringReturns FormUrlAddon
    +
  • Defined in src/addons/formUrl.ts:41
    • diff --git a/docs/api/interfaces/addons_perfs.PerfsAddon.html b/docs/api/interfaces/addons_perfs.PerfsAddon.html index c9e8155..91cf004 100644 --- a/docs/api/interfaces/addons_perfs.PerfsAddon.html +++ b/docs/api/interfaces/addons_perfs.PerfsAddon.html @@ -21,7 +21,7 @@

    Hierarchy

    • PerfsAddon
    +
  • Defined in src/addons/perfs.ts:3
    • @@ -75,7 +75,7 @@
    timing: any

    Returns void

    Returns PerfsAddon

    +
  • Defined in src/addons/perfs.ts:9
    • diff --git a/docs/api/interfaces/addons_progress.ProgressResolver.html b/docs/api/interfaces/addons_progress.ProgressResolver.html index a41f6c6..5080306 100644 --- a/docs/api/interfaces/addons_progress.ProgressResolver.html +++ b/docs/api/interfaces/addons_progress.ProgressResolver.html @@ -21,7 +21,7 @@

    Hierarchy

    • ProgressResolver
    +
  • Defined in src/addons/progress.ts:3
    • @@ -82,7 +82,7 @@
    total: number

    Returns void

    Returns ProgressResolver

    +
  • Defined in src/addons/progress.ts:23
    • diff --git a/docs/api/interfaces/addons_queryString.QueryStringAddon.html b/docs/api/interfaces/addons_queryString.QueryStringAddon.html index 02acf7c..0dbf024 100644 --- a/docs/api/interfaces/addons_queryString.QueryStringAddon.html +++ b/docs/api/interfaces/addons_queryString.QueryStringAddon.html @@ -21,7 +21,7 @@

    Hierarchy

    • QueryStringAddon
    +
  • Defined in src/addons/queryString.ts:37
    • @@ -74,7 +74,7 @@
    qp: stringOptional replace: boolean

    Returns QueryStringAddon

    +
  • Defined in src/addons/queryString.ts:87
    • diff --git a/docs/api/interfaces/index.Wretch.html b/docs/api/interfaces/index.Wretch.html index 7d8de85..42eb4e5 100644 --- a/docs/api/interfaces/index.Wretch.html +++ b/docs/api/interfaces/index.Wretch.html @@ -36,7 +36,7 @@

    Hierarchy

    • Wretch
    +
  • Defined in src/types.ts:13
    • @@ -96,7 +96,7 @@
    contents: any

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:397

    • json

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:413

    • HTTP Methods

    @@ -142,7 +142,7 @@
    this: SelfOptional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:470

    • fetch

    +
  • Defined in src/types.ts:444

    • get

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:457

    • head

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:522

    • opts

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:535

    • patch

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:509

    • post

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:496

    • put

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:483

    • Helpers Methods

    @@ -315,7 +315,7 @@
    headerValue: string

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:209

    • addon

    Returns W & Self & Wretch<Self & W, Chain & R, Resolver>

    +
  • Defined in src/types.ts:64

    • auth

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:233

    • catcher

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:284

    • content

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:221

    • defer

    +
  • Defined in src/types.ts:316

    • errorType

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:86

    • headers

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:197

    • middlewares

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:383

    • options

    +
  • Defined in src/types.ts:182

    • polyfills

    +
  • Defined in src/types.ts:110

    • resolve

    Returns Self & Wretch<Self, Chain, ResolverReturn>

    +
  • Defined in src/types.ts:352

    • url

    +
  • Defined in src/types.ts:138
    • diff --git a/docs/api/interfaces/index.WretchError.html b/docs/api/interfaces/index.WretchError.html index ab642c1..f9edb54 100644 --- a/docs/api/interfaces/index.WretchError.html +++ b/docs/api/interfaces/index.WretchError.html @@ -26,7 +26,7 @@

    Hierarchy

    • WretchError
    +
  • Defined in src/types.ts:733
    • @@ -49,7 +49,7 @@

    Properties

    Optional json

    json?: any
    +
  • Defined in src/types.ts:733

    • message

    message: string
    +
  • Defined in src/types.ts:733

    • Optional stack

    stack?: string
    +
  • Defined in src/types.ts:733

    • Optional text

    text?: string
    +
  • Defined in src/types.ts:733

    • url

    url: string
    +
  • Defined in src/types.ts:733
    • diff --git a/docs/api/interfaces/index.WretchResponseChain.html b/docs/api/interfaces/index.WretchResponseChain.html index d306c54..1510d8a 100644 --- a/docs/api/interfaces/index.WretchResponseChain.html +++ b/docs/api/interfaces/index.WretchResponseChain.html @@ -34,7 +34,7 @@

    Hierarchy

    • WretchResponseChain
    +
  • Defined in src/types.ts:546
    • @@ -86,7 +86,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:659

    • error

    error: ((this: Self & WretchResponseChain<T, Self, R>, code: string | number | symbol, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -114,7 +114,7 @@
    code: stringWretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:650

    • fetchError

    fetchError: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -138,7 +138,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:713

    • forbidden

    forbidden: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -163,7 +163,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:677

    • internalError

    internalError: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -188,7 +188,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:706

    • notFound

    notFound: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -213,7 +213,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:686

    • timeout

    timeout: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -238,7 +238,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:696

    • unauthorized

    unauthorized: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -263,7 +263,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:668

    • Response Type Properties

    @@ -303,7 +303,7 @@
    type: ArrayBuffer
    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:611

    • blob

    blob: (<Result>(cb?: ((type: Blob) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -341,7 +341,7 @@
    type: Blob

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:591

    • formData

    formData: (<Result>(cb?: ((type: FormData) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -379,7 +379,7 @@
    type: FormData

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:601

    • json

    json: (<Result>(cb?: ((type: any) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -417,7 +417,7 @@
    type: any

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:581

    • res

    res: (<Result>(cb?: ((type: WretchResponse) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -456,7 +456,7 @@
    type: Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:571

    • text

    text: (<Result>(cb?: ((type: string) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -494,7 +494,7 @@
    type: string

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:621
    • diff --git a/docs/api/modules/addons.html b/docs/api/modules/addons.html index 65b029f..162b668 100644 --- a/docs/api/modules/addons.html +++ b/docs/api/modules/addons.html @@ -16,7 +16,7 @@
  • addons

    • Module addons

    +
  • Defined in src/addons/index.ts:1
    • diff --git a/docs/api/modules/addons_abort.html b/docs/api/modules/addons_abort.html index 4c761e6..291b317 100644 --- a/docs/api/modules/addons_abort.html +++ b/docs/api/modules/addons_abort.html @@ -16,7 +16,7 @@
  • addons/abort

    • Module addons/abort

    +
  • Defined in src/addons/abort.ts:1
    • diff --git a/docs/api/modules/addons_formData.html b/docs/api/modules/addons_formData.html index f5a4c9d..d85cbb6 100644 --- a/docs/api/modules/addons_formData.html +++ b/docs/api/modules/addons_formData.html @@ -16,7 +16,7 @@
  • addons/formData

    • Module addons/formData

    +
  • Defined in src/addons/formData.ts:1
    • diff --git a/docs/api/modules/addons_formUrl.html b/docs/api/modules/addons_formUrl.html index 680f55c..b4dc162 100644 --- a/docs/api/modules/addons_formUrl.html +++ b/docs/api/modules/addons_formUrl.html @@ -16,7 +16,7 @@
  • addons/formUrl

    • Module addons/formUrl

    +
  • Defined in src/addons/formUrl.ts:1
    • diff --git a/docs/api/modules/addons_perfs.html b/docs/api/modules/addons_perfs.html index d3664b8..34b94bc 100644 --- a/docs/api/modules/addons_perfs.html +++ b/docs/api/modules/addons_perfs.html @@ -16,7 +16,7 @@
  • addons/perfs

    • Module addons/perfs

    +
  • Defined in src/addons/perfs.ts:1
    • diff --git a/docs/api/modules/addons_progress.html b/docs/api/modules/addons_progress.html index 421dcda..0cf1fee 100644 --- a/docs/api/modules/addons_progress.html +++ b/docs/api/modules/addons_progress.html @@ -16,7 +16,7 @@
  • addons/progress

    • Module addons/progress

    +
  • Defined in src/addons/progress.ts:1
    • diff --git a/docs/api/modules/addons_queryString.html b/docs/api/modules/addons_queryString.html index daade00..72ae125 100644 --- a/docs/api/modules/addons_queryString.html +++ b/docs/api/modules/addons_queryString.html @@ -16,7 +16,7 @@
  • addons/queryString

    • Module addons/queryString

    +
  • Defined in src/addons/queryString.ts:1
    • diff --git a/docs/api/modules/index.default.html b/docs/api/modules/index.default.html index c011358..e3fde23 100644 --- a/docs/api/modules/index.default.html +++ b/docs/api/modules/index.default.html @@ -17,12 +17,12 @@
  • default

    • Namespace default

    +
  • Defined in src/index.ts:36
    • +
  • Defined in src/index.ts:40
    • +
  • Defined in src/index.ts:42
    • +
  • Defined in src/index.ts:44
    • +
  • Defined in src/index.ts:46
    • +
  • Defined in src/index.ts:47

    • Index

    diff --git a/docs/api/modules/index.html b/docs/api/modules/index.html index 77cb711..bfa2d3a 100644 --- a/docs/api/modules/index.html +++ b/docs/api/modules/index.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in src/index.ts:1
    • diff --git a/docs/api/modules/middlewares.html b/docs/api/modules/middlewares.html index e5c4618..6bdbaec 100644 --- a/docs/api/modules/middlewares.html +++ b/docs/api/modules/middlewares.html @@ -16,7 +16,7 @@
  • middlewares

    • Module middlewares

    +
  • Defined in src/middlewares/index.ts:1
    • diff --git a/docs/api/modules/middlewares_dedupe.html b/docs/api/modules/middlewares_dedupe.html index 2f4364e..5433c9a 100644 --- a/docs/api/modules/middlewares_dedupe.html +++ b/docs/api/modules/middlewares_dedupe.html @@ -16,7 +16,7 @@
  • middlewares/dedupe

    • Module middlewares/dedupe

    +
  • Defined in src/middlewares/dedupe.ts:1
    • diff --git a/docs/api/modules/middlewares_delay.html b/docs/api/modules/middlewares_delay.html index f431778..72b9641 100644 --- a/docs/api/modules/middlewares_delay.html +++ b/docs/api/modules/middlewares_delay.html @@ -16,7 +16,7 @@
  • middlewares/delay

    • Module middlewares/delay

    +
  • Defined in src/middlewares/delay.ts:1
    • diff --git a/docs/api/modules/middlewares_retry.html b/docs/api/modules/middlewares_retry.html index 01503e6..bd73c13 100644 --- a/docs/api/modules/middlewares_retry.html +++ b/docs/api/modules/middlewares_retry.html @@ -16,7 +16,7 @@
  • middlewares/retry

    • Module middlewares/retry

    +
  • Defined in src/middlewares/retry.ts:1
    • diff --git a/docs/api/modules/middlewares_throttlingCache.html b/docs/api/modules/middlewares_throttlingCache.html index fcc7f08..6107d87 100644 --- a/docs/api/modules/middlewares_throttlingCache.html +++ b/docs/api/modules/middlewares_throttlingCache.html @@ -16,7 +16,7 @@
  • middlewares/throttlingCache

    • Module middlewares/throttlingCache

    +
  • Defined in src/middlewares/throttlingCache.ts:1
    • diff --git a/docs/api/types/index.Config.html b/docs/api/types/index.Config.html index 0a7f675..59a40dc 100644 --- a/docs/api/types/index.Config.html +++ b/docs/api/types/index.Config.html @@ -48,9 +48,9 @@
    Optional instance: Rest ...args: any[]

    Returns any

    +
  • Defined in src/types.ts:719
    • diff --git a/docs/api/types/index.ConfiguredMiddleware.html b/docs/api/types/index.ConfiguredMiddleware.html index 77c2402..26e6f73 100644 --- a/docs/api/types/index.ConfiguredMiddleware.html +++ b/docs/api/types/index.ConfiguredMiddleware.html @@ -35,7 +35,7 @@

    Parameters

    next: FetchLike

    Returns FetchLike

    +
  • Defined in src/types.ts:757
    • diff --git a/docs/api/types/index.FetchLike.html b/docs/api/types/index.FetchLike.html index 90280f6..4e951e3 100644 --- a/docs/api/types/index.FetchLike.html +++ b/docs/api/types/index.FetchLike.html @@ -35,7 +35,7 @@
    url: string
    opts: WretchOptions

    Returns Promise<WretchResponse>

    +
  • Defined in src/types.ts:761
    • diff --git a/docs/api/types/index.Middleware.html b/docs/api/types/index.Middleware.html index 18fa01f..66f3b49 100644 --- a/docs/api/types/index.Middleware.html +++ b/docs/api/types/index.Middleware.html @@ -37,7 +37,7 @@
    Optional options: [key: string]: any

    Returns ConfiguredMiddleware

    +
  • Defined in src/types.ts:751
    • diff --git a/docs/api/types/index.WretchAddon.html b/docs/api/types/index.WretchAddon.html index 0589efa..5af676b 100644 --- a/docs/api/types/index.WretchAddon.html +++ b/docs/api/types/index.WretchAddon.html @@ -58,9 +58,9 @@
    options: state: Record<any, any>

    Returns T & Wretch<T, C, R>

    +
  • Defined in src/types.ts:766
    • diff --git a/docs/api/types/index.WretchDeferredCallback.html b/docs/api/types/index.WretchDeferredCallback.html index 059b07d..a93db6f 100644 --- a/docs/api/types/index.WretchDeferredCallback.html +++ b/docs/api/types/index.WretchDeferredCallback.html @@ -46,7 +46,7 @@
    url: string
    options: WretchOptions

    Returns Wretch<T, C, any>

    +
  • Defined in src/types.ts:745
    • diff --git a/docs/api/types/index.WretchErrorCallback.html b/docs/api/types/index.WretchErrorCallback.html index f050998..cb2b38d 100644 --- a/docs/api/types/index.WretchErrorCallback.html +++ b/docs/api/types/index.WretchErrorCallback.html @@ -44,7 +44,7 @@
    error: Wretch<T, C, R>

    Returns any

    +
  • Defined in src/types.ts:737
    • diff --git a/docs/api/types/index.WretchOptions.html b/docs/api/types/index.WretchOptions.html index 06c3fe9..54ed73c 100644 --- a/docs/api/types/index.WretchOptions.html +++ b/docs/api/types/index.WretchOptions.html @@ -20,7 +20,7 @@

    Type alias WretchOptions

    Fetch Request options with additional properties.

    +
  • Defined in src/types.ts:729
    • diff --git a/docs/api/types/index.WretchResponse.html b/docs/api/types/index.WretchResponse.html index 36686b7..8154212 100644 --- a/docs/api/types/index.WretchResponse.html +++ b/docs/api/types/index.WretchResponse.html @@ -20,7 +20,7 @@

    Type alias WretchResponse

    Fetch Response object with additional properties.

    +
  • Defined in src/types.ts:741
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html index 561d649..2dbb544 100644 --- a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns string

    +
  • Defined in src/middlewares/dedupe.ts:6
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeMiddleware.html b/docs/api/types/middlewares_dedupe.DedupeMiddleware.html index 72fc3ce..9c645fa 100644 --- a/docs/api/types/middlewares_dedupe.DedupeMiddleware.html +++ b/docs/api/types/middlewares_dedupe.DedupeMiddleware.html @@ -60,7 +60,7 @@

    Parameters

    Optional options: DedupeOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/dedupe.ts:33
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeOptions.html b/docs/api/types/middlewares_dedupe.DedupeOptions.html index bf4e27e..41a3cfb 100644 --- a/docs/api/types/middlewares_dedupe.DedupeOptions.html +++ b/docs/api/types/middlewares_dedupe.DedupeOptions.html @@ -27,7 +27,7 @@
    Optional resolver
    Optional skip?: DedupeSkipFunction
    +
  • Defined in src/middlewares/dedupe.ts:8
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html b/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html index 9ce0f70..9ffca96 100644 --- a/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html @@ -31,7 +31,7 @@

    Parameters

    response: Response

    Returns Response

    +
  • Defined in src/middlewares/dedupe.ts:7
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html b/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html index 3eca637..c086ad4 100644 --- a/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/dedupe.ts:5
    • diff --git a/docs/api/types/middlewares_delay.DelayMiddleware.html b/docs/api/types/middlewares_delay.DelayMiddleware.html index 09c93c7..8628520 100644 --- a/docs/api/types/middlewares_delay.DelayMiddleware.html +++ b/docs/api/types/middlewares_delay.DelayMiddleware.html @@ -47,7 +47,7 @@

    Parameters

    time: number

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/delay.ts:16
    • diff --git a/docs/api/types/middlewares_retry.DelayRampFunction.html b/docs/api/types/middlewares_retry.DelayRampFunction.html index b1c03ee..0f73372 100644 --- a/docs/api/types/middlewares_retry.DelayRampFunction.html +++ b/docs/api/types/middlewares_retry.DelayRampFunction.html @@ -33,7 +33,7 @@
    delay: number
    nbOfAttempts: number

    Returns number

    +
  • Defined in src/middlewares/retry.ts:5
    • diff --git a/docs/api/types/middlewares_retry.OnRetryFunction.html b/docs/api/types/middlewares_retry.OnRetryFunction.html index 91a0c3b..7820dbe 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunction.html +++ b/docs/api/types/middlewares_retry.OnRetryFunction.html @@ -40,7 +40,7 @@
    Optional response: string

    Returns void | OnRetryFunctionResponse | Promise<OnRetryFunctionResponse>

    +
  • Defined in src/middlewares/retry.ts:13
    • diff --git a/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html b/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html index 0175606..2fef9c9 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html +++ b/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html @@ -18,7 +18,7 @@

    Type alias OnRetryFunctionResponse

    OnRetryFunctionResponse: {
        options?: WretchOptions;
        url?: string;
    } | undefined
    +
  • Defined in src/middlewares/retry.ts:10
    • diff --git a/docs/api/types/middlewares_retry.RetryMiddleware.html b/docs/api/types/middlewares_retry.RetryMiddleware.html index 6deec65..c974a1f 100644 --- a/docs/api/types/middlewares_retry.RetryMiddleware.html +++ b/docs/api/types/middlewares_retry.RetryMiddleware.html @@ -32,6 +32,11 @@

    Retry middleware

    Retries a request multiple times in case of an error (or until a custom condition is true).

     +
    +

    💡 By default, the request will be retried if the response status is not in the 2xx range.

    +
    // Replace the default condition with a custom one to avoid retrying on 4xx errors:
    until: (response, error) => response && (response.ok || (response.status >= 400 && response.status < 500))
+
    +
    import wretch from 'wretch'
    import { retry } from 'wretch/middlewares'

    wretch().middlewares([
      retry({
        // Options - defaults below
        delayTimer: 500,
        delayRamp: (delay, nbOfAttempts) => delay * nbOfAttempts,
        maxAttempts: 10,
        until: (response, error) => response && response.ok,
        onRetry: null,
        retryOnNetworkError: false,
        resolveWithLatestResponse: false,
        skip: undefined
      })
    ])

    // You can also return a Promise, which is useful if you want to inspect the body:
    wretch().middlewares([
      retry({
        until: response =>
          response.clone().json().then(body =>
            body.field === 'something'
          )
      })
    ])
    @@ -42,7 +47,7 @@

    Parameters

    Optional options: RetryOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/retry.ts:119
    • diff --git a/docs/api/types/middlewares_retry.RetryOptions.html b/docs/api/types/middlewares_retry.RetryOptions.html index 9a9fcd0..db7c76d 100644 --- a/docs/api/types/middlewares_retry.RetryOptions.html +++ b/docs/api/types/middlewares_retry.RetryOptions.html @@ -64,7 +64,7 @@
    Optional until
    +
  • Defined in src/middlewares/retry.ts:20
    • diff --git a/docs/api/types/middlewares_retry.SkipFunction.html b/docs/api/types/middlewares_retry.SkipFunction.html index 1099685..03e29a5 100644 --- a/docs/api/types/middlewares_retry.SkipFunction.html +++ b/docs/api/types/middlewares_retry.SkipFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/retry.ts:19
    • diff --git a/docs/api/types/middlewares_retry.UntilFunction.html b/docs/api/types/middlewares_retry.UntilFunction.html index 5ed7747..0ed6f31 100644 --- a/docs/api/types/middlewares_retry.UntilFunction.html +++ b/docs/api/types/middlewares_retry.UntilFunction.html @@ -33,7 +33,7 @@
    Optional response: Optional error: Error

    Returns boolean | Promise<boolean>

    +
  • Defined in src/middlewares/retry.ts:6
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html index 257d4de..b3ea40e 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:7
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html index 4dc63e6..9f7ade1 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html @@ -31,7 +31,7 @@

    Parameters

    response: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:9
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html index fa82e79..efb9288 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns string | RegExp | void

    +
  • Defined in src/middlewares/throttlingCache.ts:8
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html index 30a613b..1b0ff46 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns string

    +
  • Defined in src/middlewares/throttlingCache.ts:6
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html index 012be4f..d5ab284 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html @@ -83,7 +83,7 @@

    Parameters

    Optional options: ThrottlingCacheOptions

    Returns ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse(key: any, response: any): void;
    }

    +
  • Defined in src/middlewares/throttlingCache.ts:56
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html index fd4de58..5f738b3 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html @@ -35,7 +35,7 @@
    Optional skip
    Optional throttle?: number
    +
  • Defined in src/middlewares/throttlingCache.ts:10
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html index ac34df8..4591449 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:5
    • diff --git a/docs/api/variables/addons_formData.default.html b/docs/api/variables/addons_formData.default.html index b601d85..2f34372 100644 --- a/docs/api/variables/addons_formData.default.html +++ b/docs/api/variables/addons_formData.default.html @@ -22,7 +22,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/formData.ts:92
    • diff --git a/docs/api/variables/addons_formUrl.default.html b/docs/api/variables/addons_formUrl.default.html index ad019c3..ee91436 100644 --- a/docs/api/variables/addons_formUrl.default.html +++ b/docs/api/variables/addons_formUrl.default.html @@ -22,7 +22,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/formUrl.ts:53
    • diff --git a/docs/api/variables/addons_queryString.default.html b/docs/api/variables/addons_queryString.default.html index 475bbd1..61b80c5 100644 --- a/docs/api/variables/addons_queryString.default.html +++ b/docs/api/variables/addons_queryString.default.html @@ -22,7 +22,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/queryString.ts:99
    • diff --git a/docs/api/variables/index.default.WretchError.html b/docs/api/variables/index.default.WretchError.html index 9a77592..86f08fe 100644 --- a/docs/api/variables/index.default.WretchError.html +++ b/docs/api/variables/index.default.WretchError.html @@ -19,7 +19,7 @@

    Variable WretchError

    WretchError: typeof WretchError
    +
  • Defined in src/index.ts:47
    • diff --git a/docs/api/variables/index.default.default.html b/docs/api/variables/index.default.default.html index 749492a..47368fd 100644 --- a/docs/api/variables/index.default.default.html +++ b/docs/api/variables/index.default.default.html @@ -19,7 +19,7 @@

    Variable default

    default: typeof default
    +
  • Defined in src/index.ts:40
    • diff --git a/docs/api/variables/index.default.errorType.html b/docs/api/variables/index.default.errorType.html index 7d181f5..ef1dece 100644 --- a/docs/api/variables/index.default.errorType.html +++ b/docs/api/variables/index.default.errorType.html @@ -39,7 +39,7 @@

    Parameters

    errorType: string

    Returns void

    +
  • Defined in src/index.ts:44
    • diff --git a/docs/api/variables/index.default.options.html b/docs/api/variables/index.default.options.html index f97db73..732ba83 100644 --- a/docs/api/variables/index.default.options.html +++ b/docs/api/variables/index.default.options.html @@ -42,7 +42,7 @@
    replace: booleanReturns void
    +
  • Defined in src/index.ts:42
    • diff --git a/docs/api/variables/index.default.polyfills.html b/docs/api/variables/index.default.polyfills.html index 9a35390..258e9ab 100644 --- a/docs/api/variables/index.default.polyfills.html +++ b/docs/api/variables/index.default.polyfills.html @@ -44,7 +44,7 @@
    replace: booleanReturns void
    +
  • Defined in src/index.ts:46
    • diff --git a/src/middlewares/retry.ts b/src/middlewares/retry.ts index 2040c0b..7b18d67 100644 --- a/src/middlewares/retry.ts +++ b/src/middlewares/retry.ts @@ -80,6 +80,13 @@ export type RetryOptions = { * * #### Retries a request multiple times in case of an error (or until a custom condition is true). * + * > **💡 By default, the request will be retried if the response status is not in the 2xx range.** + * > + * > ```js + * > // Replace the default condition with a custom one to avoid retrying on 4xx errors: + * > until: (response, error) => response && (response.ok || (response.status >= 400 && response.status < 500)) + * > ``` + * * ```ts * import wretch from 'wretch' * import { retry } from 'wretch/middlewares'