• lib
• Configuration

Interface Configuration

interface Configuration {
baseUrl: string;
parseError: (response: Response) => Promise<Error>;
fetch?: FetchAPI;
middleware?: Middleware[];
agent?: Dispatcher;
headers?: HTTPHeaders;
timeoutDuration?: number;
retry?: RetryConfiguration;
}

Index

Properties

baseUrlparseErrorfetch?middleware?agent?headers?timeoutDuration?retry?

Properties

baseUrl

baseUrl: string

parseError

parseError: (response: Response) => Promise<Error>

Optionalfetch

fetch?: FetchAPI

Provide your own fetch implementation.

Optionalmiddleware

middleware?: Middleware[]

Provide a middleware that will run either before the request, after the request or when the request fails.

Optionalagent

agent?: Dispatcher

Pass your own http agent to support proxies.

Optionalheaders

headers?: HTTPHeaders

Custom headers that will be added to every request.

OptionaltimeoutDuration

timeoutDuration?: number

Timeout in ms before aborting the request (default 10,000)

Optionalretry

retry?: RetryConfiguration

Retry configuration.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties baseUrlparseErrorfetchmiddlewareagentheaderstimeoutDurationretry