Skip to content

AuthClientOptions

Defined in: packages/auth/src/client/AuthClient.ts:81

Configuration for AuthClient.

environment: AuthEnvironment

Defined in: packages/auth/src/client/AuthClient.ts:88

Runtime environment. The SDK resolves the underlying Account/Auth service URL from this — consumers do not need to know infra-level URLs. Use AuthEnvironment.Production for live traffic, AuthEnvironment.Development for the dev/staging tier.


optional fallbackExpiresInSeconds?: number

Defined in: packages/auth/src/client/AuthClient.ts:106

Fallback expiry seconds when the backend omits expires_in. Default 86_400 (24 hours).


optional getLanguage?: () => Awaitable<string | null | undefined>

Defined in: packages/auth/src/client/AuthClient.ts:94

Resolver for the user’s preferred language.

Awaitable<string | null | undefined>


optional getSigningSecret?: () => string | undefined

Defined in: packages/auth/src/client/AuthClient.ts:92

HMAC signing secret resolver, forwarded to the underlying RestClient.

string | undefined


optional logger?: Logger

Defined in: packages/auth/src/client/AuthClient.ts:108

Optional logger for non-throwing diagnostics.


optional onTokensChanged?: (tokens) => void

Defined in: packages/auth/src/client/AuthClient.ts:114

Invoked after tokens are persisted (login / refresh) or cleared (logout). Consumers wire this into their own state store (Zustand / Redux) or cross-tab broadcast.

AuthTokens | null

void


optional storage?: TokenStorageAdapter

Defined in: packages/auth/src/client/AuthClient.ts:101

Token storage adapter. Defaults to a fresh MemoryTokenStorageAdapter — suitable for tests and SSR. Web consumers should pass a cookie/localStorage-backed adapter, RN consumers an AsyncStorage/SecureStore-backed adapter.


optional timeout?: number

Defined in: packages/auth/src/client/AuthClient.ts:90

Per-request timeout in milliseconds. Default 10_000.