validator

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 parameterInfo = {
  type: 'string',
  required: true,
  length: 10,
  rule: [
    // a-z, A-Z, 0-9만 허용
    {
      code: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'only allow a-z, A-Z, 0-9'
    },
    // demo를 포함해야 함
    {
      code: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'need include demo'
    },
    // 함수를 사용하여 확인
    {
      code: 'LENGTH_GREATER_THAN_5',
      expression: value => {
        return value.length > 5
      },
      message: 'length should be greater than 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) // [ 'only allow a-z, A-Z, 0-9' ]

const messages3 = validate(parameterInfo, 'demo!')
console.log(messages3) // [ 'only allow a-z, A-Z, 0-9', 'need include demo' ]

const messages4 = validate(parameterInfo, 'de!mo')
console.log(messages4) // [ 'only allow a-z, A-Z, 0-9', 'need include demo' ]

const messages5 = validate(parameterInfo, 'de')
console.log(messages5) // [ 'only allow a-z, A-Z, 0-9', 'need include demo', 'length should be greater than 5' ]

// 번역 to zh
const messages6 = validate(parameterInfo, 'de', 'zh')
console.log(messages6) // [ '只允许输入字母和数字', '需要包含demo', '长度应大于5' ]

// 번역 to zh-TW
const messages7 = validate(parameterInfo, 'de', 'zh-TW')
console.log(messages7) // [ '只允許輸入字母和數字', '需要包含demo', '長度應大於5' ]

숫자 유효성 검사 사용법

import { validate } from '@sumor/validator'

const parameterInfo = {
  type: 'number',
  required: true,
  rule: [
    // 5보다 커야 함
    {
      code: 'GREATER_THAN_5',
      expression: value => {
        return value > 5
      },
      message: 'value should be greater than 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) // [ 'value should be greater than 5' ]

const messages3 = validate(parameterInfo, 4)
console.log(messages3) // [ 'value should be greater than 5' ]

// 번역 to zh
const messages4 = validate(parameterInfo, 4, 'zh')
console.log(messages4) // [ '值应大于5' ]

// 번역 to zh-TW
const messages5 = validate(parameterInfo, 4, 'zh-TW')
console.log(messages5) // [ '值應大於5' ]

문자열 형식 사용법

Trim 사용법

접두사와 접미사의 불필요한 공백을 제거합니다.

import { format } from '@sumor/validator'

const parameterInfo = {
  type: 'string',
  trim: true // 문자열 유형에 대해 기본값은 true입니다.
}

const value = format(parameterInfo, ' demo ')
console.log(value) // "demo"가 출력됩니다. 불필요한 공백이 제거됩니다

Lowercase 사용법

문자열을 소문자로 변환합니다.

import { format } from '@sumor/validator'

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

const value = format(parameterInfo, 'Demo')
console.log(value) // "demo"가 출력됩니다. 모든 문자가 소문자로 변환됩니다

Uppercase 사용법

문자열을 대문자로 변환합니다.

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자리만 유지됩니다

const value2 = format(parameterInfo, '1.234')
console.log(value2) // 숫자 1.23으로 변환됩니다. 소수점 이하 2자리만 유지됩니다

오류 출력 활성화

오류: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: 'length should be greater than 5'
    }
  ]
}

const messages = validate(parameterInfo, 'demo123456', 'en', true)
console.log(messages)
/* 
SumorError
{
  code: 'LENGTH_GREATER_THAN_5',
  message: 'length should be greater than 5'
}
*/