Interface SessionServiceInitializer

interface SessionServiceInitializer {
    customHeaders?: Record<string, string | string[]>;
    logger?: Logger;
    onApiError?: ((error, request, attempts) => Promise<boolean>);
    onApiResponse?: ((response) => void);
    onRefreshFailure?: ((error) => void);
    onSessionStateUpdate?: ((state) => void);
}

Properties

customHeaders? logger? onApiError? onApiResponse? onRefreshFailure? onSessionStateUpdate?

Properties

Optional customHeaders

customHeaders?: Record<string, string | string[]>

Custom headers that can be passed with axios requests

Optional logger

logger?: Logger

Logger service

Optional onApiError

onApiError?: ((error, request, attempts) => Promise<boolean>)

Type declaration

    • (error, request, attempts): Promise<boolean>

    • Callback when an api error occurs (useful for logging). Return boolean to retry refresh token.

      Parameters

      • error: NBError
      • request: AxiosRequestConfig<any>
      • attempts: number

      Returns Promise<boolean>

Optional onApiResponse

onApiResponse?: ((response) => void)

Type declaration

    • (response): void

    • Callback when an api request returns (usually for testing))

      Parameters

      • response: AxiosResponse<any, any>

      Returns void

Optional onRefreshFailure

onRefreshFailure?: ((error) => void)

Type declaration

    • (error): void

    • Callback when refresh fails (session has expired)

      Parameters

      Returns void

Optional onSessionStateUpdate

onSessionStateUpdate?: ((state) => void)

Type declaration

    • (state): void

    • Callback when the session changes state (e.g. after a refresh)

      Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc