Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

description

Yafetch options

Hierarchy

  • RequestInit
    • Options

Index

Properties

baseUrl?: string
description

Base url for this request. Prioritized over the base url in the global options, if any

body?: any
description

An optional BodyInit or object literal to set request's body

see

BodyInit

see

Record<string,any>

cache?: RequestCache

A string indicating how the request will interact with the browser's cache to set request's cache.

credentials?: RequestCredentials

A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

headers?: HeadersInit

A Headers object, an object literal, or an array of two-item arrays to set request's headers.

integrity?: string

A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

keepalive?: boolean

A boolean to set request's keepalive.

method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH"
mode?: RequestMode

A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

plugins?: { after?: Plugin[]; before?: Plugin[]; wrap?: WrapPlugin[] }
description

Plugins to run. These are categorized by their type and order of execution depends on plugin's location in this array

Type declaration

redirect?: RequestRedirect

A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

referrer?: string

A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

signal?: null | AbortSignal

An AbortSignal to set request's signal.

skipPlugins?: {}
description

Skip a plugin execution. This only applies to plugins in the global options

Type declaration

  • [pluginName: string]: "before" | "after" | "wrap" | "all"
window?: null

Can only be null. Used to disassociate request from any Window.

Methods

  • fetchProxy(input: RequestInfo, init?: RequestInit): Promise<Response>
  • description

    Optionally use another implementation for fetch instead of the browser provided API

    Parameters

    • input: RequestInfo
    • Optional init: RequestInit

    Returns Promise<Response>

Generated using TypeDoc