@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 usted defina.

CI Test Cobertura Auditoría

Instalación

npm i @sumor/validator --save

Prerrequisitos

Versión de Node.JS

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

Requerir módulo ES de Node.JS

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

{
  "type": "module"
}

Uso

Uso de Validación de Cadena

import { validar } from '@sumor/validator'

const informaciónDeParámetro = {
  tipo: 'cadena',
  requerido: true,
  longitud: 10,
  regla: [
    // solo permitir a-z, A-Z, 0-9
    {
      código: 'SOLO_CAR_DIG',
      expresión: '^[a-zA-Z0-9]*$',
      mensaje: 'solo permitir a-z, A-Z, 0-9'
    },
    // necesitas incluir demo
    {
      código: 'INCLUIR_DEMO',
      expresión: 'demo',
      mensaje: 'debes incluir demo'
    },
    // usar función para comprobar
    {
      código: 'LONGITUD_MAYOR_QUE_5',
      expresión: valor => {
        return valor.length > 5
      },
      mensaje: 'la longitud debe ser mayor que 5'
    }
  ],
  i18n: {
    es: {
      SOLO_CAR_DIG: 'solo se permite introducir letras y números',
      INCLUIR_DEMO: 'necesitas incluir demo',
      LONGITUD_MAYOR_QUE_5: 'la longitud debe ser mayor que 5'
    },
    'es-ES': {
      SOLO_CAR_DIG: 'solo se permite introducir letras y números',
      INCLUIR_DEMO: 'necesitas incluir demo',
      LONGITUD_MAYOR_QUE_5: 'la longitud debe ser mayor que 5'
    }
  }
}

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

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

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

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

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

// traducir a es
const mensajes6 = validar(informaciónDeParámetro, 'de', 'es')
console.log(mensajes6) // [ 'solo se permite introducir letras y números', 'necesitas incluir demo', 'la longitud debe ser mayor que 5' ]

// traducir a es-ES
const mensajes7 = validar(informaciónDeParámetro, 'de', 'es-ES')
console.log(mensajes7) // [ 'solo se permite introducir letras y números', 'necesitas incluir demo', 'la longitud debe ser mayor que 5' ]

Uso de Validación de Número

import { validar } from '@sumor/validator'

const informaciónDeParámetro = {
  tipo: 'número',
  requerido: true,
  regla: [
    // necesita ser mayor que 5
    {
      código: 'MAYOR_QUE_5',
      expresión: valor => {
        return valor > 5
      },
      mensaje: 'el valor debe ser mayor que 5'
    }
  ],
  i18n: {
    es: {
      MAYOR_QUE_5: 'el valor debe ser mayor que 5'
    },
    'es-ES': {
      MAYOR_QUE_5: 'el valor debe ser mayor que 5'
    }
  }
}

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

const mensajes2 = validar(informaciónDeParámetro, 5)
console.log(mensajes2) // [ 'el valor debe ser mayor que 5' ]

const mensajes3 = validar(informaciónDeParámetro, 4)
console.log(mensajes3) // [ 'el valor debe ser mayor que 5' ]

// traducir a es
const mensajes4 = validar(informaciónDeParámetro, 4, 'es')
console.log(mensajes4) // [ 'el valor debe ser mayor que 5' ]

// traducir a es-ES
const mensajes5 = validar(informaciónDeParámetro, 4, 'es-ES')
console.log(mensajes5) // [ 'el valor debe ser mayor que 5' ]

Uso de Formato de Cadena

Uso de Recorte

eliminará el espacio inútil para el prefijo y sufijo

import { formato } from '@sumor/validador'

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

const valor = formato(informaciónDeParámetro, ' demo ')
console.log(valor) // imprimirá "demo", el espacio inútil será eliminado
Uso de Minúsculas

convertirá la cadena a minúsculas

import { formato } from '@sumor/validador'

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

const valor = formato(informaciónDePará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/validador'

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

const valor = formato(informaciónDePará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/validador'

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

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

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

Habilitar la Salida de Errores

Si pasa error:true, la respuesta será un objeto de SumorError. Puede cambiar el idioma y exportar soporte json por @sumor/error

import { validar } from '@sumor/validador'

const informaciónDeParámetro = {
  error: true,
  tipo: 'cadena',
  requerido: true,
  longitud: 10,
  regla: [
    {
      código: 'LONGITUD_MAYOR_QUE_5',
      expresión: valor => {
        return valor.length > 5
      },
      mensaje: 'la longitud debe ser mayor que 5'
    }
  ]
}

const mensajes = validar(informaciónDeParámetro, 'demo123456', 'es', true)
console.log(mensajes)
/* 
SumorError
{
  código: 'LONGITUD_MAYOR_QUE_5',
  mensaje: 'la longitud debe ser mayor que 5'
}
*/