İşlevi çağıran istemciye bir hata göndermek için işleyiciden atılabilecek açık bir hata.
İmza:
export declare class HttpsError extends Error
Genişletmeler: Hata
İnşaatçılar
Oluşturucu | Değiştiriciler | Tanım |
---|---|---|
(yapıcı)(kod, mesaj, ayrıntılar) | HttpsError sınıfının yeni bir örneğini oluşturur |
Özellikler
Mülk | Değiştiriciler | Tip | Tanım |
---|---|---|---|
kod | FonksiyonlarHataKodu | İstemciye döndürülecek standart bir hata kodu. Bu aynı zamanda code.proto'da tanımlandığı gibi yanıtın HTTP durum kodunu da belirler. | |
detaylar | Bilinmeyen | JSON'a dönüştürülecek ve hata yanıtına dahil edilecek ekstra veriler. | |
httpHataKodu | HttpErrorCode | Sağlanan bir hata kodunun kablolu format temsili. |
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
JSON()'a | Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür. |
auth.HttpsError.(yapıcı)
HttpsError
sınıfının yeni bir örneğini oluşturur
İmza:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kod | FonksiyonlarHataKodu | |
İleti | sicim | |
detaylar | Bilinmeyen |
auth.HttpsError.code
İstemciye döndürülecek standart bir hata kodu. Bu aynı zamanda code.proto'da tanımlandığı gibi yanıtın HTTP durum kodunu da belirler.
İmza:
readonly code: FunctionsErrorCode;
auth.HttpsError.details
JSON'a dönüştürülecek ve hata yanıtına dahil edilecek ekstra veriler.
İmza:
readonly details: unknown;
auth.HttpsError.httpErrorCode
Sağlanan bir hata kodunun kablolu format temsili.
İmza:
readonly httpErrorCode: HttpErrorCode;
auth.HttpsError.toJSON()
Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür.
İmza:
toJSON(): HttpErrorWireFormat;
İadeler:
HttpErrorWireFormat