@sumor/validator

validador

Uma Ferramenta Sumor Cloud.
Documentação Adicional

Este é um verificador 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 Node.JS

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

Requer módulo ES 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 informaçõesParâmetro = {
  tipo: 'string',
  obrigatório: true,
  comprimento: 10,
  regra: [
    // apenas permitir a-z, A-Z, 0-9
    {
      id: 'ONLY_CHAR_DIGIT',
      expressão: '^[a-zA-Z0-9]*$',
      mensagem: 'apenas permitir a-z, A-Z 0-9'
    },
    // precisa incluir demo
    {
      id: 'INCLUDE_DEMO',
      expressão: 'demo',
      mensagem: 'precisa incluir demo'
    },
    // usar função para verificar
    {
      id: 'LENGTH_GREATER_THAN_5',
      expressão: valor => {
        return valor.length > 5
      },
      mensagem: 'comprimento deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: 'somente permitido letras e dígitos',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deve ser maior que 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'somente permitido letras e dígitos',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deve ser maior que 5'
    }
  }
}

const mensagens1 = validate(informaçõesParâmetro, 'demo123456')
console.log(mensagens1) // []

const mensagens2 = validate(informaçõesParâmetro, 'de1234567')
console.log(mensagens2) // [ 'apenas permitir a-z, A-Z, 0-9' ]

const mensagens3 = validate(informaçõesParâmetro, 'demo!')
console.log(mensagens3) // [ 'apenas permitir a-z, A-Z, 0-9', 'precisa incluir demo' ]

const mensagens4 = validate(informaçõesParâmetro, 'de!mo')
console.log(mensagens4) // [ 'apenas permitir a-z, A-Z, 0-9', 'precisa incluir demo' ]

const mensagens5 = validate(informaçõesParâmetro, 'de')
console.log(mensagens5) // [ 'apenas permitir a-z, A-Z, 0-9', 'precisa incluir demo', 'comprimento deve ser maior que 5' ]

// traduzir para zh
const mensagens6 = validate(informaçõesParâmetro, 'de', 'zh')
console.log(mensagens6) // [ 'somente permitido letras e dígitos', 'precisa incluir demo', 'comprimento deve ser maior que 5' ]

// traduzir para zh-TW
const mensagens7 = validate(informaçõesParâmetro, 'de', 'zh-TW')
console.log(mensagens7) // [ 'somente permitido letras e dígitos', 'precisa incluir demo', 'comprimento deve ser maior que 5' ]

Uso de Validação de Número

import { validate } from '@sumor/validator'

const informaçõesParâmetro = {
  tipo: 'number',
  obrigatório: true,
  regra: [
    // precisa ser maior que 5
    {
      id: 'GREATER_THAN_5',
      expressão: valor => {
        return valor > 5
      },
      mensagem: 'o valor deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      GREATER_THAN_5: 'o valor deve ser maior que 5'
    },
    'zh-TW': {
      GREATER_THAN_5: 'o valor deve ser maior que 5'
    }
  }
}

const mensagens1 = validate(informaçõesParâmetro, 6)
console.log(mensagens1) // []

const mensagens2 = validate(informaçõesParâmetro, 5)
console.log(mensagens2) // [ 'o valor deve ser maior que 5' ]

const mensagens3 = validate(informaçõesParâmetro, 4)
console.log(mensagens3) // [ 'o valor deve ser maior que 5' ]

// traduzir para zh
const mensagens4 = validate(informaçõesParâmetro, 4, 'zh')
console.log(mensagens4) // [ 'o valor deve ser maior que 5' ]

// traduzir para zh-TW
const mensagens5 = validate(informaçõesParâmetro, 4, 'zh-TW')
console.log(mensagens5) // [ 'o valor deve ser maior que 5' ]

Uso de Formato de String

Uso de Trim

irá remover os espaços inúteis para o prefixo e sufixo

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  tipo: 'string',
  trim: true // padrão é true para tipo string
}

const valor = format(informaçõesParâmetro, ' demo ')
console.log(valor) // irá imprimir "demo", espaços inúteis serão removidos
Uso de Minúsculas

irá converter a string para minúsculas

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  tipo: 'string',
  minúsculas: true
}

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

irá converter a string para maiúsculas

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  tipo: 'string',
  maiúsculas: true
}

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

Uso de Formato de Número

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  tipo: 'number',
  decimal: 2
}

const valor1 = format(informaçõesParâmetro, 1.234)
console.log(valor1) // irá imprimir 1.23, mantendo apenas 2 casas decimais

const valor2 = format(informaçõesParâmetro, '1.234')
console.log(valor2) // irá converter para número 1.23, mantendo apenas 2 casas decimais