revalidator 项目技术文档

1. 安装指南

1.1 安装 npm (Node Package Manager)

首先，确保你已经安装了 Node.js 和 npm。如果没有安装，可以通过以下命令安装 npm：

$ curl http://npmjs.org/install.sh | sh

1.2 安装 revalidator

安装完 npm 后，可以通过以下命令安装 revalidator：

$ [sudo] npm install revalidator

2. 项目的使用说明

revalidator 是一个跨浏览器和 Node.js 的验证器，主要目标是与 JSON Schema 兼容。它提供了一个简单的方法来验证对象是否符合给定的 JSON Schema。

2.1 基本使用

revalidator 的核心功能是通过 revalidator.validate(obj, schema) 方法来验证对象是否符合指定的 Schema。以下是一个简单的示例：

var revalidator = require('revalidator');

console.dir(revalidator.validate(someObject, {
  properties: {
    url: {
      description: 'the url the object should be stored at',
      type: 'string',
      pattern: '^/[^#%&*{}\\:<>?\/+]+$',
      required: true
    },
    challenge: {
      description: 'a means of protecting data (insufficient for production, used as example)',
      type: 'string',
      minLength: 5
    },
    body: {
      description: 'what to store at the url',
      type: 'any',
      default: null
    }
  }
}));

该方法返回一个对象，指示 obj 是否符合 schema。如果不符合，返回的对象将包含验证过程中遇到的错误。

{
  valid: true // 或 false
  errors: [/* 如果 valid 为 false，则包含错误数组 */]
}

2.2 浏览器中的使用

在浏览器中，验证函数通过 window.validate 暴露，只需包含 revalidator.js 文件即可使用。

3. 项目API使用文档

3.1 revalidator.validate(obj, schema, options)

该方法用于验证对象是否符合给定的 JSON Schema。返回一个包含验证结果的对象。

参数

• obj：要验证的对象。
• schema：用于验证对象的 JSON Schema。
• options：可选参数，用于配置验证行为。

返回值

返回一个对象，包含以下属性：

• valid：布尔值，指示对象是否符合 Schema。
• errors：如果 valid 为 false，则包含错误数组。

可用选项

• validateFormats：是否强制执行格式约束（默认 true）。
• validateFormatsStrict：当 validateFormats 为 true 时，是否将未识别的格式视为验证错误（默认 false）。
• validateFormatExtensions：当 validateFormats 为 true 时，是否验证 validate.formatExtensions 中定义的格式（默认 true）。
• additionalProperties：是否允许对象上存在未访问的额外属性（默认 true）。
• cast：是否强制将某些类型转换为预期类型（目前仅支持整数和数字）。

3.2 Schema 定义

Schema 用于定义对象的结构和验证规则。以下是一些常用的 Schema 属性：

required

如果为 true，则该属性不能为 undefined。

{ required: true }

type

定义属性的类型。

{ type: 'string' }
{ type: 'number' }
{ type: 'integer' }
{ type: 'array' }
{ type: 'boolean' }
{ type: 'object' }
{ type: 'null' }
{ type: 'any' }
{ type: ['boolean', 'string'] }

pattern

属性值必须匹配指定的正则表达式。

{ pattern: /^[a-z]+$/ }

maxLength

属性值的长度必须小于或等于指定值。

{ maxLength: 8 }

minLength

属性值的长度必须大于或等于指定值。

{ minLength: 8 }

minimum

属性值必须大于或等于指定值。

{ minimum: 10 }

maximum

属性值必须小于或等于指定值。

{ maximum: 10 }

enum

属性值必须是指定数组中的一个值。

{ enum: ['month', 'year'] }

format

属性值必须符合指定的格式。

{ format: 'url' }
{ format: 'email' }
{ format: 'ip-address' }
{ format: 'ipv6' }
{ format: 'date-time' }
{ format: 'date' }
{ format: 'time' }
{ format: 'color' }
{ format: 'host-name' }
{ format: 'utc-millisec' }
{ format: 'regex' }

4. 项目安装方式

revalidator 可以通过 npm 安装，具体步骤如下：

1. 安装 npm：

$ curl http://npmjs.org/install.sh | sh

2. 安装 revalidator：

$ [sudo] npm install revalidator

通过以上步骤，你就可以在你的项目中使用 revalidator 进行对象验证了。