LegbaRolePolicyError

expérimentaldepuis 0.1.0@legba-core/realtime

LegbaRolePolicyError

Ce que ça fait

Erreur levée par resolveRole quand la politique de rôle elle-même est mal configurée — jamais à cause d’une entrée utilisateur.

Signature

class LegbaRolePolicyError extends LegbaError {
  constructor(code: RolePolicyErrorCode, message: string);
}

Paramètres

NomTypeRequisDéfautDescription
codeRolePolicyErrorCodeouiUn des codes de ROLE_POLICY_ERROR_CODES
messagestringouiMessage actionnable

Retour

Une instance de LegbaRolePolicyError, avec name === "LegbaRolePolicyError".

Erreurs

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

Exemple minimal

import { resolveRole, LegbaRolePolicyError } from "@legba-core/realtime";

try {
  resolveRole(policy, roomName, externalRole, "participant");
} catch (error) {
  if (error instanceof LegbaRolePolicyError) {
    console.error("politique de rôle mal configurée :", error.message);
  }
}

Exemple complet

Voir resolveRole.

Pièges

  • Toujours le signe d’une politique mal construite (une valeur hors "host"/"participant"/"viewer", souvent issue d’une config JSON externe) — jamais causée par un externalRole inattendu, qui tombe simplement sur le fallback sans lever d’erreur.

Voir aussi