Indicative 数据验证库使用教程

Indicative 数据验证库使用教程

indicative Indicative is a simple yet powerful data validator for Node.js and browsers. It makes it so simple to write async validations on nested set of data. 项目地址: https://gitcode.com/gh_mirrors/in/indicative

1. 项目介绍

Indicative 是一个简单而强大的数据验证库，适用于 Node.js 和浏览器环境。它使得在嵌套数据集上编写异步验证变得非常简单。Indicative 的设计目标是提供一种直观且易于使用的方式来验证用户输入、API 请求等数据。

2. 项目快速启动

安装

首先，你需要在你的项目中安装 Indicative。你可以使用 npm 或 yarn 来安装：

npm install indicative --save

或

yarn add indicative

基本使用

以下是一个简单的示例，展示了如何使用 Indicative 来验证用户输入的数据：

const { validate } = require('indicative/validator')

const rules = {
  email: 'required|email',
  password: 'required|min:6'
}

const data = {
  email: 'example@example.com',
  password: 'secret'
}

validate(data, rules)
  .then(() => {
    console.log('Validation passed')
  })
  .catch(errors => {
    console.log('Validation failed', errors)
  })

异步验证

Indicative 还支持异步验证，例如在验证过程中需要查询数据库或调用外部 API：

const { validate } = require('indicative/validator')

const rules = {
  username: 'required|unique:users,username'
}

const data = {
  username: 'john_doe'
}

validate(data, rules)
  .then(() => {
    console.log('Validation passed')
  })
  .catch(errors => {
    console.log('Validation failed', errors)
  })

3. 应用案例和最佳实践

用户注册表单验证

在用户注册表单中，通常需要验证用户的电子邮件、密码等信息。Indicative 可以帮助你轻松实现这些验证：

const rules = {
  email: 'required|email|unique:users,email',
  password: 'required|min:8|confirmed',
  username: 'required|alpha_numeric|unique:users,username'
}

const data = {
  email: 'example@example.com',
  password: 'secret123',
  password_confirmation: 'secret123',
  username: 'john_doe'
}

validate(data, rules)
  .then(() => {
    console.log('Registration data is valid')
  })
  .catch(errors => {
    console.log('Validation failed', errors)
  })

API 请求验证

在构建 RESTful API 时，验证传入的请求数据是至关重要的。Indicative 可以帮助你确保传入的数据符合预期的格式和规则：

const rules = {
  title: 'required|string',
  description: 'required|string',
  price: 'required|number'
}

const data = {
  title: 'Product Title',
  description: 'Product Description',
  price: 100
}

validate(data, rules)
  .then(() => {
    console.log('API request data is valid')
  })
  .catch(errors => {
    console.log('Validation failed', errors)
  })

4. 典型生态项目

Indicative 通常与其他 Node.js 项目一起使用，例如：

• Adonis.js: 一个全栈的 Node.js 框架，广泛使用 Indicative 进行数据验证。
• Express.js: 一个流行的 Node.js 框架，可以与 Indicative 结合使用来验证传入的请求数据。
• Koa.js: 另一个流行的 Node.js 框架，同样可以与 Indicative 结合使用来增强数据验证功能。

通过结合这些生态项目，Indicative 可以帮助开发者构建更加健壮和安全的应用程序。

indicative Indicative is a simple yet powerful data validator for Node.js and browsers. It makes it so simple to write async validations on nested set of data. 项目地址: https://gitcode.com/gh_mirrors/in/indicative