Valibot

The modular and type safe schema library for validating structural data

SchemaValidation
fabian-hiller/valibotvalibot.devvalibot

README

Valibot Logo

Valibot


Hello, I am Valibot and I would like to help you validate data easily using a schema. No matter if it is incoming data on a server, a form or even configuration files. I have no dependencies and can run in any JavaScript environment.

I highly recommend you read the announcement post.


Highlights


- Fully type safe with static type inference
- Small bundle size starting at less than 300 bytes
- Validate everything from strings to complex objects
- Open source and fully tested with 100 % coverage
- Many transformation and validation helpers included
- Well structured source code without dependencies
- Minimal, readable and well thought out API

Example


First you create a schema. A schema can be compared to a type definition in TypeScript. The big difference is that TypeScript types are "not executed" and are more or less a DX feature. A schema on the other hand, apart from the inferred type definition, can also be executed at runtime to guarantee type safety of unknown data.

  1. ```ts
  2. import { email, minLength, object, type Output, parse, string } from 'valibot';

  4. // Create login schema with email and password
  5. const LoginSchema = object({
  6.   email: string([email()]),
  7.   password: string([minLength(8)]),
  8. });

  10. // Infer output TypeScript type of login schema
  11. type LoginData = Output<typeof LoginSchema>; // { email: string; password: string }

  13. // Throws error for `email` and `password`
  14. parse(LoginSchema, { email: '', password: '' });

  16. // Returns data as { email: string; password: string }
  17. parse(LoginSchema, { email: 'jane@example.com', password: '12345678' });
  18. ```

Comparison


Instead of relying on a few large functions with many methods, my API design and source code is based on many small and independent functions, each with just a single task. This modular design has several advantages.

For example, this allows a bundler to use the import statements to remove code that is not needed. This way, only the code that is actually used gets into your production build. This can reduce the bundle size by up to 98 % compared to Zod.

Besides the individual bundle size, the overall size of the library is also significantly smaller. This is due to the fact that my source code is simpler in structure, less complicated and optimized for compression.

Credits


My friend Fabian created me as part of his bachelor thesis at Stuttgart Media University, supervised by Walter Kriha, Miško Hevery and Ryan Carniato. My role models also include Colin McDonnell, who had a big influence on my API design with Zod.

Feedback


Find a bug or have an idea how to improve my code? Please fill out an issue. Together we can make the library even better!

License


I am completely free and licensed under the MIT license. But if you like, you can feed me with a star on GitHub.