Valibot - Effortless type safety and validation

Unlock the power of TypeScript with Valibot, the open-source schema library designed to enhance developer experience through type safety and a small bundle size. Validating your data has never been easier!

How It Works

Valibot operates by leveraging the robust type system inherent in TypeScript. This library allows developers to define schemas that represent the structure of data they expect. When data is validated against these schemas, Valibot processes the incoming data, checks it against the defined types, and ensures that all properties conform to specified types. This leads to less runtime errors and enhances application reliability. The functionality can be broken down into the following key components:

• Type Safety: Guarantees that data adheres strictly to the defined types.
• Static Type Inference: Automatically infers types based on provided schemas, reducing boilerplate code.
• Modular Design: Keeps the bundle size low while allowing custom imports of necessary modules.
• Validation: Validates various TypeScript types, including primitive values and complex structures.
• Test Coverage: Ensures that all functionalities are thoroughly tested and reliable for production use.
• Built-in Helpers: Offers various utility functions for common tasks, improving efficiency while coding.

Usage

Getting started with Valibot is straightforward. Begin by installing the library using npm or yarn. In your TypeScript project, run the following command:

npm install valibot

Once installed, import Valibot in your TypeScript files to start defining your type schemas. Here's a simple example to illustrate how you can use Valibot:

import { createValidator } from 'valibot';

// Define your schema
type User = { name: string; age: number; };

const userSchema = createValidator<User>();

// Validate data against the schema
const userData = { name: 'John Doe', age: 30 };
const isValid = userSchema.validate(userData);

if (isValid) {
  console.log('Valid user data!');
} else {
  console.log('Invalid user data!');
}

This code snippet demonstrates how easily you can define a schema for a User type and validate data against it. By utilizing Valibot, developers can ensure their application's data is consistently structured, reducing runtime errors and enhancing maintainability.

Lastly, don’t forget to visit the Playground to experiment with Valibot in a hands-on environment where you can test different schemas and validations.

Web Application Development

Valibot can be leveraged in developing web applications to ensure data integrity, especially in user input forms.

API Data Validation

Valibot can validate incoming data to RESTful APIs, ensuring that the data conforms to expected structures before processing.

Complex State Management

Use Valibot to manage complex state structures in libraries like Redux, allowing for strict type checks.

Testing and Prototyping

Use Valibot in testing environments to quickly prototype and validate different data schemas.

Library and Framework Integration

Integrate Valibot within other JavaScript libraries or frameworks to enhance their type safety.

Data Transformation

Leverage built-in helpers to transform and validate data structures efficiently.

Features

• Fully Type Safe: Enjoy the benefits of type safety and static type inference in TypeScript.
• Small Bundle Size: Due to the modular design of our API, the bundle size starts at less than 700 bytes.
• Validate Everything: Supports almost any TypeScript type from primitive values to complex objects.
• 100% Test Coverage: Valibot's source code is open source and fully tested with 100% coverage.
• Helpers Included: Important validation and transformation helpers are already included.
• API with Great DX: Minimal, readable, and well thought out API for a great developer experience.

FAQ

1. What is Valibot?

Valibot is an open-source schema library for TypeScript that focuses on type safety, a small bundle size, and enhancing developer experience.

2. Is Valibot free to use?

Yes, Valibot is available free of charge and licensed under the MIT License.

3. How does Valibot ensure type safety?

Valibot leverages TypeScript's robust type system to define schemas and validate data against them.

4. What types of data can Valibot validate?

Valibot supports various TypeScript types, including primitive values, arrays, and complex objects.

5. What is the bundle size of Valibot?

Due to its modular design, the bundle size of Valibot starts at less than 700 bytes.

6. How can I install Valibot?

You can install Valibot using npm by running 'npm install valibot' in your project.

7. What is the testing coverage of Valibot?

Valibot boasts 100% test coverage, ensuring a reliable and robust source code.

8. Does Valibot provide any helpers for validation?

Yes, Valibot includes important validation and transformation helpers to facilitate common tasks.