یک خطای صریح که می تواند از یک کنترل کننده برای ارسال خطایی به کلاینتی که تابع را فراخوانی می کند، پرتاب شود.
امضا:
export declare class HttpsError extends Error
بسط می دهد: خطا
سازندگان
سازنده | اصلاح کننده ها | شرح |
---|---|---|
(سازنده) (کد، پیام، جزئیات) | یک نمونه جدید از کلاس HttpsError می سازد |
خواص
ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
---|---|---|---|
کد | FunctionsErrorCode | یک کد خطای استاندارد که به مشتری بازگردانده می شود. این همچنین کد وضعیت HTTP پاسخ را، همانطور که در code.proto تعریف شده است، تعیین می کند. | |
جزئیات | ناشناخته | داده های اضافی به JSON تبدیل شده و در پاسخ خطا گنجانده می شود. | |
httpErrorCode | HttpErrorCode | نمایش فرمت سیم از کد خطای ارائه شده. |
مواد و روش ها
روش | اصلاح کننده ها | شرح |
---|---|---|
toJSON() | نمایشی قابل سریالسازی با JSON از این شی را برمیگرداند. |
هویت.HttpsError.(سازنده)
یک نمونه جدید از کلاس HttpsError
می سازد
امضا:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
کد | FunctionsErrorCode | |
پیام | رشته | |
جزئیات | ناشناخته |
شناسه.HttpsError.code
یک کد خطای استاندارد که به مشتری بازگردانده می شود. این همچنین کد وضعیت HTTP پاسخ را، همانطور که در code.proto تعریف شده است، تعیین می کند.
امضا:
readonly code: FunctionsErrorCode;
هویت.HttpsError.جزئیات
داده های اضافی به JSON تبدیل شده و در پاسخ خطا گنجانده می شود.
امضا:
readonly details: unknown;
هویت.HttpsError.httpErrorCode
نمایش فرمت سیم از کد خطای ارائه شده.
امضا:
readonly httpErrorCode: HttpErrorCode;
ID.HttpsError.toJSON()
نمایشی قابل سریالسازی با JSON از این شی را برمیگرداند.
امضا:
toJSON(): HttpErrorWireFormat;
برمی گرداند:
HttpErrorWireFormat