Code Monkey home page Code Monkey logo

schema-typed's Introduction

schema-typed

Schema for data modeling & validation

npm Travis

English | 中文版

Installation

npm install schema-typed --save

Usage

import { SchemaModel, StringType, DateType, NumberType } from 'schema-typed';

const userModel = SchemaModel({
  username: StringType().isRequired('Username required'),
  email: StringType().isEmail('Email required'),
  age: NumberType('Age should be a number').range(
    18,
    30,
    'Age should be between 18 and 30 years old'
  )
});

const checkResult = userModel.check({
  username: 'foobar',
  email: '[email protected]',
  age: 40
});

console.log(checkResult);

checkResult return structure is:

{
    username: { hasError: false },
    email: { hasError: false },
    age: { hasError: true, errorMessage: 'Age should be between 18 and 30 years old' }
}

Multiple verification

StringType()
  .minLength(6, "Can't be less than 6 characters")
  .maxLength(30, 'Cannot be greater than 30 characters')
  .isRequired('This field required');

Custom verification

Customize a rule with the addRule function.

If you are validating a string type of data, you can set a regular expression for custom validation by the pattern method.

const myModel = SchemaModel({
  field1: StringType().addRule((value, data) => {
    return /^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/.test(value);
  }, 'Please enter legal characters'),
  field2: StringType().pattern(/^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/, 'Please enter legal characters')
});

schema.check({ field1: '', field2: '' });

/**
{
  field1: {
    hasError: true,
    errorMessage: 'Please enter legal characters'
  },
  field2: {
    hasError: true,
    errorMessage: 'Please enter legal characters'
  }
};
**/

Custom verification - multi-field cross validation

eg: verify that the two passwords are the same.

const schema = SchemaModel({
  password1: StringType().isRequired('This field required'),
  password2: StringType().addRule((value, data) => {
    if (value !== data.password1) {
      return false;
    }
    return true;
  }, 'The passwords are inconsistent twice')
});

schema.check({ password1: '123456', password2: 'root' });

/**
{
  password1: { hasError: false },
  password2: {
    hasError: true,
    errorMessage: 'The passwords are inconsistent twice'
  }
};
**/

API

StringType

  • isRequired()
StringType().isRequired('This field required');
  • isEmail(errorMessage: string)
StringType().isEmail('Please input the correct email address');
  • isURL(errorMessage: string)
StringType().isURL('Please enter the correct URL address');
  • isOneOf(items: Array, errorMessage: string)
StringType().isOneOf(['Javascript', 'CSS'], 'Can only type `Javascript` and `CSS`');
  • containsLetter(errorMessage: string)
StringType().containsLetter('Must contain English characters');
  • containsUppercaseLetter(errorMessage: string)
StringType().containsUppercaseLetter('Must contain uppercase English characters');
  • containsLowercaseLetter(errorMessage: string)
StringType().containsLowercaseLetter('Must contain lowercase English characters');
  • containsLetterOnly(errorMessage: string)
StringType().containsLetterOnly('English characters that can only be included');
  • containsNumber(errorMessage: string)
StringType().containsNumber('Must contain numbers');
  • pattern(regExp: RegExp, errorMessage: string)
StringType().pattern(/^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/, 'Please enter legal characters');
  • rangeLength(minLength: number, maxLength: number, errorMessage: string)
StringType().rangeLength(6, 30, 'The number of characters can only be between 6 and 30');
  • minLength(minLength: number, errorMessage: string)
StringType().minLength(6, 'Minimum 6 characters required');
  • maxLength(maxLength: number, errorMessage: string)
StringType().minLength(30, 'The maximum is only 30 characters.');
  • addRule(onValid: Function, errorMessage: string)
StringType().addRule((value, data) => {
  return /^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/.test(value);
}, 'Please enter a legal character.');

NumberType

  • isRequired()
NumberType().isRequired('This field required');
  • isInteger(errorMessage: string)
NumberType().isInteger('It can only be an integer');
  • isOneOf(items: Array, errorMessage: string)
NumberType().isOneOf([5, 10, 15], 'Can only be `5`, `10`, `15`');
  • pattern(regExp: RegExp, errorMessage: string)
NumberType().pattern(/^[1-9][0-9]{3}$/, 'Please enter a legal character.');
  • range(minLength: number, maxLength: number, errorMessage: string)
NumberType().range(18, 40, 'Please enter a number between 18 - 40');
  • min(min: number, errorMessage: string)
NumberType().min(18, 'Minimum 18');
  • max(max: number, errorMessage: string)
NumberType().max(40, 'Maximum 40');
  • addRule(onValid: Function, errorMessage: string)
NumberType().addRule((value, data) => {
  return value % 5 === 0;
}, 'Please enter a valid number');

ArrayType

  • isRequired()
ArrayType().isRequired('This field required');
  • rangeLength(minLength: number, maxLength: number, errorMessage: string)
ArrayType().rangeLength(1, 3, 'Choose at least one, but no more than three');
  • minLength(minLength: number, errorMessage: string)
ArrayType().minLength(1, 'Choose at least one');
  • maxLength(maxLength: number, errorMessage: string)
ArrayType().maxLength(3, "Can't exceed three");
  • unrepeatable(errorMessage: string)
ArrayType().unrepeatable('Duplicate options cannot appear');
  • of(type: Object, errorMessage: string)
ArrayType().of(StringType().isEmail(), 'wrong format');
  • addRule(onValid: Function, errorMessage: string)
ArrayType().addRule((value, data) => {
  return value.length % 2 === 0;
}, 'Good things are in pairs');

DateType

  • isRequired()
DateType().isRequired('This field required');
  • range(min: Date, max: Date, errorMessage: string)
DateType().range(
  new Date('08/01/2017'),
  new Date('08/30/2017'),
  'Date should be between 08/01/2017 - 08/30/2017'
);
  • min(min: Date, errorMessage: string)
DateType().min(new Date('08/01/2017'), 'Minimum date 08/01/2017');
  • max(max: Date, errorMessage: string)
DateType().max(new Date('08/30/2017'), 'Maximum date 08/30/2017');
  • addRule(onValid: Function, errorMessage: string)
DateType().addRule((value, data) => {
  return value.getDay() === 2;
}, 'Can only choose Tuesday');

ObjectType

  • isRequired()
ObjectType().isRequired('This field required');
  • shape(type: Object)
ObjectType().shape({
  email: StringType().isEmail('Should be an email'),
  age: NumberType().min(18, 'Age should be greater than 18 years old')
});
  • addRule(onValid: Function, errorMessage: string)
ObjectType().addRule((value, data) => {
  if (value.id || value.email) {
    return true;
  }
  return false;
}, 'Id and email must have one that cannot be empty');

BooleanType

  • isRequired()
BooleanType().isRequired('This field required');
  • addRule(onValid: Function, errorMessage: string)
ObjectType().addRule((value, data) => {
  if (typeof value === 'undefined' && A === 10) {
    return false;
  }
  return true;
}, 'This value is required when A is equal to 10');

schema-typed's People

Contributors

simonguo avatar thejian avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.