İşlev ç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şletir: Hata
Markalar
Marka | Değiştiriciler | Açıklama |
---|---|---|
(oluşturucu)(kod, mesaj, ayrıntılar) | HttpsError sınıfının yeni bir örneğini oluşturur |
Özellikler
Özellik | Değiştiriciler | Tür | Açıklama |
---|---|---|---|
kod | İşlevler Hata Kodu | İstemciye döndürülecek standart bir hata kodu. Bu işlem, code.proto'da tanımlandığı gibi yanıtın HTTP durum kodunu da belirler. | |
ayrıntıları | bilinmiyor | JSON'a dönüştürülecek ve hata yanıtına dahil edilecek fazladan veriler. | |
httpErrorCode | HttpHata Kodu | Sağlanan hata kodunun kablo biçimi gösterimi. |
Yöntemler
Yöntem | Değiştiriciler | Açıklama |
---|---|---|
toJSON() | Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür. |
auth.HttpsError.(kurucu)
HttpsError
sınıfının yeni bir örneğini oluşturur
İmza:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
kod | İşlevler Hata Kodu | |
mesaj | dize | |
ayrıntılar | bilinmiyor |
kimlik doğrulama.HttpsHatası.kodu
İstemciye döndürülecek standart bir hata kodu. Bu işlem, 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 fazladan veriler.
İmza:
readonly details: unknown;
auth.HttpsError.httpErrorCode
Sağlanan hata kodunun kablo biçimi gösterimi.
İmza:
readonly httpErrorCode: HttpErrorCode;
auth.HttpsError.toJSON().
Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.
İmza:
toJSON(): HttpErrorWireFormat;
Şunu döndürür:
HttpErrorWireFormat