From 411fb09d218fe997dfb3274453953594008e54ce Mon Sep 17 00:00:00 2001 From: Julien Elbaz Date: Sat, 5 Aug 2023 08:50:31 +0200 Subject: [PATCH] :memo: Mention file names in the form data addon doc Solves #197 --- 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 | 11 +++- .../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 +- src/addons/formData.ts | 9 ++++ 70 files changed, 144 insertions(+), 128 deletions(-) diff --git a/docs/api/functions/addons_abort.default.html b/docs/api/functions/addons_abort.default.html index 78a2819..006022c 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 759b875..95eea58 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 fc96103..8d71dc3 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 475193b..245bc7a 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 a4fe0cf..13232c1 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 0b6171c..39b91c5 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 39f301c..f45ebe3 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 813651c..15caeba 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 4078409..31dcf59 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 4a331fe..fa59bb9 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 0f313c8..f6a585d 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
    • @@ -51,6 +51,13 @@

    formData 
    const form = {
      duck: "Muscovy",
      duckProperties: {
        beak: {
          color: "yellow",
        },
        legs: 2,
      },
      ignored: {
        key: 0,
      },
    };

    // Will append the following keys to the FormData payload:
    // "duck", "duckProperties[beak][color]", "duckProperties[legs]"
    wretch("...").addons(FormDataAddon).formData(form, ["ignored"]).post();
    +
    +

    Note: This addon does not support specifying a custom filename. +If you need to do so, you can use the body method directly:

    +
    const form = new FormData();
    form.append("hello", "world", "hello.txt");
    wretch("...").body(form).post();
+
    +

    See: https://developer.mozilla.org/en-US/docs/Web/API/FormData/append#example

    +

    Type Parameters

    @@ -79,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 4fc09c0..e3fe226 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 6db1686..085cc54 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 1921806..736b36c 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 20cc8cb..a57aaea 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 31d2df6..7cd7904 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 76d6079..d1daaf4 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 5d4407a..a278d57 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 995a62c..4237e22 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 bc63044..64a2dcf 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 9309342..b941042 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 d73c678..2bd4314 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 7ec4c23..61b7471 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 08a04bd..77e984c 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 8e9e073..1757d25 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 150916e..b8b0b7a 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 94e0f84..15ab817 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 a858e70..3c3ea81 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 de38871..ab193b5 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 6db2379..776b54f 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 53ee741..c837f1b 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 a146f98..04aa685 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 ce7e238..4ff86d8 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 4bb88ff..85554e9 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 0185cd7..a6bd149 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 e591e76..9c34f8c 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 aed7e90..b98eb01 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 7bcef3b..b36c169 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 08edf5f..ef97620 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 c0cbfc5..0cfe29e 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 48fb636..a2a1099 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 08360d2..4941520 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 02fc8e1..554577c 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 5cf72f9..fb8cbb4 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 16f7dd0..6808792 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 7307cba..7bec208 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 2b02607..c9f61a3 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 d5a661d..433631b 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 75701f7..9e792ab 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 32405ba..72a346d 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 f97baa1..484481a 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 6fcfe12..edf9579 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 c17c5fc..c3f7894 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 5ed8ae6..7441469 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 1a709af..d11f6b4 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 377b740..b83c0be 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 84b34b4..32a54cb 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 3e00f4b..c17b903 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 d20c51f..d7bf84b 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 e6a5002..89d9ea5 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 c4fdc48..fa1559b 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 fdd3a40..6fa11c3 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 684e2d3..b431f61 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 0f8faa5..6c1a8d4 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 bb9e52c..83658e5 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 1dfa5bb..72d7ec5 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 83f2242..add0236 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 c218e25..bae14e9 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 0194b66..5014ef0 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/src/addons/formData.ts b/src/addons/formData.ts index c12ad93..45c5caf 100644 --- a/src/addons/formData.ts +++ b/src/addons/formData.ts @@ -74,6 +74,15 @@ export interface FormDataAddon { * wretch("...").addons(FormDataAddon).formData(form, ["ignored"]).post(); * ``` * + * > Note: This addon does not support specifying a custom `filename`. + * > If you need to do so, you can use the `body` method directly: + * > ```js + * > const form = new FormData(); + * > form.append("hello", "world", "hello.txt"); + * > wretch("...").body(form).post(); + * > ``` + * > See: https://developer.mozilla.org/en-US/docs/Web/API/FormData/append#example + * * @param formObject - An object which will be converted to a FormData * @param recursive - If `true`, will recurse through all nested objects. Can be set as an array of string to exclude specific keys. */