ממשק API של דור שני עבור פונקציות ענן עבור Firebase. SDK זה תומך בייבוא עמוק. לדוגמה, מרחב השמות pubsub זמין ב- firebase-functions/v2 או שניתן לייבא ישירות מ- firebase-functions/v2/pubsub .
פונקציות
| פוּנקצִיָה | תיאור |
|---|---|
| setGlobalOptions(Options) | מגדיר אפשרויות ברירת מחדל עבור כל הפונקציות שנכתבו באמצעות SDK מהדור השני. |
שיעורים
| מעמד | תיאור |
|---|---|
| שינוי | ממשק ה-Cloud Functions עבור אירועים המשנים מצב, כגון Realtime Database או Cloud Firestore onWrite ו- onUpdate אירועים. למידע נוסף על הפורמט המשמש לבניית אובייקטי Change , ראה להלן. |
ממשקים
| מִמְשָׁק | תיאור |
|---|---|
| CloudEvent | (ביטא) CloudEventBase הוא הבסיס של פורמט חוצה פלטפורמות לקידוד אירוע ללא שרת. למידע נוסף, ראה https://github.com/cloudevents/spec. |
| CloudFunction | (ביטא) מטפל עבור CloudEvents. |
| EventHandlerOptions | שדות נוספים שניתן להגדיר בכל פונקציית טיפול באירועים. |
| GlobalOptions | GlobalOptions הן אפשרויות שניתן להגדיר על פני פרויקט שלם. אפשרויות אלה משותפות לפונקציות HTTPS וטיפול באירועים. |
מרחבי שמות
| מרחב שמות | תיאור |
|---|---|
| התראות | |
| מאגר מידע | |
| eventarc | |
| firestore | |
| https | |
| זהות | |
| כּוֹרֵת עֵצִים | |
| params | |
| pubsub | |
| remoteconfig | |
| מתזמן | |
| אִחסוּן | |
| משימות | |
| testLab |
הקלד כינויים
| הקלד כינוי | תיאור |
|---|---|
| IngressSetting | רשימת האפשרויות הזמינות עבור IngressSettings . |
| אפשרות זיכרון | רשימה של אפשרויות זיכרון זמינות הנתמכות על ידי פונקציות ענן. |
| ParamsOf | סוג שממפה את כל לכידת הפרמטרים למפתחות של רשומה. לדוגמה, ParamsOf < "משתמשים/ { uid } " > הוא { uid: string } ParamsOf < "משתמשים/ { uid } /יומנים/ { עֵץ } " > הוא { uid: מחרוזת; log: string } ParamsOf < "כמה/סטטי/נתונים" > הוא { } מטעמי גמישות, ParamsOf |
| נתמך באזור | רשימה של כל האזורים הנתמכים על ידי פונקציות ענן (דור שני). |
| VpcEgressSetting | רשימה של אפשרויות זמינות עבור VpcConnectorEgressSettings . |
setGlobalOptions()
מגדיר אפשרויות ברירת מחדל עבור כל הפונקציות שנכתבו באמצעות SDK מהדור השני.
חֲתִימָה:
export declare function setGlobalOptions(options: GlobalOptions): void;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפשרויות | GlobalOptions | אפשרויות להגדרה כברירת מחדל |
החזרות:
בָּטֵל
IngressSetting
רשימת האפשרויות הזמינות עבור IngressSettings .
חֲתִימָה:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
אפשרות זיכרון
רשימה של אפשרויות זיכרון זמינות הנתמכות על ידי פונקציות ענן.
חֲתִימָה:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamsOf
סוג שממפה את כל לכידת הפרמטרים למפתחות של רשומה. לדוגמה, ParamsOf < "משתמשים/ { uid } " > הוא { uid: string } ParamsOf < "משתמשים/ { uid } /יומנים/ { עֵץ } " > הוא { uid: מחרוזת; log: string } ParamsOf < "כמה/סטטי/נתונים" > הוא { }
מטעמי גמישות, ParamsOf
חֲתִימָה:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
נתמך באזור
רשימה של כל האזורים הנתמכים על ידי פונקציות ענן (דור שני).
חֲתִימָה:
export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";
VpcEgressSetting
רשימה של אפשרויות זמינות עבור VpcConnectorEgressSettings .
חֲתִימָה:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";