`Clerk` class

The Clerk class is the main entrypoint class for the @clerk/clerk-js package. It contains a number of methods and properties for interacting with the Clerk API.

Properties

Name
client
Type
Client
Description
The Client object for the current window.
Name
domain
Type
string
Description
The current Clerk app's domain. Prefixed with clerk. on production if not already prefixed. Returns "" when ran on the server.
Name
instanceType
Type
'production' | 'development'
Description
Indicates if the Clerk instance is running in production or development mode.
Name
isSatellite
Type
boolean
Description
A boolean that indicates if the instance is a satellite app.
Name
isSignedIn
Type
boolean
Description
A boolean that indicates if the user is signed in.
Name
loaded
Type
boolean
Description
A boolean that indicates if the Clerk object is ready for use. Set to false when the status is 'loading' or 'error'. Set to true when the status is either 'ready' or 'degraded'.
Name
organization
Type
Organization | null | undefined
Description
A shortcut to the last active Session.user.organizationMemberships which holds an instance of a Organization object. If the session is null or undefined, the user field will match.
Name
proxyUrl
Type
string
Description
Your Clerk app's proxy URL. Required for applications that run behind a reverse proxy. Can be either a relative path (/__clerk) or a full URL (https://<your-domain>/__clerk).
Name
publishableKey
Type
string | undefined
Description
The Clerk Publishable Key for your instance. This can be found on the API keys page in the Clerk Dashboard.
Name
sdkMetadata
Type
{ name: string; version: string; environment: string }
Description
Contains information about the SDK that the host application is using. You don't need to set this value yourself unless you're developing an SDK.
Name
session
Type
Session | null | undefined
Description
The currently active Session, which is guaranteed to be one of the sessions in Client.sessions. If there is no active session, this field will be null. If the session is loading, this field will be undefined.
Name
status
Type
'degraded' | 'error' | 'loading' | 'ready'
Description
The status of the Clerk instance. Possible values are:

'degraded': Set when Clerk is partially operational.

'error': Set when hotloading clerk-js failed or Clerk.load() failed.

'loading': Set during initialization.

'ready': Set when Clerk is fully operational.
Name
telemetry?
Type
{ disabled: boolean, debug: boolean }
Description
Telemetry configuration.
Name
user
Type
User | null | undefined
Description
A shortcut to Session.user which holds the currently active User object. If the session is null or undefined, the user field will match.
Name
version
Type
string
Description
The Clerk SDK version.

Registers a listener that triggers a callback whenever a change in the Client, Session, or User object occurs. This method is primarily used to build frontend SDKs like @clerk/clerk-react. Returns an UnsubscribeCallback function that can be used to remove the listener from the Clerk object.

function addListener(listener: (emission: Resources) => void): UnsubscribeCallback

`Resources`

Name
client
Type
Client
Description
Name
session
Type
Session | null | undefined
Description
Name
user
Type
User | null | undefined
Description
Name
organization
Type
Organization | null | undefined
Description
Name
lastOrganizationInvitation
Type
OrganizationInvitation | null | undefined
Description
Name
lastOrganizationMember
Type
OrganizationMembership | null | undefined
Description

Note

Note the following about User and Session:

When there is an active session, user === session.user.
When there is no active session, User and Session will both be null.

`authenticateWithMetamask()`

function authenticateWithMetamask({
  redirectUrl,
  signUpContinueUrl,
  customNavigate,
}?: AuthenticateWithMetamaskParams): Promise<void>

`AuthenticateWithMetamaskParams`

Name
redirectUrl?
Type
string | undefined
Description
The full URL or path to navigate to after a successful sign-in or sign-up.
Name
signUpContinueUrl?
Type
string | undefined
Description
The URL to navigate to if the sign-up process is missing user information.
Name
customNavigate?
Type
((to: string) => Promise<unknown> | unknown) | undefined
Description
A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.

`authenticateWithCoinbaseWallet()`

function authenticateWithCoinbaseWallet({
  redirectUrl,
  signUpContinueUrl,
  customNavigate,
}?: AuthenticateWithCoinbaseWalletParams): Promise<void>

`AuthenticateWithCoinbaseWalletParams`

Name
redirectUrl?
Type
string | undefined
Description
The full URL or path to navigate to after a successful sign-in or sign-up.
Name
signUpContinueUrl?
Type
string | undefined
Description
The full URL or path to navigate to if the sign-up process is missing user information.
Name
customNavigate?
Type
((to: string) => Promise<unknown> | unknown) | undefined
Description
A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.

`authenticateWithOKXWallet()`

Starts a sign-in flow that uses the OKX Wallet to authenticate the user using their Web3 wallet address.

function authenticateWithOKXWallet(props?: AuthenticateWithOKXWalletParams): Promise<void>

`AuthenticateWithOKXWalletParams`

Name
redirectUrl?
Type
string | undefined
Description
The full URL or path to navigate to after a successful sign-in or sign-up.
Name
signUpContinueUrl?
Type
string | undefined
Description
The full URL or path to navigate to if the sign-up process is missing user information.
Name
customNavigate?
Type
((to: string) => Promise<unknown> | unknown) | undefined
Description
A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.
Name
unsafeMetadata?
Type
SignUpUnsafeMetadata
Description
Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object.
Name
legalAccepted?
Type
boolean
Description
A boolean indicating whether the user has agreed to the legal compliance documents.

`authenticateWithBase()`

Starts a sign-in flow that uses Base to authenticate the user using their Web3 wallet address.

function authenticateWithBase(props?: AuthenticateWithBaseParams): Promise<void>

`AuthenticateWithBaseParams`

Name
redirectUrl?
Type
string | undefined
Description
The full URL or path to navigate to after a successful sign-in or sign-up.
Name
signUpContinueUrl?
Type
string | undefined
Description
The full URL or path to navigate to if the sign-up process is missing user information.
Name
customNavigate?
Type
((to: string) => Promise<unknown> | unknown) | undefined
Description
A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.
Name
unsafeMetadata?
Type
SignUpUnsafeMetadata
Description
Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object.
Name
legalAccepted?
Type
boolean
Description
A boolean indicating whether the user has agreed to the legal compliance documents.

`authenticateWithWeb3()`

function authenticateWithWeb3({
  redirectUrl,
  signUpContinueUrl,
  customNavigate,
  strategy,
}: ClerkAuthenticateWithWeb3Params): Promise<void>

`ClerkAuthenticateWithWeb3Params`

Name
redirectUrl?
Type
string | undefined
Description
The full URL or path to navigate to after a successful sign in or sign up.
Name
signUpContinueUrl?
Type
string | undefined
Description
The full URL or path to navigate to if the sign-up process is missing user information.
Name
customNavigate?
Type
((to: string) => Promise<unknown> | unknown) | undefined
Description
A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.
Name
strategy
Type
Web3Strategy
Description
The Web3 verification strategy.

`buildCreateOrganizationUrl()`

Returns the configured URL where <CreateOrganization /> is mounted or a custom create-organization page is rendered.

function buildCreateOrganizationUrl(): string

Clerk class

Feedback

`Clerk` class