validador

Uma Ferramenta Sumor Cloud.
Documentação Adicional

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

Instalação

npm i @sumor/validator --save

Pré-requisitos

Versão do Node.JS

Requer a versão 16.x ou acima do Node.JS

Requer módulo ES do Node.JS

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

{
  "type": "module"
}

Uso

Uso de Validação de String

import { validate } from '@sumor/validator'

const informacaoParametro = {
  tipo: 'string',
  obrigatório: true,
  comprimento: 10,
  regra: [
    // permitir somente a-z, A-Z, 0-9
    {
      code: 'ONLY_CHAR_DIGIT',
      expressão: '^[a-zA-Z0-9]*$',
      mensagem: 'só permitir a-z, A-Z, 0-9'
    },
    // precisa incluir demo
    {
      code: 'INCLUDE_DEMO',
      expressão: 'demo',
      mensagem: 'precisa incluir demo'
    },
    // usar função para verificar
    {
      code: 'LENGTH_GREATER_THAN_5',
      expressão: valor => {
        return valor.length > 5
      },
      mensagem: 'o comprimento deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: 'só é permitido entrada de letras e números',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deve ser maior que 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'apenas letras e números são permitidos',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deve ser maior que 5'
    }
  }
}

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

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

const mensagens3 = validate(informacaoParametro, 'demo!')
console.log(mensagens3) // [ 'só permitir a-z, A-Z, 0-9', 'precisa incluir demo' ]

const mensagens4 = validate(informacaoParametro, 'de!mo')
console.log(mensagens4) // [ 'só permitir a-z, A-Z, 0-9', 'precisa incluir demo' ]

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

// traduzir para zh
const mensagens6 = validate(informacaoParametro, 'de', 'zh')
console.log(mensagens6) // [ 'só é permitido entrada de letras e números', 'precisa incluir demo', 'comprimento deve ser maior que 5' ]

// traduzir para zh-TW
const mensagens7 = validate(informacaoParametro, 'de', 'zh-TW')
console.log(mensagens7) // [ 'apenas letras e números são permitidos', 'precisa incluir demo', 'comprimento deve ser maior que 5' ]

Uso de Validação de Número

import { validate } from '@sumor/validator'

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

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

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

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

// traduzir para zh
const mensagens4 = validate(informacaoParametro, 4, 'zh')
console.log(mensagens4) // [ 'valor deve ser maior que 5' ]

// traduzir para zh-TW
const mensagens5 = validate(informacaoParametro, 4, 'zh-TW')
console.log(mensagens5) // [ 'valor deve ser maior que 5' ]

Uso de Formatação de String

Uso de Trim

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

import { format } from '@sumor/validator'

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

const valor = format(informacaoParametro, ' demo ')
console.log(valor) // irá imprimir "demo", os espaços inúteis serão removidos

Uso de Letras Minúsculas

irá converter a string para letras minúsculas

import { format } from '@sumor/validator'

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

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

Uso de Letras Maiúsculas

irá converter a string para letras maiúsculas

import { format } from '@sumor/validator'

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

const valor = format(informacaoParametro, '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 informacaoParametro = {
  tipo: 'number',
  decimal: 2
}

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

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

Habilitar Saída de Erro

Se você passar error:true, a resposta será um objeto SumorError.
Você pode alterar o idioma e exportar suporte json por @sumor/error

import { validate } from '@sumor/validator'

const informacaoParametro = {
  tipo: 'string',
  obrigatório: true,
  comprimento: 10,
  regra: [
    {
      code: 'LENGTH_GREATER_THAN_5',
      expressão: valor => {
        return valor.length > 5
      },
      mensagem: 'o comprimento deve ser maior que 5'
    }
  ]
}

const mensagens = validate(informacaoParametro, 'demo123456', 'en', true)
console.log(mensagens)
/* 
SumorError
{
  code: 'LENGTH_GREATER_THAN_5',
  message: 'o comprimento deve ser maior que 5'
}
*/