# validate-framework-utils

**Repository Path**: MinJieLiu/validate-framework-utils

## Basic Information

- **Project Name**: validate-framework-utils
- **Description**: Some utils are used for validation
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2017-01-02
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# validate-framework-utils

Some utils are used for validation

[![npm](https://img.shields.io/npm/v/validate-framework-utils.svg?style=flat-square)](https://www.npmjs.com/package/validate-framework-utils)
[![Travis](https://img.shields.io/travis/MinJieLiu/validate-framework-utils.svg?style=flat-square)](https://travis-ci.org/MinJieLiu/validate-framework-utils)
[![npm](https://img.shields.io/npm/dt/validate-framework-utils.svg?style=flat-square)](https://github.com/MinJieLiu/validate-framework-utils)

## How to use?

    npm i validate-framework-utils --save

```js
import Validator from 'validate-framework-utils';

const validator = new Validator();

const field = {
  rules: 'required | isEmail | maxLength(32)',
  messages: 'Can not be empty! | Please enter a valid email address. | Can not exceed {{param}} characters.',
  value: 'example@example.com',
};

// `result` is the verification result
// `error` contains the error message

const { result, error } = await validator.validateByField(field);

// ...
```

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`

```js
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)