November's Paddleball Marathon

    validate-framework-utils

    0.6.4 • Public • Published

    validate-framework-utils

    Some utils are used for validation

    npm Travis npm

    How to use?

    yarn add validate-framework-utils
    
    import Validator from 'validate-framework-utils';
     
    const validator = new Validator();
     
    const field = {
      rules: 'required | isEmail | maxLength(32)', // Asynchronous methods need to be put to the end
      messages: 'Can not be empty! | Please enter a valid email address. | Can not exceed {{param}} characters.',
    };
     
    const {
      result, // The verification result 
      error, // contains the error message
    = await validator.validateByField(field)('example@example.com');
     
    // ...

    The field:

    • rules One or more rules (separated by | separated)
    • messages One or more messages (separated by | separated). {{Value}} is the value, and {{param}} is a parameter of like maxLength(32)
    • value The value to use for validation

    Customize the validation method

    Required the validation method begins with required

    validator.addMethods({
      limitSelect(field, param) {
        return field.value.length <= param;
      },
      async validateFromServer(field, param) {
        return await doServerAPI();
      },
    });

    API

    • addMethods(methods)
    • removeMethods(...names)
    • validateByField(field) @return Promise

    Built-in validation method

    • required
    • isAbc
    • isDate
    • isDecimal
    • isEmail
    • isInteger
    • isIp
    • isNumeric
    • isPhone
    • isTel
    • isUrl
    • maxLength(length)
    • minLength(length)
    • greaterThan(param)
    • lessThan(param)
    • greaterThanDate(date)
    • lessThanDate(date)

    Install

    npm i validate-framework-utils

    DownloadsWeekly Downloads

    4

    Version

    0.6.4

    License

    MIT

    Unpacked Size

    136 kB

    Total Files

    29

    Last publish

    Collaborators

    • liumingyi