diff --git a/docs/api/interfaces/addons_abort.AbortResolver.html b/docs/api/interfaces/addons_abort.AbortResolver.html index e323d16..00e4918 100644 --- a/docs/api/interfaces/addons_abort.AbortResolver.html +++ b/docs/api/interfaces/addons_abort.AbortResolver.html @@ -60,7 +60,7 @@

Parameters

this: C & WretchResponseChain<T, C>

Returns [any, AbortResolver]

+
  • Defined in addons/abort.ts:69

    • onAbort

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

    Returns AbortResolver

    +
  • Defined in addons/abort.ts:73

    • setTimeout

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

    Returns AbortResolver

    +
  • Defined in addons/abort.ts:51
    • diff --git a/docs/api/interfaces/addons_abort.AbortWretch.html b/docs/api/interfaces/addons_abort.AbortWretch.html index b69eb60..8b24046 100644 --- a/docs/api/interfaces/addons_abort.AbortWretch.html +++ b/docs/api/interfaces/addons_abort.AbortWretch.html @@ -64,7 +64,7 @@
    controller: AbortController

    Returns AbortWretch

    +
  • Defined in addons/abort.ts:32
    • diff --git a/docs/api/interfaces/addons_perfs.PerfsAddon.html b/docs/api/interfaces/addons_perfs.PerfsAddon.html index 87e36a7..cbdc1fe 100644 --- a/docs/api/interfaces/addons_perfs.PerfsAddon.html +++ b/docs/api/interfaces/addons_perfs.PerfsAddon.html @@ -71,7 +71,7 @@
    timing: any

    Returns void

    Returns PerfsAddon

    +
  • Defined in addons/perfs.ts:66
    • diff --git a/docs/api/interfaces/index.Wretch.html b/docs/api/interfaces/index.Wretch.html index 5b6e60b..6e361df 100644 --- a/docs/api/interfaces/index.Wretch.html +++ b/docs/api/interfaces/index.Wretch.html @@ -141,6 +141,9 @@

    fetch

  • Sends the request using the accumulated fetch options.

    +

    Can be used to replay requests.

    +
    const reAuthOn401 = wretch()
    .catcher(401, async (error, request) => {
      // Renew credentials
      const token = await wretch("/renewtoken").get().text();
      storeToken(token);
      // Replay the original request with new credentials
      return request.auth(token).fetch().unauthorized((err) => {
        throw err;
      }).json();
    });

    reAuthOn401
    .get("/resource")
    .json() // <- Will only be called for the original promise
    .then(callback); // <- Will be called for the original OR the replayed promise result
+

    Parameters

    @@ -148,11 +151,17 @@

    Parameters

  • this: Self & Wretch<Self, Chain>
  • -
    Optional method: string
    • +

    Optional method: string
    +

    The HTTP method to use

    +
  • -
    Optional url: string
    • +
    Optional url: string
    +

    Some url to append

    +
  • -
    Optional body: any
    • +
    Optional body: any
    +

    Set the body. Behaviour varies depending on the argument type, an object is considered as json.

    +

    Returns Chain & WretchResponseChain<Self, Chain>

    get

    diff --git a/docs/api/interfaces/index.WretchResponseChain.html b/docs/api/interfaces/index.WretchResponseChain.html index dbc2424..55e2781 100644 --- a/docs/api/interfaces/index.WretchResponseChain.html +++ b/docs/api/interfaces/index.WretchResponseChain.html @@ -81,7 +81,7 @@
    this: Selfcb: WretchErrorCallback<T, Self>

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:123

    • error

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:114

    • fetchError

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:177

    • forbidden

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:141

    • internalError

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:170

    • notFound

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:150

    • timeout

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:160

    • unauthorized

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

    Returns WretchResponseChain<T, Self>

    +
  • Defined in resolver.ts:132

    • Response Type Properties

    @@ -307,7 +307,7 @@
    type: ArrayBuffer
    Returns Result

    Returns Promise<Result>

    +
  • Defined in resolver.ts:75

    • blob

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

    Returns Result

    Returns Promise<Result>

    +
  • Defined in resolver.ts:55

    • formData

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

    Returns Result

    Returns Promise<Result>

    +
  • Defined in resolver.ts:65

    • json

    json: (<Result>(cb?: ((type: { [key: string]: any }) => Result)) => Promise<Result>)
    @@ -430,7 +430,7 @@
    [key: Returns Result

    Returns Promise<Result>

    +
  • Defined in resolver.ts:45

    • res

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

    Returns Promise<Result>

    +
  • Defined in resolver.ts:35

    • text

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

    Returns Result

    Returns Promise<Result>

    +
  • Defined in resolver.ts:85
    • diff --git a/docs/api/types/index.Config.html b/docs/api/types/index.Config.html index 27ec194..f9a08cd 100644 --- a/docs/api/types/index.Config.html +++ b/docs/api/types/index.Config.html @@ -16,7 +16,7 @@

    Type alias Config

    Config: typeof config
    +
  • Defined in config.ts:27
    • diff --git a/docs/api/types/index.ConfiguredMiddleware.html b/docs/api/types/index.ConfiguredMiddleware.html index 6bec610..85e7825 100644 --- a/docs/api/types/index.ConfiguredMiddleware.html +++ b/docs/api/types/index.ConfiguredMiddleware.html @@ -34,7 +34,7 @@

    Parameters

    next: FetchLike

    Returns FetchLike

    +
  • Defined in middleware.ts:14
    • diff --git a/docs/api/types/index.FetchLike.html b/docs/api/types/index.FetchLike.html index 81c3105..2b76859 100644 --- a/docs/api/types/index.FetchLike.html +++ b/docs/api/types/index.FetchLike.html @@ -34,7 +34,7 @@
    url: string
    opts: WretchOptions

    Returns Promise<WretchResponse>

    +
  • Defined in middleware.ts:18
    • diff --git a/docs/api/types/index.Middleware.html b/docs/api/types/index.Middleware.html index ca3220e..424b4fd 100644 --- a/docs/api/types/index.Middleware.html +++ b/docs/api/types/index.Middleware.html @@ -36,7 +36,7 @@
    Optional options: [key: string]: any

    Returns ConfiguredMiddleware

    +
  • Defined in middleware.ts:8
    • diff --git a/docs/api/types/index.WretchDeferredCallback.html b/docs/api/types/index.WretchDeferredCallback.html index 587a679..6caab6a 100644 --- a/docs/api/types/index.WretchDeferredCallback.html +++ b/docs/api/types/index.WretchDeferredCallback.html @@ -42,7 +42,7 @@
    url: string
    options: WretchOptions

    Returns Wretch<T, C>

    +
  • Defined in types.ts:26
    • diff --git a/docs/api/types/index.WretchError.html b/docs/api/types/index.WretchError.html index 0b70514..6a47da7 100644 --- a/docs/api/types/index.WretchError.html +++ b/docs/api/types/index.WretchError.html @@ -18,7 +18,7 @@

    Type alias WretchError

    An Error enhanced with status, text and body.

    +
  • Defined in types.ts:14
    • diff --git a/docs/api/types/index.WretchErrorCallback.html b/docs/api/types/index.WretchErrorCallback.html index a88e904..bc94677 100644 --- a/docs/api/types/index.WretchErrorCallback.html +++ b/docs/api/types/index.WretchErrorCallback.html @@ -40,7 +40,7 @@
    error: originalRequest: Wretch<T, C>

    Returns any

    +
  • Defined in types.ts:18
    • diff --git a/docs/api/types/index.WretchOptions.html b/docs/api/types/index.WretchOptions.html index 5e074b5..0a453e3 100644 --- a/docs/api/types/index.WretchOptions.html +++ b/docs/api/types/index.WretchOptions.html @@ -18,7 +18,7 @@

    Type alias WretchOptions

    Fetch Request options with additional properties.

    +
  • Defined in types.ts:10
    • diff --git a/docs/api/types/index.WretchResponse.html b/docs/api/types/index.WretchResponse.html index 769600b..8111fc0 100644 --- a/docs/api/types/index.WretchResponse.html +++ b/docs/api/types/index.WretchResponse.html @@ -18,7 +18,7 @@

    Type alias WretchResponse

    Fetch Response object with additional properties.

    +
  • Defined in types.ts:22
    • diff --git a/docs/api/variables/addons_formData.default.html b/docs/api/variables/addons_formData.default.html index f174d48..80c74d7 100644 --- a/docs/api/variables/addons_formData.default.html +++ b/docs/api/variables/addons_formData.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in addons/formData.ts:94
    • diff --git a/docs/api/variables/addons_formUrl.default.html b/docs/api/variables/addons_formUrl.default.html index db1b514..e4b4268 100644 --- a/docs/api/variables/addons_formUrl.default.html +++ b/docs/api/variables/addons_formUrl.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in addons/formUrl.ts:54
    • diff --git a/docs/api/variables/addons_queryString.default.html b/docs/api/variables/addons_queryString.default.html index 02da81b..bfb1a69 100644 --- a/docs/api/variables/addons_queryString.default.html +++ b/docs/api/variables/addons_queryString.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in addons/queryString.ts:94
    • diff --git a/docs/api/variables/index.default.default.html b/docs/api/variables/index.default.default.html index 871e3e5..de32bf3 100644 --- a/docs/api/variables/index.default.default.html +++ b/docs/api/variables/index.default.default.html @@ -17,7 +17,7 @@

    Variable default

    default: typeof default
    +
  • Defined in index.ts:38
    • diff --git a/docs/api/variables/index.default.errorType.html b/docs/api/variables/index.default.errorType.html index 0d318f3..08dfc45 100644 --- a/docs/api/variables/index.default.errorType.html +++ b/docs/api/variables/index.default.errorType.html @@ -37,7 +37,7 @@

    Parameters

    errorType: string

    Returns void

    +
  • Defined in index.ts:42
    • diff --git a/docs/api/variables/index.default.options.html b/docs/api/variables/index.default.options.html index e9476b2..c8ca602 100644 --- a/docs/api/variables/index.default.options.html +++ b/docs/api/variables/index.default.options.html @@ -41,7 +41,7 @@
    replace: booleanReturns void
    +
  • Defined in index.ts:40
    • diff --git a/docs/api/variables/index.default.polyfills.html b/docs/api/variables/index.default.polyfills.html index 3fba17e..e456d8d 100644 --- a/docs/api/variables/index.default.polyfills.html +++ b/docs/api/variables/index.default.polyfills.html @@ -43,7 +43,7 @@
    replace: booleanReturns void
    +
  • Defined in index.ts:44