Interface IHttpOpts

interface IHttpOpts {
    accessToken?: string;
    baseUrl: string;
    extraParams?: Record<string, string>;
    fetchFn?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    idBaseUrl?: string;
    localTimeoutMs?: number;
    logger?: Logger;
    onlyData?: boolean;
    prefix: string;
    refreshToken?: string;
    tokenRefreshFunction?: TokenRefreshFunction;
    useAuthorizationHeader?: boolean;
}

Properties

accessToken? baseUrl extraParams? fetchFn? idBaseUrl? localTimeoutMs? logger? onlyData? prefix refreshToken? tokenRefreshFunction? useAuthorizationHeader?

Properties

Optional accessToken

accessToken?: string

baseUrl

baseUrl: string

Optional extraParams

extraParams?: Record<string, string>

Optional fetchFn

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

Type declaration

Optional idBaseUrl

idBaseUrl?: string

Optional localTimeoutMs

localTimeoutMs?: number

Optional logger

logger?: Logger

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

Optional onlyData

onlyData?: boolean

prefix

prefix: string

Optional refreshToken

refreshToken?: string

Used in conjunction with tokenRefreshFunction to attempt token refresh

Optional tokenRefreshFunction

tokenRefreshFunction?: TokenRefreshFunction

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

Optional useAuthorizationHeader

useAuthorizationHeader?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc