Jawny błąd, który może zostać zgłoszony przez procedurę obsługi w celu wysłania błędu do klienta, który wywołał funkcję.
Podpis:
export declare class HttpsError extends Error
Rozszerza się: Błąd
Konstruktorzy
Konstruktor | Modyfikatory | Opis |
---|---|---|
(konstruktor)(kod, komunikat, szczegóły) | Konstruuje nowe wystąpienie klasy HttpsError |
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
kod | FunkcjeKod błędu | Standardowy kod błędu, który zostanie zwrócony klientowi. Określa to również kod stanu HTTP odpowiedzi, zgodnie z definicją w code.proto. | |
Detale | nieznany | Dodatkowe dane do przekonwertowania na JSON i uwzględnione w odpowiedzi na błąd. | |
httpKod błędu | Kod błędu Http | Reprezentacja w formacie przewodowym podanego kodu błędu. |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
doJSON() | Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON. |
auth.HttpsError.(konstruktor)
Konstruuje nowe wystąpienie klasy HttpsError
Podpis:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parametry
Parametr | Typ | Opis |
---|---|---|
kod | FunkcjeKod błędu | |
wiadomość | strunowy | |
Detale | nieznany |
auth.HttpsError.code
Standardowy kod błędu, który zostanie zwrócony klientowi. Określa to również kod stanu HTTP odpowiedzi, zgodnie z definicją w code.proto.
Podpis:
readonly code: FunctionsErrorCode;
auth.HttpsError.details
Dodatkowe dane do przekonwertowania na JSON i uwzględnione w odpowiedzi na błąd.
Podpis:
readonly details: unknown;
auth.HttpsError.httpErrorCode
Reprezentacja w formacie przewodowym podanego kodu błędu.
Podpis:
readonly httpErrorCode: HttpErrorCode;
auth.HttpsError.toJSON()
Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON.
Podpis:
toJSON(): HttpErrorWireFormat;
Zwroty:
HttpErrorWireFormat