https.HttpsError class

Một lỗi rõ ràng có thể được đưa ra từ một trình xử lý để gửi lỗi đến máy khách đã gọi hàm.

Chữ ký:

export declare class HttpsError extends Error 

Mở rộng: Lỗi

nhà xây dựng

Người xây dựng sửa đổi Sự miêu tả
(hàm tạo)(mã, thông báo, chi tiết) Xây dựng một phiên bản mới của lớp HttpsError

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
mã số Chức năngMã lỗi Một mã lỗi tiêu chuẩn sẽ được trả về cho khách hàng. Điều này cũng xác định mã trạng thái HTTP của phản hồi, như được xác định trong code.proto.
chi tiết không xác định Dữ liệu bổ sung sẽ được chuyển đổi thành JSON và được đưa vào phản hồi lỗi.
httpMã lỗi HttpErrorCode Định dạng dây trình bày mã lỗi được cung cấp.

phương pháp

Phương pháp sửa đổi Sự miêu tả
toJSON() Trả về một biểu diễn có thể tuần tự hóa JSON của đối tượng này.

https.HttpsError.(hàm tạo)

Xây dựng một phiên bản mới của lớp HttpsError

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
mã số Chức năngMã lỗi
tin nhắn sợi dây
chi tiết không xác định

https.HttpsError.code

Một mã lỗi tiêu chuẩn sẽ được trả về cho khách hàng. Điều này cũng xác định mã trạng thái HTTP của phản hồi, như được xác định trong code.proto.

Chữ ký:

readonly code: FunctionsErrorCode;

https.HttpsError.details

Dữ liệu bổ sung sẽ được chuyển đổi thành JSON và được đưa vào phản hồi lỗi.

Chữ ký:

readonly details: unknown;

https.HttpsError.httpErrorCode

Định dạng dây trình bày mã lỗi được cung cấp.

Chữ ký:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

Trả về một biểu diễn có thể tuần tự hóa JSON của đối tượng này.

Chữ ký:

toJSON(): HttpErrorWireFormat;

Trả về:

HttpErrorWireFormat