DocsAPIUtils

clearError

The clearError composable clears all handled errors.

clearError

Within your pages, components, and plugins, you can use clearError to clear all errors and redirect the user.

Parameters:

  • options?: { redirect?: string }

You can provide an optional path to redirect to (for example, if you want to navigate to a 'safe' page).

// Without redirectclearError()// With redirectclearError({ redirect: '/homepage' })

Errors are set in state using useError(). The clearError composable will reset this state and calls the app:error:cleared hook with the provided options.

Read more in Docs > Getting Started > Error Handling.