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