validator

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

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

Установка

npm i @sumor/validator --save

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

Версия Node.JS

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

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

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

{
  "type": "module"
}

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

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

import { validate } from '@sumor/validator'

const информацияОПараметре = {
  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: 'должно содержать demo',
      LENGTH_GREATER_THAN_5: 'длина должна быть больше 5'
    },
    'zh-TW': {
      ONLY_CHAR_DIGIT: 'только буквы и цифры',
      INCLUDE_DEMO: 'должно содержать demo',
      LENGTH_GREATER_THAN_5: 'длина должна быть больше 5'
    }
  }
}

const сообщения1 = validate(информацияОПараметре, 'demo123456')
console.log(сообщения1) // []

const сообщения2 = validate(информацияОПараметре, 'de1234567')
console.log(сообщения2) // [ 'разрешены только a-z, A-Z, 0-9' ]

const сообщения3 = validate(информацияОПараметре, 'demo!')
console.log(сообщения3) // [ 'разрешены только a-z, A-Z, 0-9', 'должно содержать demo' ]

const сообщения4 = validate(информацияОПараметре, 'de!mo')
console.log(сообщения4) // [ 'разрешены только a-z, A-Z, 0-9', 'должно содержать demo' ]

const сообщения5 = validate(информацияОПараметре, 'de')
console.log(сообщения5) // [ 'разрешены только a-z, A-Z, 0-9', 'должно содержать demo', 'длина должна быть больше 5' ]

// перевод на zh
const сообщения6 = validate(информацияОПараметре, 'de', 'zh')
console.log(сообщения6) // [ 'только буквы и цифры', 'должно содержать demo', 'длина должна быть больше 5' ]

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

Использование валидации для числа

import { validate } from '@sumor/validator'

const информацияОПараметре = {
  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 сообщения1 = validate(информацияОПараметре, 6)
console.log(сообщения1) // []

const сообщения2 = validate(информацияОПараметре, 5)
console.log(сообщения2) // [ 'значение должно быть больше 5' ]

const сообщения3 = validate(информацияОПараметре, 4)
console.log(сообщения3) // [ 'значение должно быть больше 5' ]

// перевод на zh
const сообщения4 = validate(информацияОПараметре, 4, 'zh')
console.log(сообщения4) // [ 'значение должно быть больше 5' ]

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

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

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

удалит лишние пробелы в начале и конце

import { format } from '@sumor/validator'

const информацияОПараметре = {
  type: 'string',
  trim: true // по умолчанию для строк
}

const значение = format(информацияОПараметре, ' демо ')
console.log(значение) // будет "демо", лишние пробелы будут удалены

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

преобразует строку в нижний регистр

import { format } from '@sumor/validator'

const информацияОПараметре = {
  type: 'string',
  lowercase: true
}

const значение = format(информацияОПараметре, 'Демо')
console.log(значение) // будет "демо", все символы будут преобразованы в нижний регистр

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

преобразует строку в верхний регистр

import { format } from '@sumor/validator'

const информацияОПараметре = {
  type: 'string',
  uppercase: true
}

const значение = format(информацияОПараметре, 'Демо')
console.log(значение) // будет "ДЕМО", все символы будут преобразованы в верхний регистр

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

import { format } from '@sumor/validator'

const информацияОПараметре = {
  type: 'number',
  decimal: 2
}

const значение1 = format(информацияОПараметре, 1.234)
console.log(значение1) // будет 1.23, оставлены только 2 десятичных знака

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