clearNuxtState v3.6

Delete the cached state of useState.
This method is useful if you want to invalidate the state of useState. You can also reset the state to its initial value by passing { reset: true } as the second parameter.

Type

Signature
export function clearNuxtState (keys?: string | string[] | ((key: string) => boolean), opts?: ClearNuxtStateOptions): void

Parameters

  • keys: One or an array of keys that are used in useState to delete their cached state. If no keys are provided, all state will be invalidated.
  • opts: An options object to configure the clear behavior.

    • reset v4.4: When set to true, resets the state to the initial value provided by the init function of useState instead of setting it to undefined. An init function provided by a component is only used while that component is mounted; one provided by a plugin or route middleware is kept for the lifetime of the app. If no init function is available, the state is set to undefined instead. When not specified, defaults to the value of experimental.defaults.useState.resetOnClear in your Nuxt config (which defaults to true).