Jawny błąd, który może zostać zgłoszony z modułu obsługi, aby wysłać błąd do klienta, który wywołał tę funkcję.
Podpis:
export declare class HttpsError extends Error
Rozszerza: błąd
Zespoły
| Zespół | Modyfikatory | Opis |
|---|---|---|
| (konstruktor)(kod, komunikat, szczegóły) | Tworzy nową instancję klasy HttpsError |
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| kod | Kod błędu funkcji | Standardowy kod błędu, który jest zwracany klientowi. Określa też kod stanu HTTP odpowiedzi, zgodnie z definicją w pliku code.proto. | |
| szczegóły | nieznany | Dodatkowe dane do skonwertowania do formatu JSON i uwzględnienia w odpowiedzi na błąd. | |
| httpErrorCode | Kod błędu HTTP | Podany kod błędu w formie przewodu. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| toJSON(), | Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON. |
https.HttpsError.(konstruktor)
Tworzy nową instancję klasy HttpsError
Podpis:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| kod | Kod błędu funkcji | |
| wiadomość | ciąg znaków | |
| szczegóły | nieznany |
https.HttpsError.code
Standardowy kod błędu, który jest zwracany klientowi. Określa też kod stanu HTTP odpowiedzi, zgodnie z definicją w pliku code.proto.
Podpis:
readonly code: FunctionsErrorCode;
https.HttpsError.details
Dodatkowe dane do skonwertowania do formatu JSON i uwzględnienia w odpowiedzi na błąd.
Podpis:
readonly details: unknown;
https.HttpsError.httpErrorCode
Podany kod błędu w formie przewodu.
Podpis:
readonly httpErrorCode: HttpErrorCode;
https.HttpsError.toJSON()
Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON.
Podpis:
toJSON(): HttpErrorWireFormat;
Zwroty:
HttpErrorWireFormat