CLIENT_ERROR_CODES

expérimentaldepuis 0.1.0@legba-core/realtime/client

CLIENT_ERROR_CODES

Ce que ça fait

La table des codes d’erreur stables liés au client de connexion navigateur.

Signature

const CLIENT_ERROR_CODES: {
  CONNECTION_FAILED: "LEGBA_CLIENT_CONNECTION_FAILED";
  DEVICE_PERMISSION_DENIED: "LEGBA_CLIENT_DEVICE_PERMISSION_DENIED";
  NOT_CONNECTED: "LEGBA_CLIENT_NOT_CONNECTED";
  SCREEN_SHARE_ALREADY_ACTIVE: "LEGBA_CLIENT_SCREEN_SHARE_ALREADY_ACTIVE";
  SCREEN_SHARE_NOT_SUPPORTED: "LEGBA_CLIENT_SCREEN_SHARE_NOT_SUPPORTED";
  DATA_MESSAGE_NOT_SERIALIZABLE: "LEGBA_CLIENT_DATA_MESSAGE_NOT_SERIALIZABLE";
  DATA_MESSAGE_INVALID_DESTINATION: "LEGBA_CLIENT_DATA_MESSAGE_INVALID_DESTINATION";
  DATA_MESSAGE_TOO_LARGE: "LEGBA_CLIENT_DATA_MESSAGE_TOO_LARGE";
}

Voir createLegbaRoom pour le détail de quand chaque code est levé.

Paramètres

N/A — c’est une constante.

Retour

N/A — c’est une constante.

Erreurs

N/A.

Exemple minimal

import { CLIENT_ERROR_CODES } from "@legba-core/realtime/client";

console.log(CLIENT_ERROR_CODES.CONNECTION_FAILED); // "LEGBA_CLIENT_CONNECTION_FAILED"

Exemple complet

import { CLIENT_ERROR_CODES, LegbaClientError } from "@legba-core/realtime/client";

function isDevicePermissionDenied(error: unknown): boolean {
  return (
    error instanceof LegbaClientError && error.code === CLIENT_ERROR_CODES.DEVICE_PERMISSION_DENIED
  );
}

Pièges

  • DEVICE_PERMISSION_DENIED ne distingue pas micro et caméra : le message précise laquelle des deux a été refusée.

Voir aussi