https.HttpsError class

Ein expliziter Fehler, der von einem Handler ausgelöst werden kann, um einen Fehler an den Client zu senden, der die Funktion aufgerufen hat.

Unterschrift:

export declare class HttpsError extends Error 

Erweitert: Fehler

Konstrukteure

Konstrukteur	Modifikatoren	Beschreibung
(Konstruktor)(Code, Nachricht, Details)		Konstruiert eine neue Instanz der HttpsError Klasse

Eigenschaften

Eigentum	Modifikatoren	Typ	Beschreibung
Code		FunctionsErrorCode	Ein Standardfehlercode, der an den Client zurückgegeben wird. Dadurch wird auch der HTTP-Statuscode der Antwort bestimmt, wie in code.proto definiert.
Einzelheiten		Unbekannt	Zusätzliche Daten, die in JSON konvertiert und in die Fehlerantwort einbezogen werden sollen.
httpErrorCode		HttpErrorCode	Eine Wire-Format-Darstellung eines bereitgestellten Fehlercodes.

Methoden

Methode	Modifikatoren	Beschreibung
toJSON()		Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.

https.HttpsError.(Konstruktor)

Konstruiert eine neue Instanz der HttpsError Klasse

Unterschrift:

constructor(code: FunctionsErrorCode, message: string, details?: unknown);

Parameter

Parameter	Typ	Beschreibung
Code	FunctionsErrorCode
Nachricht	Zeichenfolge
Einzelheiten	Unbekannt

https.HttpsError.code

Ein Standardfehlercode, der an den Client zurückgegeben wird. Dadurch wird auch der HTTP-Statuscode der Antwort bestimmt, wie in code.proto definiert.

Unterschrift:

readonly code: FunctionsErrorCode;

https.HttpsError.details

Zusätzliche Daten, die in JSON konvertiert und in die Fehlerantwort einbezogen werden sollen.

Unterschrift:

readonly details: unknown;

https.HttpsError.httpErrorCode

Eine Wire-Format-Darstellung eines bereitgestellten Fehlercodes.

Unterschrift:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.

Unterschrift:

toJSON(): HttpErrorWireFormat;

Kehrt zurück:

HttpErrorWireFormat