Erreur

Un outil Sumor Cloud.
Plus de documentation Une bibliothèque de gestion des erreurs prenant en charge plusieurs langues, des codes d'erreur prédéfinis et des données de passage.

Installation

npm i @sumor/error --save

Prérequis

Version de Node.JS

Nécessite la version 16.x ou supérieure de Node.JS.

Nécessite un module ES de Node.JS

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

Définir une erreur

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'Utilisateur non trouvé',
    USER_EXISTED: 'Utilisateur {name} existait'
  }
})

throw new MyError('USER_NOT_FOUND')
// sortie: Erreur: Utilisateur non trouvé

throw new MyError('USER_EXISTED', { name: 'Alice' })
// sortie: Erreur: L'utilisateur Alice existait

Multilingue

import defineError from '@sumor/error'

const MyError = defineError({
  language: 'fr', // langue par défaut
  code: {
    USER_NOT_FOUND: 'Utilisateur non trouvé',
    USER_EXISTED: 'Utilisateur {name} existait'
  },
  i18n: {
    zh: {
      USER_NOT_FOUND: 'Utilisateur non trouvé',
      USER_EXISTED: 'Utilisateur {name} existait'
    }
  }
})

const erreur = new MyError('USER_EXISTED', { name: 'Alice' })
erreur.language = 'fr' // changer la langue de l'erreur
console.log(erreur)
// sortie: Erreur: L'utilisateur Alice existait

erreur.language = 'zh' // changer la langue de l'erreur
console.log(erreur)
// sortie: Erreur: Utilisateur Alice existait

Convertir l'erreur en JSON

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    USER_NOT_FOUND: 'Utilisateur non trouvé',
    USER_EXISTED: 'Utilisateur {name} existait'
  }
})

const erreur = new MyError('USER_EXISTED', { name: 'Alice' })
console.log(erreur.json())
// sortie: {"code":"USER_EXISTED","message":"L'utilisateur Alice existait"}

Erreur sous-jacente

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Échec de la vérification du champ',
    FIELD_CANNOT_EMPTY: 'Le champ {name} ne peut pas être vide',
    FIELD_TOO_LONG: 'Le champ {name} est trop long'
  },
  i18n: {
    zh: {
      FIELD_VERIFY_FAILED: 'Échec de la vérification du champ',
      FIELD_CANNOT_EMPTY: 'Le champ {name} ne peut pas être vide',
      FIELD_TOO_LONG: 'Le champ {name} est trop long'
    }
  }
})

const erreur = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'nom d'utilisateur' }),
  new MyError('FIELD_TOO_LONG', { name: 'mot de passe' })
])

console.log(erreur.json())
/*
sortie:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Échec de la vérification du champ",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Le champ nom d'utilisateur ne peut pas être vide"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Le champ mot de passe est trop long"
    }
  ]
}
*/

erreur.language = 'fr'
console.log(erreur.json())
/*
sortie:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Échec de la vérification du champ",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Le champ nom d'utilisateur ne peut pas être vide"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Le champ mot de passe est trop long"
    }
  ]
}
*/

Combinaison d'erreurs standard

import defineError from '@sumor/error'

const MyError = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Échec de la vérification du champ',
    FIELD_CANNOT_EMPTY: 'Le champ {name} ne peut pas être vide',
    FIELD_TOO_LONG: 'Le champ {name} est trop long'
  }
})

const erreur = new MyError('FIELD_VERIFY_FAILED', {}, [
  new MyError('FIELD_CANNOT_EMPTY', { name: 'nom d'utilisateur' }),
  new MyError('FIELD_TOO_LONG', { name: 'mot de passe' }),
  new Error('Erreur inconnue')
])

console.log(erreur.json())
/*
sortie:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Échec de la vérification du champ",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Le champ nom d'utilisateur ne peut pas être vide"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Le champ mot de passe est trop long"
    },{
      "code":"UNKNOWN_ERROR",
      "message":"Erreur inconnue"
    }
  ]
}
 */