@nordic-ui/validathor

ValidaThor ⚡️

A simple validation library.

Documentation   •   npm   •   Issues   •   @Kosai106

Overview

ValidaThor is a lightweight library that allows you to validate your data using a schema-based approach. With its intuitive API, you can easily create complex validation rules to ensure the quality of your input data.

Features

• Define custom schema shapes using object, string, number, boolean, and date types
• Use modifiers (e.g., min, max, email, or even custom modifiers) to add constraints to your schema
• Validate input data against your defined schema

Getting Started

To use ValidaThor in your project, simply install the library with your favourite package manager:

npm install @nordic-ui/validathor
yarn add @nordic-ui/validathor
pnpm add @nordic-ui/validathor

Then, import the library and start defining your schemas and modifiers!

Example Usage

Here's a basic example of how you can use ValidaThor to validate some input data:

import {
  // Core
  parse,
  // Schemas
  object, string, number, boolean, date,
  // Modifiers
  min, max, email,
} from '@nordic-ui/validathor';

// Define your schema shape
const exampleSchema = object({
  name: string([min(2)]),
  age: number([min(13), max(100)]),
  email: string([email()]),
  avatar: object({
    path: string(),
    size: number(),
  }),
  acceptedTerms: boolean(),
  createdAt: date([
    min(new Date('2021/01/01')),
    max(new Date()),
  ]),
});

// If the input data matches the schema, nothing will happen,
// Otherwise an error will be thrown to help the user
try {
  parse(
    exampleSchema,
    {
      name: 'John Doe',
      age: 35,
      email: '[e-mail]',
      avatar: { path: 'https://placekeanu.com/200/200', size: 2048 },
      acceptedTerms: true,
      createdAt: new Date('01/08/2023'),
    }
  );
} catch (err) {
  // Do something with the error
};

Visit the documentation for more insights into the available schemas and modifiers.

---

License

ValidaThor is licensed under the MIT license.

Author

Made by Kevin Østerkilde

Inspiration

• Zod
• Valibot.