Data Passthrough Filter 2.2.0

Basic usage

import { validate } from 'data-passthroug-filter';

// Incoming data (data can be object or array of objects)
const data = {
  email: '[email protected]',
  password: 123,
};

// Global options
const options = { overflow: false };

// Instance returns the data set with our schema and options
const val = validate(data, (e) => {
  email: e().string().required(),
  password: e().number().required(),
}, options);

Schema

We create the schema on the second argument, and it returns the schema functions we can use by chaining them like this e().number().require().

| Parameter | value | default | Description | | ------------ | ---------------------------------------------------- | ------- | ---------------------------------------- | | type() | string, number, boolean, object, array | none | Set for a specific type | | nullable() | boolean | true | nullable applied (NaN included) | | length() | { min: number, max: number } or array [min, max] | none | set a min and/or max length of the value | | required() | boolean | true | require key |

Options

Additional options for validating your data

| Parameter | value | default | Description | | ----------- | --------- | ------- | --------------------------------------- | | requiredAll | boolean | false | All the schema keys are required | | overflow | boolean | true | Only returns data that is in the schema |

Errors

It will throw errors when it fails to validate (Pretty straight forward)

example: [ { key: 'password', reason: 'password is required'}]

About

If you have any questions, You can contact me on:

Twitter: @TwanLuttik