ClerkError
Type used for all errors generated by the Clerk SDK. Additional error types such as ClerkAPIResponseError and ClerkRuntimeError are instances of ClerkError.
- Name
message- Type
string- Description
A message that describes the error. This is typically intented to be showed to the developers. It should not be shown to the user or parsed directly as the message contents are not guaranteed to be stable - use the
codeproperty instead.
- Name
code- Type
string- Description
A machine-stable code that identifies the error.
- Name
longMessage?- Type
string- Description
A user-friendly message that describes the error and can be displayed to the user. This message defaults to English but can be usually translated to the user's language by matching the
codeproperty to a localized message.
- Name
cause?- Type
Error- Description
The cause of the error, typically an
Errorinstance that was caught and wrapped by the Clerk error handler.
- Name
docsUrl?- Type
string- Description
A URL to the documentation for the error.
Feedback
Last updated on