Fehler

Ein Sumor Cloud Tool.
Weitere Dokumentation
Ein Fehlerbehandlungs-Library, die Mehrsprachen, vordefinierte Fehlercodes und das Übergeben von Daten unterstützt.

Installation

npm i @sumor/error --save

Voraussetzungen

Node.JS Version

Erfordert Node.JS Version 16.x oder höher.

Erforderliches Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

Fehler Definieren

import defineError from '@sumor/error'

const MeinFehler = defineError({
  code: {
    USER_NOT_FOUND: 'Benutzer nicht gefunden',
    USER_EXISTED: 'Benutzer {name} existiert'
  }
})

throw new MeinFehler('USER_NOT_FOUND')
// Ausgabe: Error: Benutzer nicht gefunden

throw new MeinFehler('USER_EXISTED', { name: 'Alice' })
// Ausgabe: Error: Benutzer Alice existiert

Mehrsprachig

import defineError from '@sumor/error'

const MeinFehler = defineError({
  language: 'de', // Standardsprache
  code: {
    USER_NOT_FOUND: 'Benutzer nicht gefunden',
    USER_EXISTED: 'Benutzer {name} existiert'
  },
  i18n: {
    en: {
      USER_NOT_FOUND: 'User not found',
      USER_EXISTED: 'User {name} existed'
    }
  }
})

const fehler = new MeinFehler('USER_EXISTED', { name: 'Alice' })
fehler.language = 'de' // Sprache des Fehlers ändern
console.log(fehler)
// Ausgabe: Error: Benutzer Alice existiert

fehler.language = 'en' // Sprache des Fehlers ändern
console.log(fehler)
// Ausgabe: Error: User Alice existed

Fehler in JSON umwandeln

import defineError from '@sumor/error'

const MeinFehler = defineError({
  code: {
    USER_NOT_FOUND: 'Benutzer nicht gefunden',
    USER_EXISTED: 'Benutzer {name} existiert'
  }
})

const fehler = new MeinFehler('USER_EXISTED', { name: 'Alice' })
console.log(fehler.json())
// Ausgabe: {"code":"USER_EXISTED","message":"Benutzer Alice existiert"}

Grundlegender Fehler

import defineError from '@sumor/error'

const MeinFehler = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Feldüberprüfung fehlgeschlagen',
    FIELD_CANNOT_EMPTY: 'Das Feld {name} darf nicht leer sein',
    FIELD_TOO_LONG: 'Das Feld {name} ist zu lang'
  },
  i18n: {
    en: {
      FIELD_VERIFY_FAILED: 'Field verify failed',
      FIELD_CANNOT_EMPTY: 'Field {name} cannot be empty',
      FIELD_TOO_LONG: 'Field {name} is too long'
    }
  }
})

const fehler = new MeinFehler('FIELD_VERIFY_FAILED', {}, [
  new MeinFehler('FIELD_CANNOT_EMPTY', { name: 'Benutzername' }),
  new MeinFehler('FIELD_TOO_LONG', { name: 'Passwort' })
])

console.log(fehler.json())
/* 
Ausgabe: 
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Feldüberprüfung fehlgeschlagen",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Das Feld Benutzername darf nicht leer sein"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Das Feld Passwort ist zu lang"
    }
  ]
}
*/

fehler.language = 'en'
console.log(fehler.json())
/*
Ausgabe:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Field verify failed",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Field username cannot be empty"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Field password is too long"
    }
  ]
}
*/

Standardfehler kombinieren

import defineError from '@sumor/error'

const MeinFehler = defineError({
  code: {
    FIELD_VERIFY_FAILED: 'Feldüberprüfung fehlgeschlagen',
    FIELD_CANNOT_EMPTY: 'Das Feld {name} darf nicht leer sein',
    FIELD_TOO_LONG: 'Das Feld {name} ist zu lang'
  }
})

const fehler = new MeinFehler('FIELD_VERIFY_FAILED', {}, [
  new MeinFehler('FIELD_CANNOT_EMPTY', { name: 'Benutzername' }),
  new MeinFehler('FIELD_TOO_LONG', { name: 'Passwort' }),
  new Error('Unbekannter Fehler')
])

console.log(fehler.json())
/*
Ausgabe:
{
  "code":"FIELD_VERIFY_FAILED",
  "message":"Feldüberprüfung fehlgeschlagen",
  "errors":[
    {
      "code":"FIELD_CANNOT_EMPTY",
      "message":"Das Feld Benutzername darf nicht leer sein"
    },{
      "code":"FIELD_TOO_LONG",
      "message":"Das Feld Passwort ist zu lang"
    },{
      "code":"UNBEKANNTER_FEHLER",
      "message":"Unbekannter Fehler"
    }
  ]
}
 */