oidc-caep-client
    Preparing search index...

    Interface AccountManagerOptions

    interface AccountManagerOptions {
        broadcast?: boolean;
        loginHint?: (account: Account) => string | undefined;
        maxAccounts?: number;
        onActivate?: AccountHook;
        onDeactivate?: (account: Account) => void | Promise<void>;
        onLeave?: AccountHook;
        refreshSkewSec?: number;
        rememberSignedOutDays?: number;
        store?: TokenStore;
        storeKey?: string;
        tabStore?: TokenStore;
    }
    Index
    broadcast?: boolean

    Tell this origin's other tabs about changes (BroadcastChannel). Default true.

    loginHint?: (account: Account) => string | undefined

    What names an account to the OP in login_hint. Default: preferred_username, else email.

    maxAccounts?: number

    Default 10. Past it the account signed out longest ago is forgotten; when every place is held by a signed-in account, a further sign-in is refused.

    onActivate?: AccountHook

    Runs when an account is about to become this tab's active account, after its tokens are refreshed if due and before "activated" is emitted — e.g. to poll its CAEP stream and act on the signals queued while it was dormant. Throwing aborts the activation.

    onDeactivate?: (account: Account) => void | Promise<void>

    Runs when an account stops being this tab's active account (e.g. to stop polling its stream).

    onLeave?: AccountHook

    Runs before an account's tokens are deleted by signOut() or end() (e.g. to delete its CAEP stream while its tokens still work).

    refreshSkewSec?: number

    Default 60.

    rememberSignedOutDays?: number

    How long a signed-out account stays listed. Default 30.

    store?: TokenStore

    The cache shared by every tab: the account list and each account's tokens. Default: IndexedDB (IndexedDBTokenStore) when the client has a DPoP key, else memory. A persistent store without DPoP is allowed, with a console warning.

    storeKey?: string

    Default "accounts".

    tabStore?: TokenStore

    Where this tab remembers its active account. Default: sessionStorage where it exists, else memory.