doormanjs-validator v0.0.5

DoormanJS Validator

DoormanJS is a Javascript library for dealing with object validations written in Typescript using a simple schema object. It keeps those #$% Bastards out. It currently only supports the following types:

• Array
• String
• Date
• Object
• Number

Currently it does not support sub-objects or array values.

Installation

Use the package manager NPM or Yarn

npm install doormanjs-validator

yarn add doormanjs-validator

Usage

// es5
const { validate } = require('doormanjs-validator');

// ESM Module
import { validate } from 'doormanjs-validator';

const target = {
  name: 'Jimmys drinks',
  address: 'Somewhere over the rainbow',
  drinks: {
    beer: ['Straffe Hendrik', 'Rochefort', 'St Bernard'],
  },
};

const schema = {
  name: 'string',
  address: 'string',
  drinks: 'object',
};

const options = {
  extraValuesAllowed: false, // by default false
  missingValuesAllowed: false, // by default false
};

try {
  validate({ target, schema, options }); // returns true
} catch (error) {
  /* 
    It will throw a Error on Invalid Schema or Target.
    Or on failed validation error.message gives a hint.
  */
  console.error(error.message);
  // Example: The value: 'Arie' is not an Object
}

Unit testing

Unit testing is done through JEST and can be executed through:

yarn run test

npm run test

Forking

After forking the project simply run

yarn
// or
npm i

to install all dependencies. In the src directory you will find all the Typescript source files.

Build

The JS code can be found in mimified condition in dist folder in ESM, CommonJS and IIFE formats. Packaging is done through RollupJS.

yarn run build

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT