live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/auth-client


@orangecheck/auth-client / OcSessionState

Interface: OcSessionState

Defined in: src/types.ts:31

Properties

PropertyTypeDescriptionDefined in
<a id="property-account"></a> accountOcAccount | null-src/types.ts:33
<a id="property-error"></a> errorError | nullnull while loading; an Error instance when status === 'error'.src/types.ts:35
<a id="property-refresh"></a> refresh() => Promise&lt;void>Re-fetch the session. Useful after sign-in/sign-out happens elsewhere.src/types.ts:37
<a id="property-signinurl"></a> signInUrlstringURL to navigate to for sign-in on the auth host.src/types.ts:41
<a id="property-signout"></a> signOut() => Promise&lt;void>Trigger a sign-out. Resolves once the cookie has been cleared.src/types.ts:39
<a id="property-status"></a> statusOcSessionStatus-src/types.ts:32