Interface Options<T>

Option for an external HTTP request

interface Options<T> {
    customHeaders?: {
        [key: string]: string;
    };
    data?: object;
    error?: CdvPurchase.Utils.Ajax.ErrorCallback;
    method?: string;
    success?: SuccessCallback<T>;
    timeout?: number;
    url: string;
}

Type Parameters

T

Index

Properties

customHeaders? data? error? method? success? timeout? url

Properties

`Optional` customHeaders

customHeaders?: {
[key: string]: string;
}

Custom headers to pass tot the HTTP request.

Type declaration

[key: string]: string

`Optional` data

data?: object

Payload for a POST request

`Optional` error

error?: CdvPurchase.Utils.Ajax.ErrorCallback

Error callback taking the response error code, text and body as arguments

`Optional` method

method?: string

Method for the request (POST, GET, ...)

`Optional` success

success?: SuccessCallback<T>

A success callback taking the body as an argument

`Optional` timeout

timeout?: number

Request timeout in milliseconds

url

url: string

URL of the request (https://example.com)