schema

TypeScript ready object schema validation

Table of Content

Getting Started
Versioning
Authors
License
Support

Getting Started

Installation

NPM:

npm i @foxify/schema

Yarn:

yarn add @foxify/schema

Github Packages:

npm i @foxifyjs/schema

Usage

import Schema from "@foxify/schema";

const schema = {
  username: Schema.string()
    .alphanum()
    .required(),
  name: Schema.object().keys({
    first: Schema.string()
      .min(3)
      .required(),
    last: Schema.string().min(3),
  }).required(),
  datetime: Schema.date().default(Date.now),
};

try {
  const result = Schema.object().keys(schema).validate(value);
} catch (error) {
  // your error handler
}

for more details read the documents

Authors

Ardalan Amini - Core Maintainer - @ardalanamini

See also the list of contributors who participated in this project.

Versioning

We use SemVer for versioning. For the versions available, see the releases.

License

This project is licensed under the MIT License - see the LICENSE file for details

foxifyjs/schema