https.HttpsError class

שגיאה מפורשת שניתן לזרוק ממטפל כדי לשלוח שגיאה ללקוח שקרא לפונקציה.

חֲתִימָה:

export declare class HttpsError extends Error 

מרחיב: שגיאה

בונים

בַּנַאִי משנה תיאור
(קונסטרוקטור)(קוד, הודעה, פרטים) בונה מופע חדש של המחלקה HttpsError

נכסים

תכונה משנה סוּג תיאור
קוד FunctionsErrorCode קוד שגיאה סטנדרטי שיוחזר ללקוח. זה גם קובע את קוד מצב ה-HTTP של התגובה, כפי שהוגדר ב-code.proto.
פרטים לא ידוע נתונים נוספים להמרה ל-JSON ולהיכלל בתגובת השגיאה.
httpErrorCode HttpErrorCode ייצוג פורמט תיל של קוד שגיאה שסופק.

שיטות

שיטה משנה תיאור
toJSON() מחזיר ייצוג ניתן להמשכה של JSON של אובייקט זה.

https.HttpsError.(קונסטרוקטור)

בונה מופע חדש של המחלקה HttpsError

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
קוד FunctionsErrorCode
הוֹדָעָה חוּט
פרטים לא ידוע

https.HttpsError.code

קוד שגיאה סטנדרטי שיוחזר ללקוח. זה גם קובע את קוד מצב ה-HTTP של התגובה, כפי שהוגדר ב-code.proto.

חֲתִימָה:

readonly code: FunctionsErrorCode;

https.HttpsError.details

נתונים נוספים להמרה ל-JSON ולהיכלל בתגובת השגיאה.

חֲתִימָה:

readonly details: unknown;

https.HttpsError.httpErrorCode

ייצוג פורמט תיל של קוד שגיאה שסופק.

חֲתִימָה:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

מחזיר ייצוג ניתן להמשכה של JSON של אובייקט זה.

חֲתִימָה:

toJSON(): HttpErrorWireFormat;

החזרות:

HttpErrorWireFormat