identity.HttpsError class

يشير ذلك المصطلح إلى خطأ صريح يمكن تنفيذه من خلال المعالج لإرسال خطأ إلى العميل الذي استدعى الدالة.

Signature:

export declare class HttpsError extends Error 

امتداد: خطأ

الشركات المصنِّعة

الشركة المصنِّعة المعدِّلات الوصف
(دالة الإنشاء)(الرمز، الرسالة، التفاصيل) إنشاء مثيل جديد لفئة HttpsError

أماكن إقامة

الموقع المعدِّلات النوع الوصف
الرموز البرمجية FunctionsErrorCode رمز خطأ عادي سيتم عرضه للعميل. ويحدّد هذا أيضًا رمز حالة HTTP للاستجابة، كما هو محدّد في code.proto.
التفاصيل غير معروف البيانات الإضافية المطلوب تحويلها إلى تنسيق JSON وتضمينها في استجابة الخطأ.
httpErrorCode رمز HttpErrorCode تمثّل هذه السمة تمثيلاً لتنسيق سلكي لرمز الخطأ المقدَّم.

الطُرق

الطريقة المعدِّلات الوصف
toJSON() تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

Identity.HttpsError.(دالة إنشائية)

إنشاء مثيل جديد لفئة HttpsError

Signature:

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

المَعلمات

المعلمة النوع الوصف
الرمز FunctionsErrorCode
رسالة السلسلة
التفاصيل غير معروف

Identity.HttpsError.code

رمز خطأ عادي سيتم عرضه للعميل. ويحدّد هذا أيضًا رمز حالة HTTP للاستجابة، كما هو محدّد في code.proto.

Signature:

readonly code: FunctionsErrorCode;

Identity.HttpsError.details

البيانات الإضافية المطلوب تحويلها إلى تنسيق JSON وتضمينها في استجابة الخطأ.

Signature:

readonly details: unknown;

Identity.HttpsError.httpErrorCode

تمثّل هذه السمة تمثيلاً لتنسيق سلكي لرمز الخطأ المقدَّم.

Signature:

readonly httpErrorCode: HttpErrorCode;

Identity.HttpsError.toJSON()

تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

Signature:

toJSON(): HttpErrorWireFormat;

المرتجعات:

HttpErrorWireFormat