firebase-functions package

פונקציות

פוּנקצִיָה תיאור
config() אחסן ואחזר נתוני תצורת פרויקט כגון מפתחות API של צד שלישי או הגדרות אחרות. אתה יכול להגדיר ערכי תצורה באמצעות Firebase CLI כמתואר ב-[תצורת סביבה](/docs/functions/config-env).
optionsToEndpoint(Options)
optionsToTrigger(Options)
אזור (אזורים) הגדר את האזורים אליהם נפרסת הפונקציה.
runWith(runtimeOptions) הגדר אפשרויות זמן ריצה עבור הפונקציה.

שיעורים

מעמד תיאור
שינוי ממשק ה-Cloud Functions עבור אירועים המשנים מצב, כגון Realtime Database או Cloud Firestore onWrite ו- onUpdate אירועים. למידע נוסף על הפורמט המשמש לבניית אובייקטי Change , ראה להלן.
FunctionBuilder

ממשקים

מִמְשָׁק תיאור
BlockingFunction סוג הפונקציה עבור מפעילי חסימת אישור.
CloudFunction סוג הפונקציה עבור כל הטריגרים שאינם HTTPS. יש לייצא את זה מקובץ ה-JavaScript שלך כדי להגדיר פונקציית ענן. סוג זה הוא פונקציית JavaScript מיוחדת שלוקחת אובייקט Event בתבנית כארגומנט היחיד שלו.
אפשרויות פריסה אפשרויות תצורה עבור פונקציה החלה במהלך פריסת הפונקציה.
מִקרֶה פורמט חוט לאירוע.
EventContext ההקשר שבו התרחש אירוע.
מדיניות כשל אפשרות תצורה למדיניות כשל בפונקציות ברקע.
HttpsFunction סוג הפונקציה עבור מפעילי HTTPS. יש לייצא את זה מקובץ ה-JavaScript שלך כדי להגדיר פונקציית ענן.
מַשׁאָב משאב הוא פורמט סטנדרטי להגדרת משאב (google.rpc.context.AttributeContext.Resource). ב-Cloud Functions, המשאב הוא שהפעיל את הפונקציה - כמו דלי אחסון.
ניתן להרצה ל- Runnable יש שיטת run אשר מפעילה ישירות את הפונקציה המוגדרת על ידי המשתמש - שימושית לבדיקת יחידות.
RuntimeOptions אפשרויות תצורה עבור פונקציה הרלוונטית בזמן ריצה.
לוח זמנים אפשרויות תצורה עבור פונקציות מתוזמנות.
ScheduleRetryConfig אפשרויות ניסיון חוזר של מתזמן. חל רק על פונקציות מתוזמנות.

מרחבי שמות

מרחב שמות תיאור
ניתוח
אישור
מאגר מידע
firestore
https
כּוֹרֵת עֵצִים
params
pubsub
remoteconfig
אִחסוּן
משימות
testLab

משתנים

מִשְׁתַנֶה תיאור
אפליקציה
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS רשימת האפשרויות הזמינות עבור IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS ערך הזמן הקצוב המקסימלי של פונקציות ענן.
MIN_TIMEOUT_SECONDS ערך זמן קצוב מינימלי של פונקציות ענן.
RESET_VALUE ערך תצורה מיוחד לאיפוס התצורה לברירת המחדל של הפלטפורמה.
SUPPORTED_REGIONS רשימה של כל האזורים הנתמכים על ידי פונקציות ענן.
VALID_MEMORY_OPTIONS רשימה של אפשרויות זיכרון זמינות הנתמכות על ידי פונקציות ענן.
VPC_EGRESS_SETTINGS_OPTIONS רשימה של אפשרויות זמינות עבור VpcConnectorEgressSettings.

config()

אחסן ואחזר נתוני תצורת פרויקט כגון מפתחות API של צד שלישי או הגדרות אחרות. אתה יכול להגדיר ערכי תצורה באמצעות Firebase CLI כמתואר ב-[תצורת סביבה](/docs/functions/config-env).

חֲתִימָה:

export declare function config(): Record<string, any>;

החזרות:

הקלט<string, any>

optionsToEndpoint()

חֲתִימָה:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות אפשרויות פריסה

החזרות:

ManifestEndpoint

optionsToTrigger()

חֲתִימָה:

export declare function optionsToTrigger(options: DeploymentOptions): any;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות אפשרויות פריסה

החזרות:

כל

אזור()

הגדר את האזורים אליהם נפרסת הפונקציה.

חֲתִימָה:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אזורים מערך<(סוג של SUPPORTED_REGIONS )[מספר] | מחרוזת | ביטוי <string> | ResetValue> אחת ממחרוזות אזור נוספות.

החזרות:

FunctionBuilder

דוגמה 1

functions.region('us-east1')

דוגמה 2

functions.region('us-east1', 'us-central1')

לרוץ עם()

הגדר אפשרויות זמן ריצה עבור הפונקציה.

חֲתִימָה:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
runtimeOptions RuntimeOptions אובייקט עם שדות אופציונליים: 1. memory : כמות הזיכרון להקצאה לפונקציה, ערכים אפשריים הם: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' ו-'8GB' . 2. timeoutSeconds : הזמן הקצוב לפונקציה בשניות, הערכים האפשריים הם 0 עד 540. 3. failurePolicy : מדיניות הכשל של הפונקציה, כאשר true בוליאני שווה ערך לספק אובייקט ניסיון חוזר ריק. 4. vpcConnector : מזהה של מחבר VPC באותו פרויקט ובאותו אזור. 5. vpcConnectorEgressSettings : כאשר מוגדר vpcConnector, קבע איזו תעבורת יציאה תישלח דרך vpcConnector. 6. serviceAccount : חשבון שירות ספציפי עבור הפונקציה. 7. ingressSettings : הגדרות כניסה לפונקציה, השולטות מאיפה ניתן לקרוא לפונקציית HTTPS. הערך לא יכול להיות ריק.

החזרות:

FunctionBuilder

אפליקציה

חֲתִימָה:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

חֲתִימָה:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

רשימת האפשרויות הזמינות עבור IngressSettings.

חֲתִימָה:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

חֲתִימָה:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

ערך הזמן הקצוב המקסימלי של פונקציות ענן.

חֲתִימָה:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

ערך זמן קצוב מינימלי של פונקציות ענן.

חֲתִימָה:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

ערך תצורה מיוחד לאיפוס התצורה לברירת המחדל של הפלטפורמה.

חֲתִימָה:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

רשימה של כל האזורים הנתמכים על ידי פונקציות ענן.

חֲתִימָה:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

VALID_MEMORY_OPTIONS

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

חֲתִימָה:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

רשימה של אפשרויות זמינות עבור VpcConnectorEgressSettings.

חֲתִימָה:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]