Валидатор

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

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

Установка

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
    {
      code: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'только a-z, A-Z, 0-9'
    },
    // необходимо включить demo
    {
      code: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'необходимо включить demo'
    },
    // использование функции для проверки
    {
      code: '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 messages1 = validate(parameterInfo, 'demo123456')
console.log(messages1) // []

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

// остальной текст опущен для краткости

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

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  required: true,
  rule: [
    // должно быть больше 5
    {
      code: '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) // []

// остальной текст опущен для краткости

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

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

удалит ненужные пробелы из префикса и суффикса

import { format } from '@sumor/validator'

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

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

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

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

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  lowercase: true
}

const value = format(parameterInfo, 'Demo')
console.log(value) // будет выведено "demo", все символы будут преобразованы в нижний регистр

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

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

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  uppercase: true
}

const value = format(parameterInfo, 'Demo')
console.log(value) // будет выведено "DEMO", все символы будут преобразованы в верхний регистр

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

import { format } from '@sumor/validator'

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

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

// остальной текст опущен для краткости

Включить вывод ошибки

Если вы передадите error:true, ответ будет объект SumorError.
Вы можете изменить язык и экспортировать поддержку json с помощью @sumor/error

import { validate } from '@sumor/validator'

const parameterInfo = {
  error: true,
  type: 'string',
  required: true,
  length: 10,
  rule: [
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'длина должна быть больше 5'
    }
  ]
}

const messages = validate(parameterInfo, 'demo123456', 'en', true)
console.log(messages)
/* 
SumorError
{
  code: 'LENGTH_GREATER_THAN_5',
  message: 'длина должна быть больше 5'
}
*/