identity.HttpsError class

एक स्पष्ट त्रुटि जिसे फ़ंक्शन को कॉल करने वाले क्लाइंट को त्रुटि भेजने के लिए हैंडलर से फेंका जा सकता है।

हस्ताक्षर:

export declare class HttpsError extends Error 

विस्तार: त्रुटि

कंस्ट्रक्टर्स

निर्माता संशोधक विवरण
(निर्माता)(कोड, संदेश, विवरण) HttpsError वर्ग का एक नया उदाहरण बनाता है

गुण

संपत्ति संशोधक प्रकार विवरण
कोड फ़ंक्शंसत्रुटिकोड एक मानक त्रुटि कोड जो क्लाइंट को लौटा दिया जाएगा। यह प्रतिक्रिया का HTTP स्थिति कोड भी निर्धारित करता है, जैसा कि कोड.प्रोटो में परिभाषित किया गया है।
विवरण अज्ञात अतिरिक्त डेटा को JSON में परिवर्तित किया जाएगा और त्रुटि प्रतिक्रिया में शामिल किया जाएगा।
httpErrorCode HttpErrorCode दिए गए त्रुटि कोड का एक तार प्रारूप प्रतिनिधित्व।

तरीकों

तरीका संशोधक विवरण
toJSON() इस ऑब्जेक्ट का JSON-क्रमबद्ध प्रतिनिधित्व लौटाता है।

पहचान.Httpsत्रुटि.(निर्माता)

HttpsError वर्ग का एक नया उदाहरण बनाता है

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
कोड फ़ंक्शंसत्रुटिकोड
संदेश डोरी
विवरण अज्ञात

पहचान.HttpsError.code

एक मानक त्रुटि कोड जो क्लाइंट को लौटा दिया जाएगा। यह प्रतिक्रिया का HTTP स्थिति कोड भी निर्धारित करता है, जैसा कि कोड.प्रोटो में परिभाषित किया गया है।

हस्ताक्षर:

readonly code: FunctionsErrorCode;

पहचान.HttpsError.विवरण

अतिरिक्त डेटा को JSON में परिवर्तित किया जाएगा और त्रुटि प्रतिक्रिया में शामिल किया जाएगा।

हस्ताक्षर:

readonly details: unknown;

पहचान.HttpsError.httpErrorCode

दिए गए त्रुटि कोड का एक तार प्रारूप प्रतिनिधित्व।

हस्ताक्षर:

readonly httpErrorCode: HttpErrorCode;

पहचान.HttpsError.toJSON()

इस ऑब्जेक्ट का JSON-क्रमबद्ध प्रतिनिधित्व लौटाता है।

हस्ताक्षर:

toJSON(): HttpErrorWireFormat;

रिटर्न:

HttpErrorWireFormat