Interface RequestOptions

Request options

interface RequestOptions {
    authenticationProvider?: AuthenticationProvider;
    cache?: string;
    cacheKey?: string;
    cancellationToken?: CancellationToken;
    credentials?: RequestCredentials;
    data?: any;
    error?: (reason: any) => void;
    headers?: Record<string, string>;
    method: string;
    parser?: (response: Response) => Promise<any>;
    retry?: (attempt: number) => void;
    retryAttempts?: number;
    retryDelay?: number;
    serializer?: (data: any) => string;
    storageMode?: StorageMode;
    success?: (response: any) => void;
    timeout?: number;
    url: string;
}

Properties

authenticationProvider? cache? cacheKey? cancellationToken? credentials? data? error? headers? method parser? retry? retryAttempts? retryDelay? serializer? storageMode? success? timeout? url

Properties

OptionalauthenticationProvider

authenticationProvider?: AuthenticationProvider

Authentication provider (default: null)

Optionalcache

cache?: string

Cache name (default: "Default")

OptionalcacheKey

cacheKey?: string

Cache key (default: url + JSON.stringify(data))

OptionalcancellationToken

cancellationToken?: CancellationToken

Request cancellation token (default: null)

Optionalcredentials

credentials?: RequestCredentials

Request credentials (default: same-origin)

Optionaldata

data?: any

Request data

Optionalerror

error?: (reason: any) => void

Request error callback (default: Logger.error)

Optionalheaders

headers?: Record<string, string>

Request headers (default: {})

method

method: string

Request method (default: GET)

Optionalparser

parser?: (response: Response) => Promise<any>

Request parser (default: response.json())

Optionalretry

retry?: (attempt: number) => void

Request retry callback (default: Logger.debug)

OptionalretryAttempts

retryAttempts?: number

Retry attempts (default: 3)

OptionalretryDelay

retryDelay?: number

Retry delay in milliseconds (default: 1000)

Optionalserializer

serializer?: (data: any) => string

Request serializer (default: JSON.stringify)

OptionalstorageMode

storageMode?: StorageMode

Storage mode (default: StorageMode.NetworkFirst)

Optionalsuccess

success?: (response: any) => void

Request success callback (default: Logger.debug)

Optionaltimeout

timeout?: number

Timeout in milliseconds (default: 60000)

url

url: string

Request url (default: "")

Settings

Member Visibility

On This Page

Properties