Interface RestApiClientOptions

interface RestApiClientOptions {
    baseUri?: any;
    proxyUri?: any;
    headers?: {
        [key: string]: any;
    };
    auth?: {
        username: any;
        password: any;
    };
    query?: {
        [key: string]: any;
    };
    returnFullResponse?: boolean;
    responseHandlers?: RestApiClientResponseHandler[];
    overrides?: RestApiClientOverride[];
    httpsAgent?: Agent;
    dynamicOptions?: ((input: RestApiClientInput) => RestApiClientOptions);
    binary?: boolean;
    stream?: boolean;
    onError?: ((error: any) => any);
}

Index

Properties

baseUri? proxyUri? headers? auth? query? returnFullResponse? responseHandlers? overrides? httpsAgent? dynamicOptions? binary? stream? onError?

Properties

`Optional`baseUri

baseUri?: any

`Optional`proxyUri

proxyUri?: any

`Optional`headers

headers?: {
[key: string]: any;
}

`Optional`auth

auth?: {
username: any;
password: any;
}

`Optional`query

query?: {
[key: string]: any;
}

`Optional`returnFullResponse

returnFullResponse?: boolean

`Optional`responseHandlers

responseHandlers?: RestApiClientResponseHandler[]

`Optional`overrides

overrides?: RestApiClientOverride[]

`Optional`httpsAgent

httpsAgent?: Agent

`Optional`dynamicOptions

dynamicOptions?: ((input: RestApiClientInput) => RestApiClientOptions)

`Optional`binary

binary?: boolean

Deprecated

use responseType instead

`Optional`stream

stream?: boolean

Deprecated

use responseType instead

`Optional`onError

onError?: ((error: any) => any)

Deprecated

use responseHandlers