https.HttpsError class

可以從處理程序引發的明確錯誤,以將錯誤傳送到呼叫函數的用戶端。

簽名:

export declare class HttpsError extends Error 

擴充:錯誤

建構函數

建構函數修飾符描述
(構造函數)(程式碼、訊息、詳細資料)建構HttpsError類別的新實例

特性

財產修飾符類型描述
程式碼函數錯誤程式碼將傳回給客戶端的標準錯誤代碼。這也確定了回應的 HTTP 狀態代碼,如 code.proto 中所定義。
細節未知要轉換為 JSON 並包含在錯誤回應中的額外資料。
http錯誤代碼Http錯誤代碼所提供錯誤代碼的有線格式表示。

方法

方法修飾符描述
toJSON()傳回此物件的 JSON 可序列化表示形式。

https.HttpsError.(建構子)

建構HttpsError類別的新實例

簽名:

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

參數

範圍類型描述
程式碼函數錯誤程式碼
訊息細繩
細節未知

https.HttpsError.code

將傳回給客戶端的標準錯誤代碼。這也確定了回應的 HTTP 狀態代碼,如 code.proto 中所定義。

簽名:

readonly code: FunctionsErrorCode;

https.HttpsError.details

要轉換為 JSON 並包含在錯誤回應中的額外資料。

簽名:

readonly details: unknown;

https.HttpsError.httpErrorCode

所提供錯誤代碼的有線格式表示。

簽名:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

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

簽名:

toJSON(): HttpErrorWireFormat;

返回:

HttpErrorWireFormat