LegbaTokenError

expérimentaldepuis 0.1.0@legba-core/realtime

LegbaTokenError

Ce que ça fait

Erreur levée quand une requête d’émission de jeton est invalide. Toujours du code LEGBA_INVALID_TOKEN_REQUEST.

Signature

class LegbaTokenError extends LegbaError {
  constructor(code: "LEGBA_INVALID_TOKEN_REQUEST", message: string);
}

Généré par defineErrorType.

Paramètres

NomTypeRequisDéfautDescription
code"LEGBA_INVALID_TOKEN_REQUEST"ouiToujours TOKEN_ERROR_CODES.INVALID_TOKEN_REQUEST, seul code du domaine
messagestringouiCite le champ invalide et la valeur reçue

Retour

Une instance de LegbaTokenError, avec code === "LEGBA_INVALID_TOKEN_REQUEST" et name === "LegbaTokenError".

Erreurs

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

Exemple minimal

import { createAccessToken, LegbaTokenError } from "@legba-core/realtime";

try {
  await createAccessToken({ apiKey: "k", apiSecret: "s", roomName: "", identity: "a", role: "host" });
} catch (error) {
  if (error instanceof LegbaTokenError) {
    console.error(error.message); // "roomName ne peut pas être une chaîne vide."
  }
}

Exemple complet

Voir createAccessToken, qui lève cette erreur avant tout appel réseau vers LiveKit.

Pièges

  • LegbaTokenError étend LegbaError (de @legba-core/core) : instanceof LegbaError fonctionne aussi, mais préférer instanceof LegbaTokenError pour cibler spécifiquement les erreurs de requête de jeton.

Voir aussi