エラー

Sumor Cloud ツール。
追加のドキュメント 複数言語、事前定義エラーコード、およびデータの渡し先をサポートするエラーハンドリングライブラリ。

インストール方法

npm i @sumor/error --save

前提条件

Node.JSバージョン

Node.JS バージョン 18.x 以上が必要

Node.JS ESモジュールが必要

このパッケージは ESモジュールで書かれているため、
package.jsonファイル内の以下のコードを変更してください:

{
  "type": "module"
}

使用法

エラーを定義

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'ユーザーが見つかりません',
    USER_EXISTED: 'ユーザー{name}が存在します'
  }
})

throw new MyError('USER_NOT_FOUND')
// 出力: エラー: ユーザーが見つかりません

throw new MyError('USER_EXISTED', { name: 'Alice' })
// 出力: エラー: ユーザーAliceが存在します

複数言語対応

import defineError from '@sumor/error'

const MyError = defineError({
  language: 'en', // デフォルト言語
  code: {
    USER_NOT_FOUND: 'ユーザーが見つかりません',
    USER_EXISTED: 'ユーザー{name}が存在します'
  },
  i18n: {
    zh: {
      USER_NOT_FOUND: '用户未找到',
      USER_EXISTED: '用户 {name} 已存在'
    }
  }
})

const error = new MyError('USER_EXISTED', { name: 'Alice' })
error.language = 'en' // エラー言語を変更
console.log(error)
// 出力: エラー: ユーザーAliceが存在します

error.language = 'zh' // エラー言語を変更
console.log(error)
// 出力: エラー: 用户Alice已存在

エラーをJSON形式に変換

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'ユーザーが見つかりません',
    USER_EXISTED: 'ユーザー{name}が存在します'
  }
})

const error = new MyError('USER_EXISTED', { name: 'Alice' })
console.log(error.json())
// 出力: {"code":"USER_EXISTED","message":"ユーザーAliceが存在します"}

基本となるエラー

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'フィールドの検証に失敗しました',
    FIELD_CANNOT_EMPTY: 'フィールド{name}は空にできません',
    FIELD_TOO_LONG: 'フィールド{name}が長すぎます'
  },
  i18n: {
    zh: {
      FIELD_VERIFY_FAILED: '字段验证失败',
      FIELD_CANNOT_EMPTY: '字段{name}不能为空',
      FIELD_TOO_LONG: '字段{name}过长'
    }
  }
})

const error = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'username' }),
  new MyError('FIELD_TOO_LONG', { name: 'password' })
])

console.log(error.json())
/* 
出力:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"フィールドの検証に失敗しました",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"フィールドusernameは空にできません"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"フィールドpasswordが長すぎます"
    }
  ]
}
*/

error.language = 'zh'
console.log(error.json())
/*
出力:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"字段验证失败",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"字段username不能为空"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"字段password过长"
    }
  ]
}
*/

標準エラーを組み合わせる

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'フィールドの検証に失敗しました',
    FIELD_CANNOT_EMPTY: 'フィールド{name}は空にできません',
    FIELD_TOO_LONG: 'フィールド{name}が長すぎます'
  }
})

const error = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'username' }),
  new MyError('FIELD_TOO_LONG', { name: 'password' }),
  new Error('未知のエラー')
])

console.log(error.json())
/*
出力:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"フィールドの検証に失敗しました",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"フィールドusernameは空にできません"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"フィールドpasswordが長すぎます"
    },{
      "code":"UNKNOWN_ERROR",
      "message":"Unknown Error"
    }
  ]
}
 */