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.

Instalação

npm i @sumor/validator --save

Pré-requisitos

Versão do Node.JS

Requer Node.JS na 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 informaçõesParâmetro = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    // permitir apenas a-z, A-Z, 0-9
    {
      code: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'apenas permitir a-z, A-Z, 0-9'
    },
    // precisa incluir "demo"
    {
      code: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'precisa incluir demo'
    },
    // usar função para verificar o comprimento
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'o comprimento deve ser maior que 5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: 'só permitir letras e números',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deveria ser maior que 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'só permitir letras e números',
      INCLUDE_DEMO: 'precisa incluir demo',
      LENGTH_GREATER_THAN_5: 'comprimento deveria 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', 'o comprimento deve ser maior que 5' ]

// tradução para zh
const mensagens6 = validate(informaçõesParâmetro, 'de', 'zh')
console.log(mensagens6) // [ 'só permitir letras e números', 'precisa incluir demo', 'comprimento deveria ser maior que 5' ]

// tradução para zh-TW
const mensagens7 = validate(informaçõesParâmetro, 'de', 'zh-TW')
console.log(mensagens7) // [ 'só permitir letras e números', 'precisa incluir demo', 'comprimento deveria ser maior que 5' ]

Uso de Validação de Número

import { validate } from '@sumor/validator'

const informaçõesParâmetro = {
  type: 'number',
  required: true,
  rule: [
    // precisa ser maior que 5
    {
      code: 'GREATER_THAN_5',
      expression: value => {
        return value > 5
      },
      message: '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' ]

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

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

Uso de Formatação de String

Uso de Trim

irá remover os espaços desnecessários no prefixo e sufixo

import { format } from '@sumor/validator'

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

const valor = format(informaçõesParâmetro, ' demo ')
console.log(valor) // irá imprimir "demo", os espaços desnecessários serão removidos

Uso de Minúsculas

irá converter a string para minúsculas

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  type: 'string',
  lowercase: 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 = {
  type: 'string',
  uppercase: 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 Formatação de Número

import { format } from '@sumor/validator'

const informaçõesParâmetro = {
  type: '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

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 informaçõesParâmetro = {
  error: true,
  type: 'string',
  required: true,
  length: 10,
  rule: [
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'length should be greater than 5'
    }
  ]
}

const mensagens = validate(informaçõesParâmetro, 'demo123456')
console.log(mensagens)
/* 
SumorError
{
  code: 'LENGTH_GREATER_THAN_5',
  message: 'length should be greater than 5'
}
*/