auth.HttpsError class

可從處理常式擲回的明確錯誤，將錯誤傳送至呼叫該函式的用戶端。

簽名：

export declare class HttpsError extends Error

延伸：錯誤

建構函式

建構函式 修飾符 說明
(建構函式)(程式碼, 訊息, 詳細資料) 建構 HttpsError 類別的新例項

屬性

屬性 修飾符 類型 說明
程式碼 FunctionsErrorCode 將傳回給用戶端的標準錯誤代碼。這麼做也會決定回應的 HTTP 狀態碼，如 code.proto 所定義。
詳細資料 不明 要轉換為 JSON 並納入錯誤回應的額外資料。
httpErrorCode HttpErrorCode 所提供錯誤代碼的電匯格式。

方法

方法 修飾符 說明
toJSON() 傳回此物件的 JSON 可序列化表示法。

auth.HttpsError.(建構函式)

建構 HttpsError 類別的新例項

簽名：

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

參數

參數 類型 說明
程式碼 FunctionsErrorCode
訊息 字串
詳細資料 不明

auth.HttpsError.code

將傳回給用戶端的標準錯誤代碼。這麼做也會決定回應的 HTTP 狀態碼，如 code.proto 所定義。

簽名：

readonly code: FunctionsErrorCode;

auth.HttpsError.details

要轉換為 JSON 並納入錯誤回應的額外資料。

簽名：

readonly details: unknown;

auth.HttpsError.httpErrorCode

所提供錯誤代碼的電匯格式。

簽名：

readonly httpErrorCode: HttpErrorCode;

auth.HttpsError.toJSON()

傳回此物件的 JSON 可序列化表示法。

簽名：

toJSON(): HttpErrorWireFormat;

傳回：

HttpErrorWireFormat