maccabee v0.1.0

Maccabee

Maccabee is a validation library for Javascript

Install

yarn add maccabee

or

npm i maccabee -S

How to use

Using Maccabee validatorFactory & built in validators

  const {
    validatorFactory,
    validators: {
      values: { isString, isBoolean, isNumber },
      general: { nullable },
    },
  } = require('maccabee');

  const userCreateValidation = validatorFactory({
    check: {
      id: [isString].map(nullable),
      firstName: [isString],
      lastName: [isString],
      age: [isNumber].map(nullable),
      admin: [isBoolean],
    },
  });

  const validUser = {
    firstName: 'John',
    lastName: 'McValidUser',
    admin: true,
  };

  const invalidUser = {
    firstName: 'Invalid',
    lastName: 'Invalidface',
    admin: 'false',
    age: 'a literal ferry',
  };

  try {
    const res = await userCreateValidation(validUser, {});
    console.log(JSON.stringify(res, null, 2));
    /*
    {
      "firstName": "John",
      "lastName": "McValidface",
      "admin": true
    }
    */
  } catch (ex) {
    console.log(JSON.stringify(ex, null, 2));
  }

  try {
    const res = await userCreateValidation(invalidUser, {});
    console.log(JSON.stringify(res, null, 2));
  } catch (ex) {
    console.log(JSON.stringify(ex, null, 2));
    /*
    {
      "name": "ValidationError",
      "data": {
        "age": [
          {
            "expected": "a number",
            "received": "not a number",
            "key": "age"
          }
        ],
        "admin": [
          {
            "expected": "to be a bool",
            "received": "false",
            "key": "admin"
          }
        ]
      }
    }
    */
  }