LegbaConfigError

expérimentaldepuis 0.1.0@legba-core/core

LegbaConfigError

Ce que ça fait

Erreur levée quand une configuration @legba-core est invalide. Toujours du code LEGBA_INVALID_CONFIG.

Signature

class LegbaConfigError extends LegbaError {
  constructor(code: "LEGBA_INVALID_CONFIG", message: string);
}

Généré par defineErrorType — voir ses pièges sur la forme du constructeur.

Paramètres

NomTypeRequisDéfautDescription
code"LEGBA_INVALID_CONFIG"ouiToujours ERROR_CODES.INVALID_CONFIG, seul code du domaine
messagestringouiCite le champ invalide et la valeur reçue

Retour

Une instance de LegbaConfigError, avec code === "LEGBA_INVALID_CONFIG" et name === "LegbaConfigError".

Erreurs

N/A — c’est la classe d’erreur elle-même.

Exemple minimal

import { validateConfig, LegbaConfigError } from "@legba-core/core";

try {
  validateConfig({ appName: "" });
} catch (error) {
  if (error instanceof LegbaConfigError) {
    console.error(error.message); // "appName ne peut pas être une chaîne vide."
  }
}

Exemple complet

Voir createLegbaCore, qui lève cette erreur avant toute autre initialisation.

Pièges

  • Le code LEGBA_INVALID_CONFIG est partagé par toutes les erreurs de configuration, quel que soit le champ en cause : distinguer les cas par le texte du message, jamais par le code seul.

Voir aussi