Interface UseSessionResult

Result of the useSession hook.

interface UseSessionResult {
    session: null | Session;
    isLoaded: boolean;
    error: null | string;
    isExpired: boolean;
    renew: (() => void);
}

Properties

session isLoaded error isExpired renew

Properties

session

session: null | Session

The active session, or null if no handle or session creation failed.

isLoaded

isLoaded: boolean

Whether the session (or its absence) has been determined.

error

error: null | string

Error string if session creation or renewal failed.

isExpired

isExpired: boolean

Whether the current session has expired.

renew

renew: (() => void)

Manually renew the session (creates a new one with a fresh jti).

Settings

Member Visibility

On This Page

Properties