Interface RouteRequestOptions<RT, ReturnUrl, Q, B>

interface RouteRequestOptions<RT, ReturnUrl, Q, B> {
    body?: string;
    cache?: boolean;
    cacheName?: string;
    cacheProps?: Record<string, unknown>;
    credentials?: RequestCredentials;
    headers?: Record<string, string>;
    integrity?: string;
    json?: B;
    keepalive?: boolean;
    lunkwill?: LunkwillParam;
    lunkwillReturnUrl?: ReturnUrl;
    method?: string;
    mode?: RequestMode;
    priority?: RequestPriority;
    query?: Q;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    responseType?: RT;
    signal?: null | AbortSignal;
    window?: null;
    withCredentials?: boolean;
}

Type Parameters

  • RT extends ResponseType = "json"
  • ReturnUrl extends boolean = false
  • Q = any
  • B =
        | string
        | null
        | boolean
        | Record<string, any>
        | any[]

Hierarchy

  • Omit<RequestInit, "cache">
    • RouteRequestOptions

Properties

body? cache? cacheName? cacheProps? credentials? headers? integrity? json? keepalive? lunkwill? lunkwillReturnUrl? method? mode? priority? query? redirect? referrer? referrerPolicy? responseType? signal? window? withCredentials?

Properties

Optionalbody

body?: string

Has lower priority than the json

Optionalcache

cache?: boolean

OptionalcacheName

cacheName?: string

Name to use for caching the request.

OptionalcacheProps

cacheProps?: Record<string, unknown>

Properties to override default cache behavior.

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.

Optionalheaders

headers?: Record<string, string>

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.

Optionaljson

json?: B

Optionalkeepalive

keepalive?: boolean

A boolean to set request's keepalive.

Optionallunkwill

lunkwill?: LunkwillParam

OptionallunkwillReturnUrl

lunkwillReturnUrl?: ReturnUrl

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.

Optionalpriority

priority?: RequestPriority

Optionalquery

query?: Q

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?: RT

The type of data that the server will respond with. Can be either 'json' or 'blob'.

Optionalsignal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optionalwindow

window

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

OptionalwithCredentials

withCredentials?: boolean

Deprecated

use RequestInit.credential Indicates whether to include credentials such as cookies, authentication headers, or TLS client certificates in cross-site Access-Control requests.

Settings

Member Visibility

On This Page

Properties