mmyoji / object-validator.js

Zero dependency, simple JS object validator library

object-validator

This is a learn-to-code repo. Production use is not recommended.

If you need a practical validation library, use Yup or Zod instead.

Breaking changes are often added during v0.

Installation

$ npm install @mmyoji/object-validator

Usage

import { initValidator } from "@mmyoji/object-validator";

type TargetObject = {
  name: string;
  age: number;
  isAdmin?: boolean;
};

const validate = initValidator<TargetObject>({
  name: {
    type: "string",
    required: true,
    minLength: 3,
  },
  age: {
    type: "number",
    required: true,
    min: 18,
    max: 65,
  },
  isAdmin: {
    type: "boolean",
  },
});

const errors = validate({
  name: "a",
  count: 22,
  isAdmin: true,
});
console.log(errors);
//=> [{key:"name",message:"name is too short. It must be 3 length at least."}]