Interface IHttpOpts

interface IHttpOpts {
    accessToken?: string;
    baseUrl: string;
    extraParams?: Record<string, string>;
    fetchFn?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): 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

OptionalaccessToken

accessToken?: string

baseUrl

baseUrl: string

OptionalextraParams

extraParams?: Record<string, string>

OptionalfetchFn

fetchFn?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

Type declaration

OptionalidBaseUrl

idBaseUrl?: string

OptionallocalTimeoutMs

localTimeoutMs?: number

Optionallogger

logger?: Logger

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

OptionalonlyData

onlyData?: boolean

prefix

prefix: string

OptionalrefreshToken

refreshToken?: string

Used in conjunction with tokenRefreshFunction to attempt token refresh

OptionaltokenRefreshFunction

tokenRefreshFunction?: TokenRefreshFunction

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

OptionaluseAuthorizationHeader

useAuthorizationHeader?: boolean

Settings

Member Visibility

On This Page

Properties