xior
    Preparing search index...

    Interface XiorRequestConfig<T>

    interface XiorRequestConfig<T = any> {
        _did?: boolean;
        _url?: string;
        baseURL?: string;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        data?: any;
        encodeURI?: boolean;
        fetch?: (input: any, init?: any) => Promise<any>;
        fetchOptions?: any;
        headers?: Record<string, any>;
        integrity?: string;
        isGet?: boolean;
        keepalive?: boolean;
        method?: string;
        mode?: RequestMode;
        params?: Record<string, any>;
        paramsSerializer?: (params: Record<string, any>) => string;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        responseType?:
            | "text"
            | "json"
            | "stream"
            | "document"
            | "arraybuffer"
            | "blob"
            | "original"
            | "custom";
        signal?: null
        | AbortSignal;
        timeout?: number;
        transformRequest?: any[];
        transformResponse?: any[];
        url?: string;
        validateStatus?: (status: number) => boolean;
        window?: null;
        withCredentials?: boolean;
    }

    Type Parameters

    • T = any

    Hierarchy

    • Omit<RequestInit, "body">
      • XiorRequestConfig
    Index

    Properties

    _did? _url? baseURL? cache? credentials? data? encodeURI? fetch? fetchOptions? headers? integrity? isGet? keepalive? method? mode? params? paramsSerializer? priority? redirect? referrer? referrerPolicy? responseType? signal? timeout? transformRequest? transformResponse? url? validateStatus? window? withCredentials?

    Properties

    Optional_did

    _did?: boolean

    Internal use only response interceptors already run?

    Optional_url

    _url?: string

    Internal use only encoded url with params

    baseURL?: string
    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.

    data?: any
    encodeURI?: boolean

    Use encodeURIComponent, default: true

    fetch?: (input: any, init?: any) => Promise<any>

    fetch?:

    fetchOptions?: any

    Useless here. Try import axios from 'xior/axios';

    headers?: Record<string, any>

    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.

    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

    keepalive?: boolean

    A boolean to set request's keepalive.

    method?: string

    A string to set request's method.

    mode?: RequestMode

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

    params?: Record<string, any>
    paramsSerializer?: (params: Record<string, any>) => string
    priority?: RequestPriority
    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.

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

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

    signal?: null | AbortSignal

    An AbortSignal to set request's signal.

    timeout?: number

    If no set, default depends on browsers timeout

    transformRequest?: any[]

    Useless here. Try import axios from 'xior/axios';

    transformResponse?: any[]

    Useless here. Try import axios from 'xior/axios';

    url?: string
    validateStatus?: (status: number) => boolean

    Useless here. Try import axios from 'xior/axios';

    window?: null

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

    withCredentials?: boolean

    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