@sumor/validator

validador

Uma Ferramenta Sumor Cloud.
Mais Documentação

Este é um validador leve para Node.JS. Ele pode validar a string de entrada ou número com base nas regras que você definiu.

CI Teste Cobertura Auditoria

Instalação

npm i @sumor/validator --save

Pré-requisitos

Versão do Node.JS

Requer Node.JS versão 16.x ou superior

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor altere o seguinte código em seu arquivo package.json:

{
  "type": "module"
}

Uso

Uso de Validação de String

import { validate } from '@sumor/validator'

const infoParametro = {
  tipo: 'string',
  obrigatório: true,
  comprimento: 10,
  regra: [
    // permitir apenas a-z, A-Z, 0-9
    {
      id: 'SOMENTE_CARACTERE_DIGITO',
      expressão: '^[a-zA-Z0-9]*$',
      mensagem: 'permitir apenas a-z, A-Z, 0-9'
    },
    // deve incluir demo
    {
      id: 'INCLUIR_DEMO',
      expressão: 'demo',
      mensagem: 'deve incluir demo'
    },
    // usar função para verificar
    {
      id: 'COMPRIMENTO_MAIS_DO_QUE_5',
      expressão: valor => {
        return valor.length > 5
      },
      mensagem: 'o comprimento deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      SOMENTE_CARACTERE_DIGITO: 'apenas letras e dígitos são permitidos',
      INCLUIR_DEMO: 'deve incluir demo',
      COMPRIMENTO_MAIS_DO_QUE_5: 'o comprimento deve ser maior que 5'
    },
    'zh-TW': {
      SOMENTE_CARACTERE_DIGITO: 'apenas letras e números são permitidos',
      INCLUIR_DEMO: 'deve incluir demo',
      COMPRIMENTO_MAIS_DO_QUE_5: 'o comprimento deve ser maior que 5'
    }
  }
}

const mensagens1 = validate(infoParametro, 'demo123456')
console.log(mensagens1) // []

const mensagens2 = validate(infoParametro, 'de1234567')
console.log(mensagens2) // [ 'permitir apenas a-z, A-Z, 0-9' ]

const mensagens3 = validate(infoParametro, 'demo!')
console.log(mensagens3) // [ 'permitir apenas a-z, A-Z, 0-9', 'deve incluir demo' ]

const mensagens4 = validate(infoParametro, 'de!mo')
console.log(mensagens4) // [ 'permitir apenas a-z, A-Z, 0-9', 'deve incluir demo' ]

const mensagens5 = validate(infoParametro, 'de')
console.log(mensagens5) // [ 'permitir apenas a-z, A-Z, 0-9', 'deve incluir demo', 'o comprimento deve ser maior que 5' ]

// tradução para zh
const mensagens6 = validate(infoParametro, 'de', 'zh')
console.log(mensagens6) // [ 'apenas letras e dígitos são permitidos', 'deve incluir demo', 'o comprimento deve ser maior que 5' ]

// tradução para zh-TW
const mensagens7 = validate(infoParametro, 'de', 'zh-TW')
console.log(mensagens7) // [ 'apenas letras e dígitos são permitidos', 'deve incluir demo', 'o comprimento deve ser maior que 5' ]

Uso de Validação de Número

import { validate } from '@sumor/validator'

const infoParametro = {
  tipo: 'number',
  obrigatório: true,
  regra: [
    // precisa ser maior que 5
    {
      id: 'MAIOR_QUE_5',
      expressão: valor => {
        return valor > 5
      },
      mensagem: 'o valor deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      MAIOR_QUE_5: 'o valor deve ser maior que 5'
    },
    'zh-TW': {
      MAIOR_QUE_5: 'o valor deve ser maior que 5'
    }
  }
}

const mensagens1 = validate(infoParametro, 6)
console.log(mensagens1) // []

const mensagens2 = validate(infoParametro, 5)
console.log(mensagens2) // [ 'o valor deve ser maior que 5' ]

const mensagens3 = validate(infoParametro, 4)
console.log(mensagens3) // [ 'o valor deve ser maior que 5' ]

// tradução para zh
const mensagens4 = validate(infoParametro, 4, 'zh')
console.log(mensagens4) // [ 'o valor deve ser maior que 5' ]

// tradução para zh-TW
const mensagens5 = validate(infoParametro, 4, 'zh-TW')
console.log(mensagens5) // [ 'o valor deve ser maior que 5' ]

Uso de Formatação de String

Uso de Remoção de Espaço

Removerá o espaço inútil do prefixo e sufixo

import { format } from '@sumor/validator'

const infoParametro = {
  tipo: 'string',
  trim: true // padrão é verdadeiro para o tipo string
}

const valor = format(infoParametro, ' demo ')
console.log(valor) // irá imprimir "demo", o espaço inútil será removido
Uso de Letras Minúsculas

Converterá a string em minúsculas

import { format } from '@sumor/validator'

const infoParametro = {
  tipo: 'string',
  lowercase: true
}

const valor = format(infoParametro, 'Demo')
console.log(valor) // irá imprimir "demo", todos os caracteres serão convertidos para minúsculas
Uso de Letras Maiúsculas

Converterá a string em maiúsculas

import { format } from '@sumor/validator'

const infoParametro = {
  tipo: 'string',
  uppercase: true
}

const valor = format(infoParametro, 'Demo')
console.log(valor) // irá imprimir "DEMO", todos os caracteres serão convertidos para maiúsculas

Uso de Formatação de Número

import { format } from '@sumor/validator'

const infoParametro = {
  tipo: 'number',
  decimal: 2
}

const valor1 = format(infoParametro, 1.234)
console.log(valor1) // irá imprimir 1.23, apenas mantém 2 casas decimais

const valor2 = format(infoParametro, '1.234')
console.log(valor2) // irá converter para número 1.23, apenas mantém 2 casas decimais