@sumor/validator

Validador

Una Sumor Cloud Herramienta.
Más Documentación

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

CI
Prueba
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.

Requiere módulo ES de Node.JS

Como 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ónParámetro = {
  type: 'cadena',
  required: true,
  longitud: 10,
  regla: [
    // solo permitir a-z, A-Z, 0-9
    {
      código: 'SOLO_CARACTERES_DÍGITOS',
      expresión: '^[a-zA-Z0-9]*$',
      mensaje: 'solo permitir a-z, A-Z, 0-9'
    },
    // necesidad de incluir demo
    {
      código: 'INCLUIR_DEMO',
      expresión: 'demo',
      mensaje: 'necesita 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: {
    zh: {
      SOLO_CARACTERES_DÍGITOS: 'solo permitir letras y números',
      INCLUIR_DEMO: 'necesita incluir demo',
      LONGITUD_MAYOR_QUE_5: 'la longitud debe ser mayor que 5'
    },
    'zh-TW': {
      SOLO_CARACTERES_DÍGITOS: 'solo permitir letras y números',
      INCLUIR_DEMO: 'necesita incluir demo',
      LONGITUD_MAYOR_QUE_5: 'la longitud debe ser mayor que 5'
    }
  }
}

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

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

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

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

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

// traducir a zh
const mensajes6 = validate(informaciónParámetro, 'de', 'zh')
console.log(mensajes6) // [ 'solo permitir letras y números', 'necesita incluir demo', 'la longitud debe ser mayor que 5' ]

// traducir a zh-TW
const mensajes7 = validate(informaciónParámetro, 'de', 'zh-TW')
console.log(mensajes7) // [ 'solo permitir letras y números', 'necesita incluir demo', 'la longitud debe ser mayor que 5' ]

Uso de Validación de Número

import { validate } from '@sumor/validator'

const informaciónParámetro = {
  type: 'número',
  required: 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: {
    zh: {
      MAYOR_QUE_5: 'el valor debe ser mayor que 5'
    },
    'zh-TW': {
      MAYOR_QUE_5: 'el valor debe ser mayor que 5'
    }
  }
}

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

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

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

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

// traducir a zh-TW
const mensajes5 = validate(informaciónParámetro, 4, 'zh-TW')
console.log(mensajes5) // [ 'el valor debe ser mayor que 5' ]

Uso de Formato de Cadena

Uso de Trim

removerá los espacios innecesarios al principio y al final

import { format } from '@sumor/validator'

const informaciónParámetro = {
  type: 'cadena',
  trim: true // por defecto es true para tipo de cadena
}

const valor = format(informaciónParámetro, ' demo ')
console.log(valor) // imprimirá "demo", los espacios innecesarios se eliminarán
Uso de minúsculas

convertirá la cadena a minúsculas

import { format } from '@sumor/validator'

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

const valor = format(informaciónPará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 { format } from '@sumor/validator'

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

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

Uso de Formato de Número

import { format } from '@sumor/validator'

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

const valor1 = format(informaciónParámetro, 1.234)
console.log(valor1) // imprimirá 1.23, solo mantendrá 2 decimales

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

Habilitar la Salida de Error

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

import { validate } from '@sumor/validator'

const informaciónParámetro = {
  error: true,
  type: 'cadena',
  required: 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 = validate(informaciónParámetro, 'demo123456')
console.log(mensajes)
/* 
SumorError
{
  código: 'LONGITUD_MAYOR_QUE_5',
  mensaje: 'la longitud debe ser mayor que 5'
}
*/