验证器

一个Sumor Cloud工具。
更多文档

这是一个用于 Node.JS 的轻量级验证器。
它可以根据你定义的规则验证输入的字符串或数字。

安装

npm i @sumor/validator --save

先决条件

Node.JS 版本

需要 Node.JS 版本 16.x 或以上。

需要 Node.JS ES 模块

由于此包是用 ES 模块编写的，请在你的 package.json 文件中作如下更改：

{
  "type": "module"
}

用法

验证字符串用法

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    // 只允许 a-z, A-Z, 0-9
    {
      code: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: '只允许输入字母和数字'
    },
    // 需要包含 demo
    {
      code: 'INCLUDE_DEMO',
      expression: 'demo',
      message: '需要包含demo'
    },
    // 使用函数进行校验
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: '长度应大于5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: '只允许输入字母和数字',
      INCLUDE_DEMO: '需要包含demo',
      LENGTH_GREATER_THAN_5: '长度应大于5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: '只允许输入字母和数字',
      INCLUDE_DEMO: '需要包含demo',
      LENGTH_GREATER_THAN_5: '长度应大于5'
    }
  }
}

const messages1 = validate(parameterInfo, 'demo123456')
console.log(messages1) // []

const messages2 = validate(parameterInfo, 'de1234567')
console.log(messages2) // [ '只允许输入字母和数字' ]

const messages3 = validate(parameterInfo, 'demo!')
console.log(messages3) // [ '只允许输入字母和数字', '需要包含demo' ]

const messages4 = validate(parameterInfo, 'de!mo')
console.log(messages4) // [ '只允许输入字母和数字', '需要包含demo' ]

const messages5 = validate(parameterInfo, 'de')
console.log(messages5) // [ '只允许输入字母和数字', '需要包含demo', '长度应大于5' ]

// 转换成中文
const messages6 = validate(parameterInfo, 'de', 'zh')
console.log(messages6) // [ '只允许输入字母和数字', '需要包含demo', '长度应大于5' ]

// 转换成中文繁体
const messages7 = validate(parameterInfo, 'de', 'zh-TW')
console.log(messages7) // [ '只允许输入字母和数字', '需要包含demo', '长度应大于5' ]

验证数字用法

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  required: true,
  rule: [
    // 需要大于 5
    {
      code: 'GREATER_THAN_5',
      expression: value => {
        return value > 5
      },
      message: '值应大于5'
    }
  ],
  i18n: {
    zh: {
      GREATER_THAN_5: '值应大于5'
    },
    'zh-TW': {
      GREATER_THAN_5: '值应大于5'
    }
  }
}

const messages1 = validate(parameterInfo, 6)
console.log(messages1) // []

const messages2 = validate(parameterInfo, 5)
console.log(messages2) // [ '值应大于5' ]

const messages3 = validate(parameterInfo, 4)
console.log(messages3) // [ '值应大于5' ]

// 转换成中文
const messages4 = validate(parameterInfo, 4, 'zh')
console.log(messages4) // [ '值应大于5' ]

// 转换成中文繁体
const messages5 = validate(parameterInfo, 4, 'zh-TW')
console.log(messages5) // [ '值应大于5' ]

格式化字符串用法

去除空格用法

会删除前缀和后缀的无用空格

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  trim: true // 字符串类型默认为 true
}

const value = format(parameterInfo, ' demo ')
console.log(value) // 将打印 "demo"，无用空格将被移除

转为小写用法

会将字符串转为小写

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  lowercase: true
}

const value = format(parameterInfo, 'Demo')
console.log(value) // 将打印 "demo"，所有字符将被转为小写

转为大写用法

会将字符串转为大写

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  uppercase: true
}

const value = format(parameterInfo, 'Demo')
console.log(value) // 将打印 "DEMO"，所有字符将被转为大写

格式化数字用法

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  decimal: 2
}

const value1 = format(parameterInfo, 1.234)
console.log(value1) // 将打印 1.23，只保留两位小数

const value2 = format(parameterInfo, '1.234')
console.log(value2) // 将转换为数字 1.23，只保留两位小数

启用输出错误

如果传递 error:true，响应将是一个 SumorError 对象。
您可以通过@sumor/error更改语言并支持导出 JSON。

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: '长度应大于5'
    }
  ]
}

const messages = validate(parameterInfo, 'demo123456', 'en', true)
console.log(messages)
/* 
SumorError
{
  code: 'LENGTH_GREATER_THAN_5',
  message: '长度应大于5'
}
*/