Erreur explicite qui peut être générée par un gestionnaire pour envoyer une erreur au client qui a appelé la fonction.
Signature:
export declare class HttpsError extends Error
Extension : erreur
Constructeurs
| Constructeur | Modificateurs | Description |
|---|---|---|
| (constructeur)(code, message, détails) | Construit une nouvelle instance de la classe HttpsError |
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| code | FonctionsErrorCode | Un code d'erreur standard qui sera renvoyé au client. Cela détermine également le code d'état HTTP de la réponse, tel que défini dans code.proto. | |
| détails | inconnu | Données supplémentaires à convertir en JSON et incluses dans la réponse d'erreur. | |
| httpCode d'erreur | HttpErrorCode | Représentation au format filaire d'un code d'erreur fourni. |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| versJSON() | Renvoie une représentation sérialisable JSON de cet objet. |
identité.HttpsError.(constructeur)
Construit une nouvelle instance de la classe HttpsError
Signature:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| code | FonctionsErrorCode | |
| message | chaîne | |
| détails | inconnu |
identité.HttpsError.code
Un code d'erreur standard qui sera renvoyé au client. Cela détermine également le code d'état HTTP de la réponse, tel que défini dans code.proto.
Signature:
readonly code: FunctionsErrorCode;
identité.HttpsError.details
Données supplémentaires à convertir en JSON et incluses dans la réponse d'erreur.
Signature:
readonly details: unknown;
identité.HttpsError.httpErrorCode
Représentation au format filaire d'un code d'erreur fourni.
Signature:
readonly httpErrorCode: HttpErrorCode;
identité.HttpsError.toJSON()
Renvoie une représentation sérialisable JSON de cet objet.
Signature:
toJSON(): HttpErrorWireFormat;
Retour:
HttpErrorWireFormat