バリデータ

これは 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 のみを許可
    {
      id: 'ONLY_CHAR_DIGIT',
      expression: '^[a-zA-Z0-9]*$',
      message: 'only allow a-z, A-Z, 0-9'
    },
    // demo を含める必要がある
    {
      id: 'INCLUDE_DEMO',
      expression: 'demo',
      message: 'need include demo'
    },
    // 関数を使用してチェックする
    {
      id: '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' ]

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

// 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 より大きい必要がある
    {
      id: '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' ]

// 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',
  trim: true // string タイプのデフォルトは 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 桁の小数点以下のみが保持されます

const value2 = format(parameterInfo, '1.234')
console.log(value2) // 数値 1.23 に変換され、2 桁の小数点以下のみが保持されます