Validation features
Nuxt Ignis offers two alternatives for schema validation:
Zod
Zod is a TypeScript-first schema declaration and validation library that allows you to define schemas for your data and validate them at runtime. It provides a simple and intuitive API for defining schemas and validating data against them.
Zod integration is disabled by default. To enable it, you can use following environment variable:
NUXT_PUBLIC_IGNIS_ZOD=trueNUXT_PUBLIC_IGNIS_PRESET_VALIDATION=zodUsage notice
In order to use zod in Nuxt Ignis conditionally, we wrapped its import into a composable. In order to use it, you need to import it in a file like this:
const z = (await useZod())!You can then use z object as you would normally do in your project.
NOTE: We are using await here, because the import is dynamic at runtime. And because the composable may technically return undefined (only if the relevant setting is not enabled), we add exclamation mark to avoid TS complaints.
Valibot
Valibot is a TypeScript-first schema validation library that allows you to define schemas for your data and validate them at runtime. It provides a simple and intuitive API for defining schemas and validating data against them.
Valibot integration is disabled by default. To enable it, you can use following environment variable:
NUXT_PUBLIC_IGNIS_VALIBOT=trueNUXT_PUBLIC_IGNIS_PRESET_VALIDATION=valibotUsage notice
In order to use valibot in Nuxt Ignis conditionally, we wrapped its import into a composable. In order to use it, you need to import it in a file like this:
const v = (await useValibot())!You can then use v object as you would normally do in your project.
NOTE: We are using await here, because the import is dynamic at runtime. And because the composable may technically return undefined (only if the relevant setting is not enabled), we add exclamation mark to avoid TS complaints.