可以从处理程序抛出的显式错误,以向调用函数的客户端发送错误。
签名:
export declare class HttpsError extends Error
Extends: 错误
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(构造函数)(代码, 消息, 详细信息) | 构造 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