@sumor/validator

validator

Sumor Cloud 도구.
더 많은 문서

Node.JS용 가벼운 유효성 검사 도구입니다.
정의한 규칙에 따라 입력 문자열이나 숫자를 유효성 검사할 수 있습니다.

CI 테스트 Coverage 감사

설치

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만 허용
    {
      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 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보다 커야 함' ]

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

// 번역하기: 중국어(번체)
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보다 커야 함
    {
      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보다 커야 함' ]

// 번역하기: 중국어
const messages4 = validate(parameterInfo, 4, 'zh')
console.log(messages4) // [ '值应大于5' ]

// 번역하기: 중국어(번체)
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자리만 유지됩니다.