https://github.com/zenser/dvalidator

✅ A pure, extendable, very useful, asynchronous validator base Promise and Decorator
https://github.com/zenser/dvalidator

asynchronous decorator promise validate validator

Last synced: 1 day ago
JSON representation

✅ A pure, extendable, very useful, asynchronous validator base Promise and Decorator

• Host: GitHub
• URL: https://github.com/zenser/dvalidator
• Owner: Zenser
• License: mit
• Created: 2018-06-22T03:14:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T15:16:02.000Z (almost 2 years ago)
• Last Synced: 2024-12-13T10:49:30.410Z (14 days ago)
• Topics: asynchronous, decorator, promise, validate, validator
• Language: TypeScript
• Homepage:
• Size: 750 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Dvalidator](logo.jpg)

[English edition](README_en.md)

> Dvalidator 是一个纯净、可扩展、非常有用的校验工具，它基于 Promise 和 Decorator 实现。

它有以下特性：

- Compatibility : 同时支持最新版 Decorator 用法和老版用法

- Asynchronous : 支持传递异步函数

- Ordered : 根据你定义的顺序，有序校验

- Small : 小巧，源码不超过 200 行

- Easy : 使用简单，仅仅只有 2 个 Api

## 起步

```bash

npm install dvalidator --save

```

```bash

npm install @babel/plugin-proposal-decorators --save-dev

```

配置 babel.config.js

```js

plugins: [

  [

    '@babel/plugin-proposal-decorators',

    {

      // Dvalidator 支持最新的 Decorator 提案（legacy: false）

      // 同样也支持旧版的 (legacy: true)，Decorator 可以作用于字面量对象

      // 按照你的喜好设置，推荐使用最新的提案

    }

  ]

];

```

## 使用

假设我们有这样一个需求，我们将校验一个 user 对象，昵称和手机号是必选的，并且手机号需要发起一个服务端远程校验。

使用 Dvalidator，我们可以这样写：

```js

// common.js

import dvalidator from 'dvalidator';

const requiredRule = {

  validator: val => val != null && val !== '',

  message: 'required'

};

const required = dvalidator(requiredRule);

const checkPhone = dvalidator(value => fetch(`xxx/${value}`));

// user-signup.js

class User {

  @required('nickname is required')

  nickname = '';

  @checkPhone('phone valid fail')

  @required

  phone = '';

}

const user = new User();

user

  .$validate()

  .then(/* success */)

  .catch(({ errors, fields }) => {

    /* fail */

    alert(errors[0].message);

    // errors 包含每个属性的错误信息，结构一致，嵌套对象会拍平

    // fields 以对象形式获取错误信息，一般用于展示表单中每一栏的错误信息

  });

```

你可以把校验规则做一下封装，写在单独的文件里，这样业务代码会非常简洁。

## Api

#### dvalidator(rule: string | Function | Rule): Dvalidator

一个类柯里化函数，你可以调用无限次去丰富规则或者覆盖规则。

你需要传递规则进来，规则可以是一个函数（校验方法），字符串（错误信息），对象（包含以上两者的集合）。

例如：

```js

dvalidator({

  validator: val => {

    // 你的校验部分代码

    // 可以返回 Boolean（同步校验） 或者 Promise（异步校验）

  },

  // 校验出错时会返回给你

  message: ''

});

```

一个校验规则想要返回不同错误信息：

```js

// 传递不同的 message

dvalidator(checkPhone)('msg1');

dvalidator(checkPhone)('msg2');

```

```js

// 也可以动态返回错误信息

dvalidator(() => {

  return Promise.reject(x ? 'msg1' : 'msg2');

});

```

#### \$validate(filter?: Function): Promise

把装饰器加入到对象上后，对象就是属于 “可校验对象”，你可以此方法进行数据校验。filter 是一个用来过滤属性的方法，我们可以用它做一些动态校验。

```js

// 返回 Promise

user

  .$validate(fieldKey => {

    // 这里可以定义你的过滤逻辑

    // 如果是嵌套的对象，那么 fieldKey 会做拼接

    // 例如 user: { like: { game: 'lol' } }，只想校验 like.game 的时候，你可以这样写

    return /^like\.game/.test(fieldKey);

  })

  .catch(({ errors, fields }) => {

    // xxx

  });

```

## 接口声明文件

从这里可以看到更详细的结构信息！

[index.d.ts](lib/index.d.ts)

## And More

Enjoy it!