Redirect methods

These methods on the Clerk class help you manage route navigation based on the Clerk dashboard configuration.

`navigate()`

function navigate(to: string | undefined): Promise<unknown>;

Helper method which will use the custom push navigation function of your application to navigate to the provided URL or relative path. See the relevant section on routing for more information on navigation.

Properties

Name
to
Type
string | undefined
Description
The route to navigate to.

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

`redirectWithAuth()`

function redirectWithAuth(to: string): Promise<unknown>;

Redirects to the provided url after decorating it with the auth token for development instances.

Properties

Name
to
Type
string | undefined
Description
The route to navigate to

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

function redirectToSignIn(options?: SignInRedirectOptions): Promise<unknown>;

Redirects to the sign-in URL, as configured in your application's instance settings. This method uses the navigate() method under the hood.

Properties

Name
options?
Type
SignInRedirectOptions | undefined
Description
Options to use in the redirect

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

function redirectToSignUp(options?: SignUpRedirectOptions): Promise<unknown>;

Redirects to the sign-up URL, as configured in your application's instance settings. This method uses the navigate() method under the hood.

Properties

Name
options?
Type
SignUpRedirectOptions | undefined
Description
Options to use in the redirect

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

`redirectToUserProfile()`

function redirectToUserProfile(): Promise<unknown>;

Redirects to the user profile management URL, as configured in your application's instance settings. This method uses the navigate() method under the hood.

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

`redirectToCreateOrganization()`

function redirectToCreateOrganization(): Promise<unknown>;

Redirects to the configured URL where <CreateOrganization /> is mounted. This method uses the navigate() method under the hood.

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

`redirectToOrganizationProfile()`

function redirectToOrganizationProfile(): Promise<unknown>;

Redirects to the configured URL where <OrganizationProfile /> is mounted. This method uses the navigate() method under the hood.

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

`redirectToHome()` (deprecated)

Warning

Clerk.redirectToHome() is deprecated and will be removed in the Core 2 version of Clerk.

function redirectToHome(): Promise<unknown>;

Redirects to your app's homepage, as configured in your application's instance settings. This method uses the navigate() method under the hood.

Returns

Type	Description
`Promise<unknown>`	A promise that can be `await`ed in order to listen for the navigation to finish. The inner value should not be relied on, as it can change based on the framework it's used within.

Edit this page on GitHub

Last updated on Aug 20, 2024

Redirect methods

Feedback