@sumor/validator

Validador

Una herramienta de Sumor Cloud.
Más documentación

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

CI Test Cobertura Auditoría

Instalación

npm i @sumor/validator --save

Requisitos previos

Versión de Node.JS

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

Requerir 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 Cadena

import { validate } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'cadena',
  requerido: true,
  longitud: 10,
  regla: [
    // solo permitir a-z, A-Z, 0-9
    {
      id: 'SOLO_CAR_DIG',
      expresión: '^[a-zA-Z0-9]*$',
      mensaje: 'solo permitir a-z, A-Z, 0-9'
    },
    // necesita incluir demo
    {
      id: 'INCLUIR_DEMO',
      expresión: 'demo',
      mensaje: 'necesita incluir demo'
    },
    // usar función para verificar
    {
      id: 'LONGITUD_MAYOR_A_5',
      expresión: valor => {
        return valor.length > 5
      },
      mensaje: 'la longitud debería ser mayor a 5'
    }
  ],
  i18n: {
    zh: {
      SOLO_CAR_DIG: 'solo se permiten letras y números',
      INCLUIR_DEMO: 'necesita incluir demo',
      LONGITUD_MAYOR_A_5: 'la longitud debería ser mayor a 5'
    },
    'zh-TW': {
      SOLO_CAR_DIG: 'solo se permiten letras y números',
      INCLUIR_DEMO: 'necesita incluir demo',
      LONGITUD_MAYOR_A_5: 'la longitud debería ser mayor a 5'
    }
  }
}

const mensajes1 = validar(informaciónDelParámetro, 'demo123456')
console.log(mensajes1) // []

const mensajes2 = validar(informaciónDelParámetro, 'de1234567')
console.log(mensajes2) // [ 'solo permitir a-z, A-Z, 0-9' ]

const mensajes3 = validar(informaciónDelParámetro, 'demo!')
console.log(mensajes3) // [ 'solo permitir a-z, A-Z, 0-9', 'necesita incluir demo' ]

const mensajes4 = validar(informaciónDelParámetro, 'de!mo')
console.log(mensajes4) // [ 'solo permitir a-z, A-Z, 0-9', 'necesita incluir demo' ]

const mensajes5 = validar(informaciónDelParámetro, 'de')
console.log(mensajes5) // [ 'solo permitir a-z, A-Z, 0-9', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

// traducir a zh
const mensajes6 = validar(informaciónDelParámetro, 'de', 'zh')
console.log(mensajes6) // [ 'solo se permiten letras y números', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

// traducir a zh-TW
const mensajes7 = validar(informaciónDelParámetro, 'de', 'zh-TW')
console.log(mensajes7) // [ 'solo se permiten letras y números', 'necesita incluir demo', 'la longitud debería ser mayor a 5' ]

Uso de Validación de Número

import { validar } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'número',
  requerido: true,
  regla: [
    // necesita ser mayor a 5
    {
      id: 'MAYOR_A_5',
      expresión: valor => {
        return valor > 5
      },
      mensaje: 'el valor debería ser mayor a 5'
    }
  ],
  i18n: {
    zh: {
      MAYOR_A_5: 'el valor debería ser mayor a 5'
    },
    'zh-TW': {
      MAYOR_A_5: 'el valor debería ser mayor a 5'
    }
  }
}

const mensajes1 = validar(informaciónDelParámetro, 6)
console.log(mensajes1) // []

const mensajes2 = validar(informaciónDelParámetro, 5)
console.log(mensajes2) // [ 'el valor debería ser mayor a 5' ]

const mensajes3 = validar(informaciónDelParámetro, 4)
console.log(mensajes3) // [ 'el valor debería ser mayor a 5' ]

// traducir a zh
const mensajes4 = validar(informaciónDelParámetro, 4, 'zh')
console.log(mensajes4) // [ 'el valor debería ser mayor a 5' ]

// traducir a zh-TW
const mensajes5 = validar(informaciónDelParámetro, 4, 'zh-TW')
console.log(mensajes5) // [ 'el valor debería ser mayor a 5' ]

Uso de Formato de Cadena

Uso de Recorte

eliminará el espacio no utilizado para el prefijo y sufijo

import { format } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'cadena',
  recorte: true // por defecto es true para el tipo de cadena
}

const valor = formato(informaciónDelParámetro, ' demo ')
console.log(valor) // imprimirá "demo", se eliminará el espacio no utilizado
Uso de Minúsculas

convertirá la cadena a minúsculas

import { formato } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'cadena',
  minúsculas: true
}

const valor = formato(informaciónDelParámetro, 'Demo')
console.log(valor) // imprimirá "demo", todos los caracteres se convertirán a minúsculas
Uso de Mayúsculas

convertirá la cadena a mayúsculas

import { formato } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'cadena',
  mayúsculas: true
}

const valor = formato(informaciónDelParámetro, 'Demo')
console.log(valor) // imprimirá "DEMO", todos los caracteres se convertirán a mayúsculas

Uso de Formato de Número

import { formato } from '@sumor/validator'

const informaciónDelParámetro = {
  tipo: 'número',
  decimal: 2
}

const valor1 = formato(informaciónDelParámetro, 1.234)
console.log(valor1) // imprimirá 1.23, solo se mantendrán 2 decimales

const valor2 = formato(informaciónDelParámetro, '1.234')
console.log(valor2) // se convertirá a número 1.23, solo se mantendrán 2 decimales