Ошибка

Sumor Cloud Инструмент.
Документация Библиотека обработки ошибок, поддерживающая многоязычность, предопределенные коды ошибок и передачу данных.

Установка

npm i @sumor/error --save

Предварительные требования

Версия Node.JS

Требуется Node.JS версии 16.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')
// вывод: Error: Пользователь не найден

throw new MyError('USER_EXISTED', { name: 'Alice' })
// вывод: Error: Пользователь 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)
// вывод: Error: Пользователь Alice существует

error.language = 'zh' // изменить язык ошибки
console.log(error)
// вывод: 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":"Неизвестная ошибка"
    }
  ]
}
 */