@sumor/validator

валидатор

Инструмент Sumor Cloud.
Дополнительная документация

Это легкий валидатор для Node.JS. Он может проверять входную строку или число на основе заданных вами правил.

CI Test Coverage Audit

Установка

npm i @sumor/validator --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 16.x или выше

требуется модуль ES Node.JS

Поскольку этот пакет написан на модуле ES, пожалуйста, измените следующий код в вашем файле package.json:

{
  "type": "module"
}

Использование

Использование проверки строки

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    // разрешены только a-z, A-Z, 0-9
    {
      id: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'разрешены только a-z, A-Z, 0-9'
    },
    // необходимо включить demo
    {
      id: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'необходимо включить demo'
    },
    // использование функции для проверки
    {
      id: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'длина должна быть больше 5'
    }
  ],
  i18n: {
    zh: {
      ONLY_CHAR_DIGIT: 'только буквы и цифры',
      INCLUDE_DEMO: 'нужно включить демо',
      LENGTH_GREATER_THAN_5: 'длина должна быть больше 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'только буквы и цифры',
      INCLUDE_DEMO: 'нужно включить демо',
      LENGTH_GREATER_THAN_5: 'длина должна быть больше 5'
    }
  }
}

const messages1 = validate(parameterInfo, 'demo123456')
console.log(messages1) // []

const messages2 = validate(parameterInfo, 'de1234567')
console.log(messages2) // [ 'разрешены только a-z, A-Z, 0-9' ]

const messages3 = validate(parameterInfo, 'demo!')
console.log(messages3) // [ 'разрешены только a-z, A-Z, 0-9', 'необходимо включить demo' ]

const messages4 = validate(parameterInfo, 'de!mo')
console.log(messages4) // [ 'разрешены только a-z, A-Z, 0-9', 'необходимо включить demo' ]

const messages5 = validate(parameterInfo, 'de')
console.log(messages5) // [ 'разрешены только a-z, A-Z, 0-9', 'необходимо включить demo', 'длина должна быть больше 5' ]

// перевести на zh
const messages6 = validate(parameterInfo, 'de', 'zh')
console.log(messages6) // [ 'только буквы и цифры', 'нужно включить демо', 'длина должна быть больше 5' ]

// перевести на zh-TW
const messages7 = validate(parameterInfo, 'de', 'zh-TW')
console.log(messages7) // [ 'только буквы и цифры', 'нужно включить демо', 'длина должна быть больше 5' ]

Использование проверки числа

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  required: true,
  rule: [
    // должно быть больше 5
    {
      id: 'GREATER_THAN_5',
      expression: value => {
        return value > 5
      },
      message: 'значение должно быть больше 5'
    }
  ],
  i18n: {
    zh: {
      GREATER_THAN_5: 'значение должно быть больше 5'
    },
    'zh-TW': {
      GREATER_THAN_5: 'значение должно быть больше 5'
    }
  }
}

const messages1 = validate(parameterInfo, 6)
console.log(messages1) // []

const messages2 = validate(parameterInfo, 5)
console.log(messages2) // [ 'значение должно быть больше 5' ]

const messages3 = validate(parameterInfo, 4)
console.log(messages3) // [ 'значение должно быть больше 5' ]

// перевести на zh
const messages4 = validate(parameterInfo, 4, 'zh')
console.log(messages4) // [ 'значение должно быть больше 5' ]

// перевести на zh-TW
const messages5 = validate(parameterInfo, 4, 'zh-TW')
console.log(messages5) // [ 'значение должно быть больше 5' ]

Использование форматирования строки

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string'
}

const value1 = format(parameterInfo, ' demo ')
console.log(value1) // будет напечатано "demo", лишние пробелы будут удалены

Использование форматирования числа

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  decimal: 2
}

const value1 = format(parameterInfo, 1.234)
console.log(value1) // будет напечатано 1.23, оставлено только 2 десятичных знака

const value2 = format(parameterInfo, '1.234')
console.log(value2) // будет преобразовано в число 1.23, оставлено только 2 десятичных знака