Interface SessionService

A service which handles session management for a front-end application

interface SessionService {
    getLogger(): undefined | Logger;
    getRequestHeaders(options?): Record<string, undefined | null | string | string[]>;
    getSessionState(): SessionState;
    initialize(opts): Promise<boolean>;
    performDelete<T>(url, options?): Promise<T>;
    performGet<T>(url, options?): Promise<T>;
    performPatch<T, U>(url, body, options?): Promise<T>;
    performPost<T, U>(url, body, options?): Promise<T>;
    updateOpts(opts): void;
    updateSessionState(sessionState): void;
}

Implemented by

Methods

getLogger getRequestHeaders getSessionState initialize performDelete performGet performPatch performPost updateOpts updateSessionState

Methods

getLogger

getRequestHeaders

  • getRequestHeaders(options?): Record<string, undefined | null | string | string[]>

  • Return the request headers that would normally be used with an axios request Useful if you need to make a request via a different method and just need the headers

    Parameters

    Returns Record<string, undefined | null | string | string[]>

getSessionState

initialize

  • initialize(opts): Promise<boolean>

  • Initializes this service with the given options.

    • Load information from local storage if needed
    • For cookie service, will perform a reauth
    • Sets up fingerprint if not present

    Parameters

    Returns Promise<boolean>

performDelete

  • performDelete<T>(url, options?): Promise<T>

  • Perform a delete request to the specified url Will append any headers or other info needed for auth

    Type Parameters

    • T

    Parameters

    Returns Promise<T>

performGet

  • performGet<T>(url, options?): Promise<T>

  • Perform a get request to the specified url Will append any headers or other info needed for auth

    Type Parameters

    • T

    Parameters

    Returns Promise<T>

performPatch

  • performPatch<T, U>(url, body, options?): Promise<T>

  • Perform a patch request to the specified url Will append any headers or other info needed for auth

    Type Parameters

    • T

    • U extends object

    Parameters

    Returns Promise<T>

performPost

  • performPost<T, U>(url, body, options?): Promise<T>

  • Perform a post request to the specified url Will append any headers or other info needed for auth

    Type Parameters

    • T

    • U extends object

    Parameters

    Returns Promise<T>

updateOpts

updateSessionState

  • updateSessionState(sessionState): void

  • Update the session state with the given data.

    If a userId is provided, the session will be set as logged in (or logged out if null). Call after a successful login or refresh.

    Otherwise, this can be used to update tenantId and other session-based variables

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc