From a804cace6040268908eebe8014cdbad86867fd00 Mon Sep 17 00:00:00 2001 From: Julien Elbaz Date: Tue, 12 Sep 2023 19:28:27 +0200 Subject: [PATCH] 2.7.0 tag --- CHANGELOG.md | 14 ++++++ README.md | 4 +- 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 | 50 +++++++++---------- 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 +- docs/index.html | 4 +- package.json | 4 +- 73 files changed, 148 insertions(+), 134 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f5856ce..3d38a20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ + +# [2.7.0](https://github.com/elbywan/wretch/compare/2.6.0...2.7.0) (2023-09-12) + + +### :factory: New feature(s) + +* Support FileList objects in the form data addon ([3582809](https://github.com/elbywan/wretch/commit/3582809)), closes [#201](https://github.com/elbywan/wretch/issues/201) + +### :memo: Documentation update(s) + +* Mention file names in the form data addon doc ([411fb09](https://github.com/elbywan/wretch/commit/411fb09)), closes [#197](https://github.com/elbywan/wretch/issues/197) + + + # [2.6.0](https://github.com/elbywan/wretch/compare/2.5.2...2.6.0) (2023-06-28) diff --git a/README.md b/README.md index ab14d74..a4055ce 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ license-badge

- A tiny (~1.9KB g-zipped) wrapper built around fetch with an intuitive syntax. + A tiny (~2KB g-zipped) wrapper built around fetch with an intuitive syntax.

f[ETCH] [WR]apper @@ -19,7 +19,7 @@
-##### Wretch 2.6 is now live 🎉 ! Please have a look at the [releases](https://github.com/elbywan/wretch/releases) and the [changelog](https://github.com/elbywan/wretch/blob/master/CHANGELOG.md) after each update for new features and breaking changes. If you want to try out the hot stuff, please look into the [dev](https://github.com/elbywan/wretch/tree/dev) branch. +##### Wretch 2.7 is now live 🎉 ! Please have a look at the [releases](https://github.com/elbywan/wretch/releases) and the [changelog](https://github.com/elbywan/wretch/blob/master/CHANGELOG.md) after each update for new features and breaking changes. If you want to try out the hot stuff, please look into the [dev](https://github.com/elbywan/wretch/tree/dev) branch. ##### And if you like the library please consider becoming a [sponsor](https://github.com/sponsors/elbywan) ❤️. diff --git a/docs/api/functions/addons_abort.default.html b/docs/api/functions/addons_abort.default.html index 006022c..195ada3 100644 --- a/docs/api/functions/addons_abort.default.html +++ b/docs/api/functions/addons_abort.default.html @@ -31,7 +31,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 95eea58..755842e 100644 --- a/docs/api/functions/addons_perfs.default.html +++ b/docs/api/functions/addons_perfs.default.html @@ -35,7 +35,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 8d71dc3..2eef4d6 100644 --- a/docs/api/functions/addons_progress.default.html +++ b/docs/api/functions/addons_progress.default.html @@ -28,7 +28,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 245bc7a..3335a32 100644 --- a/docs/api/functions/index.default-1.html +++ b/docs/api/functions/index.default-1.html @@ -43,7 +43,7 @@

    Returns

    +
  • 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 13232c1..b6ae6d2 100644 --- a/docs/api/functions/middlewares_dedupe.dedupe.html +++ b/docs/api/functions/middlewares_dedupe.dedupe.html @@ -49,7 +49,7 @@
    Optional 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 39b91c5..97b7d8c 100644 --- a/docs/api/functions/middlewares_delay.delay.html +++ b/docs/api/functions/middlewares_delay.delay.html @@ -36,7 +36,7 @@
    time: 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 f45ebe3..b83919e 100644 --- a/docs/api/functions/middlewares_retry.retry.html +++ b/docs/api/functions/middlewares_retry.retry.html @@ -36,7 +36,7 @@
    Optional 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 15caeba..ff851e2 100644 --- a/docs/api/functions/middlewares_throttlingCache.throttlingCache.html +++ b/docs/api/functions/middlewares_throttlingCache.throttlingCache.html @@ -72,7 +72,7 @@
    Optional Returns ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse(key, response) => 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 31dcf59..eefc10c 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
    • @@ -66,7 +66,7 @@
    this: Returns [any, AbortResolver]
    +
  • Defined in src/addons/abort.ts:68

    • onAbort

    onAbort: (<T, C, R>(this, cb) => AbortResolver)
    @@ -98,7 +98,7 @@
    cb: Returns AbortResolver
    +
  • Defined in src/addons/abort.ts:72

    • setTimeout

    setTimeout: (<T, C, R>(this, time, controller?) => AbortResolver)
    @@ -141,7 +141,7 @@
    Optional 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 fa59bb9..d428e3e 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
    • @@ -71,7 +71,7 @@
    controller: 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 f6a585d..1147a3c 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
    • @@ -86,7 +86,7 @@
    Optional Returns FormDataAddon
    +
  • Defined in src/addons/formData.ts:89
    • diff --git a/docs/api/interfaces/addons_formUrl.FormUrlAddon.html b/docs/api/interfaces/addons_formUrl.FormUrlAddon.html index e3fe226..2bb7c1b 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
    • @@ -66,7 +66,7 @@
    input: Returns 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 085cc54..d0b5d9e 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
    • @@ -76,7 +76,7 @@

    Returns voidReturns 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 736b36c..d9e781c 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
    • @@ -84,7 +84,7 @@

    Returns voidReturns 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 a57aaea..0d1608a 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
    • @@ -72,7 +72,7 @@
    Optional 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 7cd7904..6febc6b 100644 --- a/docs/api/interfaces/index.Wretch.html +++ b/docs/api/interfaces/index.Wretch.html @@ -37,7 +37,7 @@

    Hierarchy

    • Wretch
    +
  • Defined in src/types.ts:13
    • @@ -100,7 +100,7 @@
    contents: Returns Wretch<Self, Chain, Resolver>
    +
  • Defined in src/types.ts:417

    • json

    +
  • Defined in src/types.ts:433

    • Methods - HTTP

    @@ -150,7 +150,7 @@
    Optional Returns Resolver extends undefined
        ? Chain & WretchResponseChain<Self, Chain, Resolver>
        : Resolver
    +
  • Defined in src/types.ts:490

    • fetch

    +
  • Defined in src/types.ts:464

    • get

    +
  • Defined in src/types.ts:477

    • head

    +
  • Defined in src/types.ts:542

    • opts

    +
  • Defined in src/types.ts:555

    • patch

    +
  • Defined in src/types.ts:529

    • post

    +
  • Defined in src/types.ts:516

    • put

    +
  • Defined in src/types.ts:503

    • Methods - Helpers

    @@ -335,7 +335,7 @@
    headerValue: Returns Wretch<Self, Chain, Resolver>
    +
  • Defined in src/types.ts:209

    • addon

    +
  • Defined in src/types.ts:64

    • auth

    +
  • Defined in src/types.ts:233

    • catcher

    +
  • Defined in src/types.ts:284

    • catcherFallback

      @@ -472,7 +472,7 @@

      Returns catcher for more details.

    +
  • Defined in src/types.ts:304

    • content

    +
  • Defined in src/types.ts:221

    • defer

    +
  • Defined in src/types.ts:336

    • errorType

    +
  • Defined in src/types.ts:86

    • headers

    +
  • Defined in src/types.ts:197

    • middlewares

    +
  • Defined in src/types.ts:403

    • options

    +
  • Defined in src/types.ts:182

    • polyfills

    +
  • Defined in src/types.ts:110

    • resolve

    +
  • Defined in src/types.ts:372

    • url

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

    Hierarchy

    • WretchError
    +
  • Defined in src/types.ts:753
    • @@ -50,7 +50,7 @@

    Properties

    Optional json

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

    • message

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

    • Optional stack

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

    • Optional text

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

    • url

    url: string
    +
  • Defined in src/types.ts:753
    • diff --git a/docs/api/interfaces/index.WretchResponseChain.html b/docs/api/interfaces/index.WretchResponseChain.html index a278d57..121d82c 100644 --- a/docs/api/interfaces/index.WretchResponseChain.html +++ b/docs/api/interfaces/index.WretchResponseChain.html @@ -35,7 +35,7 @@

    Hierarchy

    • WretchResponseChain
    +
  • Defined in src/types.ts:566
    • @@ -88,7 +88,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:679

    • error

    error: ((this, code, cb) => WretchResponseChain<T, Self, R>)
    @@ -117,7 +117,7 @@
    cb: Returns WretchResponseChain<T, Self, R>
    +
  • Defined in src/types.ts:670

    • fetchError

    fetchError: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -142,7 +142,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:733

    • forbidden

    forbidden: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -168,7 +168,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:697

    • internalError

    internalError: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -194,7 +194,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:726

    • notFound

    notFound: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -220,7 +220,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:706

    • timeout

    timeout: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -246,7 +246,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:716

    • unauthorized

    unauthorized: ((this, cb) => WretchResponseChain<T, Self, R>)
    @@ -272,7 +272,7 @@

    Returns See

    error

    +
  • Defined in src/types.ts:688

    • Properties - Response Type

    @@ -313,7 +313,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:631

    • blob

    blob: (<Result>(cb?) => Promise<Awaited<Result>>)
    @@ -352,7 +352,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:611

    • formData

    formData: (<Result>(cb?) => Promise<Awaited<Result>>)
    @@ -391,7 +391,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:621

    • json

    json: (<Result>(cb?) => Promise<Awaited<Result>>)
    @@ -430,7 +430,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:601

    • res

    res: (<Result>(cb?) => Promise<Awaited<Result>>)
    @@ -470,7 +470,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:591

    • text

    text: (<Result>(cb?) => Promise<Awaited<Result>>)
    @@ -509,7 +509,7 @@

    Returns Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:641
    • diff --git a/docs/api/modules/addons.html b/docs/api/modules/addons.html index 4237e22..ca84c32 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 64a2dcf..ef51c3b 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

    • Index

    diff --git a/docs/api/modules/addons_formData.html b/docs/api/modules/addons_formData.html index b941042..debe4ac 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

    • Index

    diff --git a/docs/api/modules/addons_formUrl.html b/docs/api/modules/addons_formUrl.html index 2bd4314..6e28551 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

    • Index

    diff --git a/docs/api/modules/addons_perfs.html b/docs/api/modules/addons_perfs.html index 61b7471..54916f5 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

    • Index

    diff --git a/docs/api/modules/addons_progress.html b/docs/api/modules/addons_progress.html index 77e984c..dd0ae1a 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

    • Index

    diff --git a/docs/api/modules/addons_queryString.html b/docs/api/modules/addons_queryString.html index 1757d25..aa32a2a 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

    • Index

    diff --git a/docs/api/modules/index.default.html b/docs/api/modules/index.default.html index b8b0b7a..7f6f18a 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 15ab817..6f2872e 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

    • Index

    diff --git a/docs/api/modules/middlewares.html b/docs/api/modules/middlewares.html index 3c3ea81..729fe05 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 ab193b5..3be2368 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

    • Index

    diff --git a/docs/api/modules/middlewares_delay.html b/docs/api/modules/middlewares_delay.html index 776b54f..c37bf76 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

    • Index

    diff --git a/docs/api/modules/middlewares_retry.html b/docs/api/modules/middlewares_retry.html index c837f1b..d07fd74 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

    • Index

    diff --git a/docs/api/modules/middlewares_throttlingCache.html b/docs/api/modules/middlewares_throttlingCache.html index 04aa685..7a24922 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

    • Index

    diff --git a/docs/api/types/index.Config.html b/docs/api/types/index.Config.html index 4ff86d8..1115a36 100644 --- a/docs/api/types/index.Config.html +++ b/docs/api/types/index.Config.html @@ -48,10 +48,10 @@
    Optional Rest ...args: any[]

    Returns any

    +
  • Defined in src/types.ts:743
    • +
  • Defined in src/types.ts:739
    • diff --git a/docs/api/types/index.ConfiguredMiddleware.html b/docs/api/types/index.ConfiguredMiddleware.html index 85554e9..9c5d5ca 100644 --- a/docs/api/types/index.ConfiguredMiddleware.html +++ b/docs/api/types/index.ConfiguredMiddleware.html @@ -36,7 +36,7 @@
    next: Returns FetchLike
    +
  • Defined in src/types.ts:777
    • diff --git a/docs/api/types/index.FetchLike.html b/docs/api/types/index.FetchLike.html index a6bd149..98b8bae 100644 --- a/docs/api/types/index.FetchLike.html +++ b/docs/api/types/index.FetchLike.html @@ -36,7 +36,7 @@
    opts: Returns Promise<WretchResponse>
    +
  • Defined in src/types.ts:781
    • diff --git a/docs/api/types/index.Middleware.html b/docs/api/types/index.Middleware.html index 9c34f8c..60ed81d 100644 --- a/docs/api/types/index.Middleware.html +++ b/docs/api/types/index.Middleware.html @@ -38,7 +38,7 @@
    [

    Returns ConfiguredMiddleware

    +
  • Defined in src/types.ts:771
    • diff --git a/docs/api/types/index.WretchAddon.html b/docs/api/types/index.WretchAddon.html index b98eb01..5062690 100644 --- a/docs/api/types/index.WretchAddon.html +++ b/docs/api/types/index.WretchAddon.html @@ -58,10 +58,10 @@
    options: state: Record<any, any>

    Returns T & Wretch<T, C, R>

    +
  • Defined in src/types.ts:787
    • +
  • Defined in src/types.ts:786
    • diff --git a/docs/api/types/index.WretchDeferredCallback.html b/docs/api/types/index.WretchDeferredCallback.html index b36c169..5cab7d9 100644 --- a/docs/api/types/index.WretchDeferredCallback.html +++ b/docs/api/types/index.WretchDeferredCallback.html @@ -47,7 +47,7 @@
    options: Returns Wretch<T, C, any>
    +
  • Defined in src/types.ts:765
    • diff --git a/docs/api/types/index.WretchErrorCallback.html b/docs/api/types/index.WretchErrorCallback.html index ef97620..5bd6630 100644 --- a/docs/api/types/index.WretchErrorCallback.html +++ b/docs/api/types/index.WretchErrorCallback.html @@ -45,7 +45,7 @@
    originalRequest: Returns any
    +
  • Defined in src/types.ts:757
    • diff --git a/docs/api/types/index.WretchOptions.html b/docs/api/types/index.WretchOptions.html index 0cfe29e..6f65a66 100644 --- a/docs/api/types/index.WretchOptions.html +++ b/docs/api/types/index.WretchOptions.html @@ -21,7 +21,7 @@

    Type alias WretchOptions

    +
  • Defined in src/types.ts:749
    • diff --git a/docs/api/types/index.WretchResponse.html b/docs/api/types/index.WretchResponse.html index a2a1099..7d52d26 100644 --- a/docs/api/types/index.WretchResponse.html +++ b/docs/api/types/index.WretchResponse.html @@ -26,7 +26,7 @@

    Type declaration

    [key: string]: any
    +
  • Defined in src/types.ts:761
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html index 4941520..0bb06df 100644 --- a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html @@ -33,7 +33,7 @@
    url: 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 554577c..af43e35 100644 --- a/docs/api/types/middlewares_dedupe.DedupeMiddleware.html +++ b/docs/api/types/middlewares_dedupe.DedupeMiddleware.html @@ -53,7 +53,7 @@
    Optional 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 fb8cbb4..106ec0e 100644 --- a/docs/api/types/middlewares_dedupe.DedupeOptions.html +++ b/docs/api/types/middlewares_dedupe.DedupeOptions.html @@ -27,7 +27,7 @@
    Optional
    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 6808792..79fe904 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 7bec208..470ab77 100644 --- a/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html @@ -33,7 +33,7 @@
    url: 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 c9f61a3..0f3abe3 100644 --- a/docs/api/types/middlewares_delay.DelayMiddleware.html +++ b/docs/api/types/middlewares_delay.DelayMiddleware.html @@ -40,7 +40,7 @@
    time: 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 433631b..6876625 100644 --- a/docs/api/types/middlewares_retry.DelayRampFunction.html +++ b/docs/api/types/middlewares_retry.DelayRampFunction.html @@ -33,7 +33,7 @@
    delay: 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 9e792ab..5dadbc0 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunction.html +++ b/docs/api/types/middlewares_retry.OnRetryFunction.html @@ -40,7 +40,7 @@
    Optional url: 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 72a346d..44f8e91 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html +++ b/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html @@ -25,7 +25,7 @@
    Optional
    Optional url?: string
    +
  • 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 484481a..8115221 100644 --- a/docs/api/types/middlewares_retry.RetryMiddleware.html +++ b/docs/api/types/middlewares_retry.RetryMiddleware.html @@ -40,7 +40,7 @@
    Optional 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 edf9579..2edd72d 100644 --- a/docs/api/types/middlewares_retry.RetryOptions.html +++ b/docs/api/types/middlewares_retry.RetryOptions.html @@ -72,7 +72,7 @@
    Optional
    +
  • 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 c3f7894..b1e2666 100644 --- a/docs/api/types/middlewares_retry.SkipFunction.html +++ b/docs/api/types/middlewares_retry.SkipFunction.html @@ -33,7 +33,7 @@
    url: 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 7441469..5deb737 100644 --- a/docs/api/types/middlewares_retry.UntilFunction.html +++ b/docs/api/types/middlewares_retry.UntilFunction.html @@ -33,7 +33,7 @@
    Optional 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 d11f6b4..cd60fa3 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html @@ -33,7 +33,7 @@
    url: 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 b83c0be..3df0e03 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 32a54cb..f2104ed 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html @@ -33,7 +33,7 @@
    url: 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 c17b903..d5050d0 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html @@ -33,7 +33,7 @@
    url: 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 d7bf84b..bbf6934 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html @@ -76,7 +76,7 @@
    Optional Returns ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse(key, response) => 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 89d9ea5..c525970 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html @@ -35,7 +35,7 @@
    Optional
    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 fa1559b..0216b32 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html @@ -33,7 +33,7 @@
    url: 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 6fa11c3..788cc90 100644 --- a/docs/api/variables/addons_formData.default.html +++ b/docs/api/variables/addons_formData.default.html @@ -23,7 +23,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/formData.ts:101
    • diff --git a/docs/api/variables/addons_formUrl.default.html b/docs/api/variables/addons_formUrl.default.html index b431f61..36536d1 100644 --- a/docs/api/variables/addons_formUrl.default.html +++ b/docs/api/variables/addons_formUrl.default.html @@ -23,7 +23,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 6c1a8d4..c4f1884 100644 --- a/docs/api/variables/addons_queryString.default.html +++ b/docs/api/variables/addons_queryString.default.html @@ -23,7 +23,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 83658e5..f434f24 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 72d7ec5..4f4a0a6 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 add0236..d0fab0b 100644 --- a/docs/api/variables/index.default.errorType.html +++ b/docs/api/variables/index.default.errorType.html @@ -35,7 +35,7 @@
    errorType: 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 bae14e9..bd521bb 100644 --- a/docs/api/variables/index.default.options.html +++ b/docs/api/variables/index.default.options.html @@ -37,7 +37,7 @@
    replace: Returns 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 5014ef0..f917c86 100644 --- a/docs/api/variables/index.default.polyfills.html +++ b/docs/api/variables/index.default.polyfills.html @@ -37,7 +37,7 @@
    replace: Returns void
    +
  • Defined in src/index.ts:46
    • diff --git a/docs/index.html b/docs/index.html index 31f3097..4fda432 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@

    Wretch

    -

    A tiny (~ 1.9Kb g-zipped) wrapper built around fetch with an intuitive syntax.

    +

    A tiny (~ 2Kb g-zipped) wrapper built around fetch with an intuitive syntax.

    @@ -180,4 +180,4 @@

    Usage

    - + \ No newline at end of file diff --git a/package.json b/package.json index 99dcb15..36cae17 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wretch", - "version": "2.6.0", + "version": "2.7.0", "type": "module", "description": "A tiny wrapper built around fetch with an intuitive syntax.", "keywords": [ @@ -167,4 +167,4 @@ "src/addons/index.ts" ] } -} +} \ No newline at end of file