Skip to main content

foundation-comms.tryrefreshsession

Home > @genesislcap/foundation-comms > tryRefreshSession

tryRefreshSession() function​

Attempts to refresh the session when authentication has expired. Uses a localStorage-based lock mechanism to prevent multiple tabs from trying to reauthenticate simultaneously.

Signature:

export declare function tryRefreshSession(options?: {
    reloadOnFailure?: boolean;
}): Promise<SessionRefreshResult>;

Parameters​

Parameter

Type

Description

options

{ reloadOnFailure?: boolean; }

(Optional) Optional configuration

Returns:

Promise<SessionRefreshResult>

The result of the refresh attempt