Interface XiorRequestConfig<T>

interface XiorRequestConfig<T> {
    _RESIRun?: boolean;
    _url?: string;
    baseURL?: string;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    data?: any;
    encodeURI?: boolean;
    headers?: Record<string, any>;
    integrity?: string;
    isGet?: boolean;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    params?: Record<string, any>;
    paramsSerializer?: ((params: Record<string, any>) => string);
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    responseType?:
        | "json"
        | "text"
        | "stream"
        | "document"
        | "arraybuffer"
        | "blob"
        | "original";
    signal?: null | AbortSignal;
    timeout?: number;
    url?: string;
    window?: null;
    withCredentials?: boolean;
}

Type Parameters

  • T = any

Hierarchy

  • Omit<RequestInit, "body">
    • XiorRequestConfig

Properties

_RESIRun? _url? baseURL? cache? credentials? data? encodeURI? headers? integrity? isGet? keepalive? method? mode? params? paramsSerializer? redirect? referrer? referrerPolicy? responseType? signal? timeout? url? window? withCredentials?

Properties

Optional_RESIRun

_RESIRun?: boolean

response interceptors already run?

Optional_url

_url?: string

encoded url with params

OptionalbaseURL

baseURL?: string

Optionalcache

cache?: RequestCache

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

Optionalcredentials

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.

Optionaldata

data?: any

OptionalencodeURI

encodeURI?: boolean

Use encodeURIComponent, default: true

Optionalheaders

headers?: Record<string, any>

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

Optionalintegrity

integrity?: string

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

OptionalisGet

isGet?: boolean

some API is get data, but the method is not 'GET', add isGet: true, can let the plugins know this is also a GET API

Optionalkeepalive

keepalive?: boolean

A boolean to set request's keepalive.

Optionalmethod

method?: string

A string to set request's method.

Optionalmode

mode?: RequestMode

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

Optionalparams

params?: Record<string, any>

OptionalparamsSerializer

paramsSerializer?: ((params: Record<string, any>) => string)

Optionalredirect

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.

Optionalreferrer

referrer?: string

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

OptionalreferrerPolicy

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

OptionalresponseType

responseType?:
    | "json"
    | "text"
    | "stream"
    | "document"
    | "arraybuffer"
    | "blob"
    | "original"

Currently only support 'json' | 'text', default: 'json'; Others will just return the original response

Optionalsignal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optionaltimeout

timeout?: number

If no set, default depends on browsers timeout

Optionalurl

url?: string

Optionalwindow

window

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

OptionalwithCredentials

withCredentials?: boolean

Deprecated

if true, will set credentials=true, or you can just use fetch's config credentials: 'include' | 'omit' | 'same-origin'

Settings

Member Visibility

On This Page

Properties