https namespace

פונקציות

פוּנקצִיָה	תיאור
onCall (opts, handler)	מצהיר על שיטה ניתנת להתקשרות עבור לקוחות להתקשרות באמצעות Firebase SDK.
onCall (מטפל)	מצהיר על שיטה ניתנת להתקשרות עבור לקוחות להתקשרות באמצעות Firebase SDK.
onRequest(opts, handler)	מטפל בבקשות HTTPS.
onRequest(מטפל)	מטפל בבקשות HTTPS.

שיעורים

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

ממשקים

מִמְשָׁק	תיאור
CallableFunction	יוצר שיטה הניתנת להתקשרות עבור לקוחות להתקשר באמצעות Firebase SDK.
CallableOptions	אפשרויות שניתן להגדיר בפונקציית HTTPS הניתנת להתקשרות.
CallableRequest	הבקשה המשמשת לקריאה לפונקציה הניתנת להתקשרות.
HttpsOptions	אפשרויות שניתן להגדיר בפונקציית HTTPS onRequest.
בַּקָשָׁה	בקשה מפורשת עם ייצוג פורמט תיל של גוף הבקשה.

הקלד כינויים

הקלד כינוי	תיאור
FunctionsErrorCode	קבוצת קודי המצב של Firebase Functions. הקודים זהים לאלו שנחשפו על ידי gRPC .
HttpsFunction	מטפל בבקשות HTTPS.

https.onCall()

מצהיר על שיטה ניתנת להתקשרות עבור לקוחות להתקשרות באמצעות Firebase SDK.

חֲתִימָה:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
בוחר	CallableOptions	אפשרויות להגדרה בפונקציה זו.
מטפל	(בקשה: CallableRequest <T>) => חזרה	פונקציה שלוקחת https.CallableRequest .

החזרות:

CallableFunction<T, Return>

פונקציה שתוכל לייצא ולפרוס.

https.onCall()

מצהיר על שיטה ניתנת להתקשרות עבור לקוחות להתקשרות באמצעות Firebase SDK.

חֲתִימָה:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
מטפל	(בקשה: CallableRequest <T>) => חזרה	פונקציה שלוקחת https.CallableRequest .

החזרות:

CallableFunction<T, Return>

פונקציה שתוכל לייצא ולפרוס.

https.onRequest()

מטפל בבקשות HTTPS.

חֲתִימָה:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
בוחר	HttpsOptions	אפשרויות להגדרה בפונקציה זו
מטפל	(בקשה: בקשה , תגובה: express.Response) => ריק | הבטחה<void>	פונקציה שלוקחת אובייקט https.Request ו-response, אותה חתימה כמו אפליקציית Express.

החזרות:

HttpsFunction

פונקציה שתוכל לייצא ולפרוס.

https.onRequest()

מטפל בבקשות HTTPS.

חֲתִימָה:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
מטפל	(בקשה: בקשה , תגובה: express.Response) => ריק | הבטחה<void>	פונקציה שלוקחת אובייקט https.Request ו-response, אותה חתימה כמו אפליקציית Express.

החזרות:

HttpsFunction

פונקציה שתוכל לייצא ולפרוס.

https.FunctionsErrorCode

קבוצת קודי המצב של Firebase Functions. הקודים זהים לאלו שנחשפו על ידי gRPC .

ערכים אפשריים:

• cancelled : הפעולה בוטלה (בדרך כלל על ידי המתקשר).

• unknown : שגיאה לא ידועה או שגיאה מתחום שגיאה אחר.

• invalid-argument : הלקוח ציין ארגומנט לא חוקי. שים לב שזה שונה מתנאי failed-precondition . invalid-argument מציין ארגומנטים שהם בעייתיים ללא קשר למצב המערכת (למשל שם שדה לא חוקי).

• deadline-exceeded : המועד האחרון פג לפני שהפעולה הסתיימה. עבור פעולות שמשנות את מצב המערכת, שגיאה זו עשויה להיות מוחזרת גם אם הפעולה הושלמה בהצלחה. לדוגמה, תגובה מוצלחת משרת יכולה הייתה להתעכב מספיק זמן כדי שהמועד האחרון יפוג.

• not-found : חלק מהמסמך המבוקש לא נמצא.

• already-exists : מסמך כלשהו שניסינו ליצור כבר קיים.

• permission-denied : למתקשר אין הרשאה לבצע את הפעולה שצוינה.

• resource-exhausted : חלק מהמשאבים מוצה, אולי מכסה לכל משתמש, או שאולי אין מקום למערכת הקבצים כולה.

• failed-precondition : הפעולה נדחתה מכיוון שהמערכת אינה במצב הנדרש לביצוע הפעולה.

• aborted : הפעולה בוטלה, בדרך כלל עקב בעיית במקביל כמו ביטול עסקה וכו'.

• out-of-range : בוצע ניסיון פעולה מעבר לטווח החוקי.

• unimplemented : הפעולה אינה מיושמת או אינה נתמכת/מופעלת.

• internal : שגיאות פנימיות. פירוש הדבר שחלק מהאינווריאציות הצפויות על ידי המערכת הבסיסית נשברו. אם אתה רואה אחת מהשגיאות האלה, משהו מאוד שבור.

• unavailable : השירות אינו זמין כעת. זה ככל הנראה מצב חולף וניתן לתקן אותו על ידי ניסיון חוזר עם ביטול.

• data-loss : אובדן נתונים או שחיתות בלתי ניתן לשחזור.

• unauthenticated : לבקשה אין אישורי אימות חוקיים עבור הפעולה.

חֲתִימָה:

export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";

https.HttpsFunction

מטפל בבקשות HTTPS.

חֲתִימָה:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};