@sumor/validator

validator

Una Herramienta Sumor Cloud.
Más Documentación

Este es un validador ligero para Node.JS. Puede validar la cadena de entrada o número basado en las reglas que hayas definido.

CI Test Coverage Audit

Instalación

npm i @sumor/validator --save

Prerrequisitos

Versión de Node.JS

Requiere Node.JS versión 16.x o superior.

Requiere módulo ES de Node.JS

Dado que este paquete está escrito en módulo ES, por favor cambia el siguiente código en tu archivo package.json:

{
  "type": "module"
}

Uso

Uso de Validación de Cadenas

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    // solo se permite a-z, A-Z, 0-9
    {
      id: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'solo se permite a-z, A-Z, 0-9'
    },
    // necesita incluir demo
    {
      id: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'necesita incluir demo'
    },
    // usa una función para verificar
    {
      id: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'la longitud debería ser mayor a 5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: 'solo se permiten letras y números',
      INCLUDE_DEMO: 'necesita incluir demo',
      LENGTH_GREATER_THAN_5: 'la longitud debería ser mayor a 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'solo se permiten letras y números',
      INCLUDE_DEMO: 'necesita incluir demo',
      LENGTH_GREATER_THAN_5: 'la longitud debería ser mayor a 5'
    }
  }
}

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

const messages2 = validate(parameterInfo, 'de1234567')
console.log(messages2) // [ 'solo se permite a-z, A-Z, 0-9' ]

const messages3 = validate(parameterInfo, 'demo!')
console.log(messages3) // [ 'solo se permite a-z, A-Z, 0-9', 'necesita incluir demo' ]

const messages4 = validate(parameterInfo, 'de!mo')
console.log(messages4) // [ 'solo se permite a-z, A-Z, 0-9', 'necesita incluir demo' ]

const messages5 = validate(parameterInfo, 'de')
console.log(messages5) // [ 'solo se permite a-z, A-Z, 0-9', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

// traducir a zh
const messages6 = validate(parameterInfo, 'de', 'zh')
console.log(messages6) // [ 'solo se permiten letras y números', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

// traducir a zh-TW
const messages7 = validate(parameterInfo, 'de', 'zh-TW')
console.log(messages7) // [ 'solo se permiten letras y números', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

Uso de Validación de Números

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  required: true,
  rule: [
    // necesita ser mayor a 5
    {
      id: 'GREATER_THAN_5',
      expression: value => {
        return value > 5
      },
      message: 'el valor debería ser mayor a 5'
    }
  ],
  i18n: {
    zh: {
      GREATER_THAN_5: 'el valor debería ser mayor a 5'
    },
    'zh-TW': {
      GREATER_THAN_5: 'el valor debería ser mayor a 5'
    }
  }
}

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

const messages2 = validate(parameterInfo, 5)
console.log(messages2) // [ 'el valor debería ser mayor a 5' ]

const messages3 = validate(parameterInfo, 4)
console.log(messages3) // [ 'el valor debería ser mayor a 5' ]

// traducir a zh
const messages4 = validate(parameterInfo, 4, 'zh')
console.log(messages4) // [ 'el valor debería ser mayor a 5' ]

// traducir a zh-TW
const messages5 = validate(parameterInfo, 4, 'zh-TW')
console.log(messages5) // [ 'el valor debería ser mayor a 5' ]

Uso de Formato de Cadenas

Uso de Recorte

Eliminará los espacios inútiles para el prefijo y sufijo

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  trim: true // por defecto es verdadero para el tipo de cadena
}

const value = format(parameterInfo, ' demo ')
console.log(value) // imprimirá "demo", los espacios inútiles serán eliminados
Uso de Minúsculas

Convertirá la cadena a minúsculas

import { format } from '@sumor/validator'

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

const value = format(parameterInfo, 'Demo')
console.log(value) // imprimirá "demo", todos los caracteres se convertirán a minúsculas
Uso de Mayúsculas

Convertirá la cadena a mayúsculas

import { format } from '@sumor/validator'

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

const value = format(parameterInfo, 'Demo')
console.log(value) // imprimirá "DEMO", todos los caracteres se convertirán a mayúsculas

Uso de Formato de Números

import { format } from '@sumor/validator'

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

const value1 = format(parameterInfo, 1.234)
console.log(value1) // imprimirá 1.23, se mantendrán solo 2 decimales

const value2 = format(parameterInfo, '1.234')
console.log(value2) // se convertirá en el número 1.23, se mantendrán solo 2 decimales