IHttpOpts

Defined in: src/http-api/interface.ts:50

Options object for FetchHttpApi and DigitalWorldHttpApi.

Properties

accessToken?

optional accessToken?: string

Defined in: src/http-api/interface.ts:58

baseUrl

baseUrl: string

Defined in: src/http-api/interface.ts:53

extraParams?

optional extraParams?: QueryDict

Defined in: src/http-api/interface.ts:56

fetchFn?

optional fetchFn?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: src/http-api/interface.ts:51

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

idBaseUrl?

optional idBaseUrl?: string

Defined in: src/http-api/interface.ts:54

localTimeoutMs?

optional localTimeoutMs?: number

Defined in: src/http-api/interface.ts:78

logger?

optional logger?: Logger

Defined in: src/http-api/interface.ts:81

Optional logger instance. If provided, requests and responses will be logged.

onlyData?

optional onlyData?: boolean

Defined in: src/http-api/interface.ts:76

For historical reasons, must be set to true. Will eventually be removed.

prefix

prefix: string

Defined in: src/http-api/interface.ts:55

refreshToken?

optional refreshToken?: string

Defined in: src/http-api/interface.ts:62

Used in conjunction with tokenRefreshFunction to attempt token refresh

tokenRefreshFunction?

optional tokenRefreshFunction?: TokenRefreshFunction

Defined in: src/http-api/interface.ts:67

Function to attempt token refresh when a possibly expired token is encountered Optional, only called when a refreshToken is present

useAuthorizationHeader?

optional useAuthorizationHeader?: boolean

Defined in: src/http-api/interface.ts:73

Whether to use the HTTP Authorization header over the access_token query parameter