functions package

פונקציות ענן עבור Firebase

פונקציות

ממשקים

הקלד כינויים

פונקציה (אפליקציה,...)

getFunctions(אפליקציה, regionOrCustomDomain)

מחזירה מופע Functions עבור האפליקציה הנתונה.

חֲתִימָה:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

פרמטרים

החזרות:

פונקציות

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, מארח, יציאה)

שנה מופע זה כדי לתקשר עם אמולטור Cloud Functions.

חֲתִימָה:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

פרמטרים

החזרות:

בָּטֵל

httpsCallable(functionsInstance, שם, אפשרויות)

מחזירה הפניה לטריגר HTTPS הניתן להתקשרות עם השם הנתון.

חֲתִימָה:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

פרמטרים

החזרות:

HttpsCallable <RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

מחזירה הפניה לטריגר HTTPS הניתן להתקשרות עם כתובת ה-URL שצוינה.

חֲתִימָה:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

פרמטרים

החזרות:

HttpsCallable <RequestData, ResponseData>

FunctionsErrorCode

קבוצת קודי הסטטוס של Firebase Functions. הקודים זהים לאלו שנחשפו על ידי gRPC כאן: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

ערכים אפשריים: - 'מבוטל': הפעולה בוטלה (בדרך כלל על ידי המתקשר). - 'לא ידוע': שגיאה לא ידועה או שגיאה מתחום שגיאה אחר. - 'invalid-argument': הלקוח ציין ארגומנט לא חוקי. שימו לב שזה שונה מ'תנאי מוקדם' שנכשל. 'invalid-argument' מציין ארגומנטים שהם בעייתיים ללא קשר למצב המערכת (למשל שם שדה לא חוקי). - 'חורג מהמועד האחרון': פג תוקף לפני שהפעולה הסתיימה. עבור פעולות שמשנות את מצב המערכת, שגיאה זו עשויה להיות מוחזרת גם אם הפעולה הושלמה בהצלחה. לדוגמה, תגובה מוצלחת משרת יכולה הייתה להתעכב מספיק זמן כדי שהמועד האחרון יפוג. - 'לא נמצא': חלק מהמסמך המבוקש לא נמצא. - 'כבר-קיים': מסמך כלשהו שניסינו ליצור כבר קיים. - 'הרשאה נדחתה': למתקשר אין הרשאה לבצע את הפעולה שצוינה. - 'המשאב מוצת': משאב מסוים מוצה, אולי מכסה לכל משתמש, או אולי כל מערכת הקבצים נגמרה. - 'failed-precondition': הפעולה נדחתה מכיוון שהמערכת אינה במצב הנדרש לביצוע הפעולה. - 'בוטלה': הפעולה בוטלה, בדרך כלל עקב בעיית בו-זמנית כמו ביטול עסקה וכו'. - 'מחוץ לטווח': הפעולה נוסתה מעבר לטווח החוקי. - 'לא מיושם': הפעולה אינה מיושמת או אינה נתמכת/מופעלת. - 'פנימי': שגיאות פנימיות. פירוש הדבר שחלק מהאינווריאציות הצפויות על ידי המערכת הבסיסית נשברו. אם אתה רואה אחת מהשגיאות האלה, משהו מאוד שבור. - 'לא זמין': השירות אינו זמין כעת. זה ככל הנראה מצב חולף וניתן לתקן אותו על ידי ניסיון חוזר עם ביטול. - 'אובדן נתונים': אובדן נתונים או שחיתות בלתי ניתן לשחזור. - 'לא מאומת': לבקשה אין אישורי אימות חוקיים עבור הפעולה.

חֲתִימָה:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

מחרוזת קוד שגיאה של פונקציות שצורפה אחרי קידומת המוצר "functions/". ראה FunctionsErrorCode לתיעוד מלא של קודים.

חֲתִימָה:

export declare type FunctionsErrorCodeCore = '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';

HttpsCallable

הפניה לטריגר HTTP "ניתן להתקשרות" ב-Google Cloud Functions.

חֲתִימָה:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;