Interface RequestOptions

Request options

interface RequestOptions {
    data?: string | Record<string, any>;
    handleAs?:
        | "json"
        | "javascript"
        | "text"
        | "xml"
        | "blob"
        | "binary";
    headers?: Record<string, any>;
    jsonp?: string | boolean;
    jsonpfn?: string;
    maxUrlLength?: number;
    method?:
        | "GET"
        | "POST"
        | "PUT"
        | "DELETE"
        | "HEAD";
    postprocessors?: PostProcessor[];
    preprocessors?: PreProcessor[];
    preventCache?: boolean;
    query?: Record<string, any>;
    signal?: AbortSignal;
    timeout?: number;
    useCors?: {
        withCredentials?: boolean;
    };
    useProxy?: boolean | "force";
    withCredentials?: boolean;
    [key: string]: any;
}

Indexable

  • [key: string]: any

    Processors may allow additional properties

Properties

data? handleAs? headers? jsonp? jsonpfn? maxUrlLength? method? postprocessors? preprocessors? preventCache? query? signal? timeout? useCors? useProxy? withCredentials?

Properties

Optionaldata

data?: string | Record<string, any>

Request body (used if POST/PUT)

OptionalhandleAs

handleAs?:
    | "json"
    | "javascript"
    | "text"
    | "xml"
    | "blob"
    | "binary"

How to interpret the response. Default is "json".

Optionalheaders

headers?: Record<string, any>

HTTP Headers.

Optionaljsonp

jsonp?: string | boolean

Enables jsonp request processing (response is interpreted as javascript). If true it appends query parameter 'callback='. If it is a string then <jsonp value>=<methodname> will be appended. Please use CORS, this will not be supported in future versions.

Deprecated

Optionaljsonpfn

jsonpfn?: string

Allows 'static' jsonp. If jsonp is true and jsonpfn is configured the the query parameter 'callback=' is appended. The javascript method name is controlled by the caller and not dynamically created.

Deprecated

OptionalmaxUrlLength

maxUrlLength?: number

Allows per request configuration of maximal url length. If it is to long a GET request will be switched to POST. Please prefer the config option 'maxUrlLength'.

Optionalmethod

method?:
    | "GET"
    | "POST"
    | "PUT"
    | "DELETE"
    | "HEAD"

HTTP METHOD If not specified GET is used.

Optionalpostprocessors

postprocessors?: PostProcessor[]

Custom post-processors only valid for the current request. Helpful in tests. Please prefer the config option to register processors for all requests.

Optionalpreprocessors

preprocessors?: PreProcessor[]

Custom pre-processors only valid for the current request. Helpful in tests. Please prefer the config option to register processors for all requests.

OptionalpreventCache

preventCache?: boolean

Flag will create random 'salt' to the query parameters to prevent browser caching.

Optionalquery

query?: Record<string, any>

Query Parameter. Note, if data is not defined and method is post this will be converted to the post body.

Optionalsignal

signal?: AbortSignal

AbortSignal to cancel the request.

Optionaltimeout

timeout?: number

Request timeout in msec.

OptionaluseCors

useCors?: {
    withCredentials?: boolean;
}

Option to mark target url as trusted for CORS. Please prefer to register a trusted servers via config.

OptionaluseProxy

useProxy?: boolean | "force"

Enables/disables the use of a proxy. True is the default value and a proxy is used if the CORS communication, fails. False prevents the use of a proxy. "force" skips the CORS detection and enforces the use of a proxy. Please prefer the config option 'proxyRules' for that.

OptionalwithCredentials

withCredentials?: boolean

Option to mark request to include credentials. Please prefer to register a trusted servers via config.

Deprecated

Settings

Member Visibility

On This Page

Properties