Interface TokenStore

Pluggable token persistence interface.

The SDK ships an InMemoryTokenStore by default. Adopters can implement this contract to back tokens by browser localStorage, an on-disk file, a secret manager, etc.

The SDK calls load once per session-startup to seed a cached token (if any), save after every successful authenticate() / refresh, and clear when the session is explicitly invalidated.

interface TokenStore {
    clear(): void | Promise<void>;
    load(): AuthTokenResponse | Promise<AuthTokenResponse | null> | null;
    save(token: AuthTokenResponse): void | Promise<void>;
}

Implemented by

InMemoryTokenStore

Index

Methods

clear load save

Methods

clear

clear(): void | Promise<void>
Drop any persisted token.

Returns void | Promise<void>
- Defined in src/auth/tokenStore.ts:20

load

load(): AuthTokenResponse | Promise<AuthTokenResponse | null> | null
Return the previously persisted token, or null if none.

Returns AuthTokenResponse | Promise<AuthTokenResponse | null> | null
- Defined in src/auth/tokenStore.ts:16

save

save(token: AuthTokenResponse): void | Promise<void>
Persist the token returned by POST /v1/auth/token.
Parameters
- token: AuthTokenResponse
Returns void | Promise<void>
- Defined in src/auth/tokenStore.ts:18

Interface TokenStore

Implemented by

Index

Methods

Methods

clear

Returns void | Promise<void>

load

Returns AuthTokenResponse | Promise<AuthTokenResponse | null> | null

save

Parameters

Returns void | Promise<void>

Settings

On This Page