From bda300c16100e4598135750c141a1a0537f39e3c Mon Sep 17 00:00:00 2001 From: Julien Elbaz Date: Tue, 11 Apr 2023 08:35:39 +0200 Subject: [PATCH] 2.5.2 tag --- CHANGELOG.md | 15 +++++ docs/api/functions/addons_abort.default.html | 2 +- docs/api/functions/addons_perfs.default.html | 2 +- .../functions/addons_progress.default.html | 2 +- docs/api/functions/index.default-1.html | 2 +- .../functions/middlewares_dedupe.dedupe.html | 2 +- .../functions/middlewares_delay.delay.html | 2 +- .../functions/middlewares_retry.retry.html | 2 +- ...wares_throttlingCache.throttlingCache.html | 2 +- .../addons_abort.AbortResolver.html | 8 +-- .../interfaces/addons_abort.AbortWretch.html | 4 +- .../addons_formData.FormDataAddon.html | 4 +- .../addons_formUrl.FormUrlAddon.html | 4 +- .../interfaces/addons_perfs.PerfsAddon.html | 4 +- .../addons_progress.ProgressResolver.html | 4 +- .../addons_queryString.QueryStringAddon.html | 4 +- docs/api/interfaces/index.Wretch.html | 56 +++++++++---------- docs/api/interfaces/index.WretchError.html | 12 ++-- .../interfaces/index.WretchResponseChain.html | 30 +++++----- docs/api/modules/addons.html | 2 +- docs/api/modules/addons_abort.html | 2 +- docs/api/modules/addons_formData.html | 2 +- docs/api/modules/addons_formUrl.html | 2 +- docs/api/modules/addons_perfs.html | 2 +- docs/api/modules/addons_progress.html | 2 +- docs/api/modules/addons_queryString.html | 2 +- docs/api/modules/index.default.html | 12 ++-- docs/api/modules/index.html | 2 +- docs/api/modules/middlewares.html | 2 +- docs/api/modules/middlewares_dedupe.html | 2 +- docs/api/modules/middlewares_delay.html | 2 +- docs/api/modules/middlewares_retry.html | 2 +- .../modules/middlewares_throttlingCache.html | 2 +- docs/api/types/index.Config.html | 4 +- .../api/types/index.ConfiguredMiddleware.html | 2 +- docs/api/types/index.FetchLike.html | 2 +- docs/api/types/index.Middleware.html | 2 +- docs/api/types/index.WretchAddon.html | 4 +- .../types/index.WretchDeferredCallback.html | 2 +- docs/api/types/index.WretchErrorCallback.html | 2 +- docs/api/types/index.WretchOptions.html | 2 +- docs/api/types/index.WretchResponse.html | 2 +- .../middlewares_dedupe.DedupeKeyFunction.html | 2 +- .../middlewares_dedupe.DedupeMiddleware.html | 2 +- .../middlewares_dedupe.DedupeOptions.html | 2 +- ...lewares_dedupe.DedupeResolverFunction.html | 2 +- ...middlewares_dedupe.DedupeSkipFunction.html | 2 +- .../middlewares_delay.DelayMiddleware.html | 2 +- .../middlewares_retry.DelayRampFunction.html | 2 +- .../middlewares_retry.OnRetryFunction.html | 2 +- ...lewares_retry.OnRetryFunctionResponse.html | 2 +- .../middlewares_retry.RetryMiddleware.html | 2 +- .../types/middlewares_retry.RetryOptions.html | 2 +- .../types/middlewares_retry.SkipFunction.html | 2 +- .../middlewares_retry.UntilFunction.html | 2 +- ...ingCache.ThrottlingCacheClearFunction.html | 2 +- ...ache.ThrottlingCacheConditionFunction.html | 2 +- ...che.ThrottlingCacheInvalidateFunction.html | 2 +- ...tlingCache.ThrottlingCacheKeyFunction.html | 2 +- ...ttlingCache.ThrottlingCacheMiddleware.html | 2 +- ...hrottlingCache.ThrottlingCacheOptions.html | 2 +- ...lingCache.ThrottlingCacheSkipFunction.html | 2 +- .../variables/addons_formData.default.html | 2 +- .../api/variables/addons_formUrl.default.html | 2 +- .../variables/addons_queryString.default.html | 2 +- .../variables/index.default.WretchError.html | 2 +- docs/api/variables/index.default.default.html | 2 +- .../variables/index.default.errorType.html | 2 +- docs/api/variables/index.default.options.html | 2 +- .../variables/index.default.polyfills.html | 2 +- package.json | 2 +- 71 files changed, 147 insertions(+), 132 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d71c440..af0a960 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ + +## [2.5.2](https://github.com/elbywan/wretch/compare/2.5.1...2.5.2) (2023-04-11) + + +### :bug: Bug fix(es) + +* Fix catcher and resolve callback argument type. ([76c295f](https://github.com/elbywan/wretch/commit/76c295f)), closes [#177](https://github.com/elbywan/wretch/issues/177) + +### :memo: Documentation update(s) + +* Node.js 18 section wording ([b696b1c](https://github.com/elbywan/wretch/commit/b696b1c)) +* Warn to use a custom until function to avoid retrying on 4xx error ([1812c73](https://github.com/elbywan/wretch/commit/1812c73)), closes [#176](https://github.com/elbywan/wretch/issues/176) + + + ## [2.5.1](https://github.com/elbywan/wretch/compare/2.5.0...2.5.1) (2023-02-27) diff --git a/docs/api/functions/addons_abort.default.html b/docs/api/functions/addons_abort.default.html index 793224a..95efe6d 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 45dbe71..fda13ac 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 80d1133..eb0729e 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 66b976b..2b7a6ff 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 7dcc0a6..99b75ee 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 b680c2a..83855f8 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 e58a0a0..5708b81 100644 --- a/docs/api/functions/middlewares_retry.retry.html +++ b/docs/api/functions/middlewares_retry.retry.html @@ -43,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 b3e5b20..3137962 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 318239e..f27543c 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 71210e5..a3b14f3 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 6f5772d..8346537 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 99a22ec..29db396 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 91cf004..e2202d9 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 5080306..d90f19f 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 0dbf024..dd6c986 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 42eb4e5..b048029 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

  • Optional clear: Clear

    • 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 f9edb54..3a449c2 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 1510d8a..a579914 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 162b668..7182fd8 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 291b317..f58f877 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 d85cbb6..a65f05e 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 b4dc162..8ad9ec1 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 34b94bc..e512f35 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 0cf1fee..7ecd8a4 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 72ae125..cc864db 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 e3fde23..0915a3e 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 bfa2d3a..93f1288 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 6bdbaec..5a8171e 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 5433c9a..7f20452 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 72b9641..45be85c 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 bd73c13..206c522 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 6107d87..044a520 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 59a40dc..31a628b 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 26e6f73..436c3ea 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 4e951e3..1e4bd86 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 66f3b49..4dda4c7 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 5af676b..91cd45c 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 a93db6f..90d98fc 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 cb2b38d..033bb1b 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 54ed73c..acd9463 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 8154212..16aabeb 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 2dbb544..970dc72 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 9c645fa..e21919f 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 41a3cfb..984c30a 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 9ffca96..dd7010e 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 c086ad4..62ab22a 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 8628520..d820fee 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 0f73372..58a043c 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 7820dbe..b22bb91 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 2fef9c9..8b22e2d 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 c974a1f..71444e0 100644 --- a/docs/api/types/middlewares_retry.RetryMiddleware.html +++ b/docs/api/types/middlewares_retry.RetryMiddleware.html @@ -47,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 db7c76d..c21bc8c 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 03e29a5..863b649 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 0ed6f31..fbee0f1 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 b3ea40e..c19abfc 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 9f7ade1..8d10458 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 efb9288..26ff9cb 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 1b0ff46..1bb4e2e 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 d5ab284..4cc7023 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 5f738b3..df44973 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 4591449..31c230e 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 2f34372..efb2dbf 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 ee91436..e381b49 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 61b80c5..05970f3 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 86f08fe..b1b7231 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 47368fd..efa40bb 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 ef1dece..475f128 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 732ba83..609c1a8 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 258e9ab..590c212 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/package.json b/package.json index 301a19b..31ce39d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wretch", - "version": "2.5.1", + "version": "2.5.2", "type": "module", "description": "A tiny wrapper built around fetch with an intuitive syntax.", "keywords": [