https namespace

פונקציות

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

שיעורים

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

ממשקים

מִמְשָׁק תיאור
CallableContext הממשק למטא נתונים עבור ה-API כפי שהועבר למטפל.
בַּקָשָׁה בקשה מפורשת עם ייצוג פורמט תיל של גוף הבקשה.

הקלד כינויים

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

https.onCall()

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

חֲתִימָה:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מטפל (נתונים: כל, הקשר: CallableContext ) => כל | מבטיח<כל> שיטה שלוקחת נתונים והקשר ומחזירה ערך.

החזרות:

HttpsFunction & Runnable <כל>

https.onRequest()

טיפול בבקשות HTTP.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מטפל (req: Request, resp: express.Response) => void | הבטחה<void> פונקציה שלוקחת אובייקט בקשה ותגובה, אותה חתימה כמו אפליקציית 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";