firebase-functions package

واجهة برمجة التطبيقات (API) من الجيل الثاني للوظائف السحابية لـ Firebase. يدعم SDK هذا الواردات العميقة. على سبيل المثال، مساحة الاسم pubsub متاحة في firebase-functions/v2 أو يمكن استيرادها مباشرة من firebase-functions/v2/pubsub .

المهام

وظيفة وصف
setGlobalOptions(خيارات) يضبط الخيارات الافتراضية لجميع الوظائف المكتوبة باستخدام الجيل الثاني من SDK.

الطبقات

فصل وصف
يتغير واجهة Cloud Functions للأحداث التي تغير حالتها، مثل Realtime Database أو Cloud Firestore onWrite و onUpdate . لمزيد من المعلومات حول التنسيق المستخدم لإنشاء كائنات Change ، راجع أدناه.

واجهات

واجهه المستخدم وصف
CloudEvent (تجريبي) CloudEventBase هو أساس التنسيق عبر الأنظمة الأساسية لترميز حدث بدون خادم. لمزيد من المعلومات، راجع https://github.com/cloudevents/spec.
وظيفة السحابة (بيتا) معالج لـ CloudEvents.
EventHandlerOptions الحقول الإضافية التي يمكن تعيينها في أي وظيفة لمعالجة الأحداث.
الخيارات العالمية GlobalOptions هي الخيارات التي يمكن تعيينها عبر المشروع بأكمله. هذه الخيارات شائعة في وظائف HTTPS ومعالجة الأحداث.

مساحات الأسماء

مساحة الاسم وصف
التنبيهات
قاعدة البيانات
com.eventarc
firestore
https
هوية
المسجل
المعلمات
com.pubsub
RemoteConfig
جدولة
تخزين
مهام
testLab

اكتب الأسماء المستعارة

اكتب الاسم المستعار وصف
إعداد الدخول قائمة الخيارات المتاحة لـ IngressSettings .
خيار الذاكرة قائمة بخيارات الذاكرة المتوفرة التي تدعمها Cloud Functions.
ParamsOf نوع يقوم بتعيين جميع مجموعة التقاط المعلمات في مفاتيح السجل. على سبيل المثال، ParamsOf < "المستخدمون/ { uid } " > هو { uid: سلسلة } ParamsOf < "المستخدمون/ { uid } /السجلات/ { سجل } " > هو {معرف المستخدم: سلسلة؛ سجل: سلسلة } ParamsOf < "بعض/ثابت/البيانات" > هو { } لأسباب تتعلق بالمرونة، ParamsOf هو سجل < سلسلة، سلسلة >
المنطقة المدعومة قائمة بجميع المناطق التي تدعمها Cloud Functions (الجيل الثاني).
VpcEgressSetting قائمة بالخيارات المتاحة لـ VpcConnectorEgressSettings .

setGlobalOptions()

يضبط الخيارات الافتراضية لجميع الوظائف المكتوبة باستخدام الجيل الثاني من SDK.

إمضاء:

export declare function setGlobalOptions(options: GlobalOptions): void;

حدود

معامل يكتب وصف
خيارات الخيارات العالمية خيارات لتعيينها كافتراضي

عائدات:

فارغ

إعداد الدخول

قائمة الخيارات المتاحة IngressSettings .

إمضاء:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

خيار الذاكرة

قائمة بخيارات الذاكرة المتوفرة التي تدعمها Cloud Functions.

إمضاء:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ParamsOf

نوع يقوم بتعيين جميع مجموعة التقاط المعلمات في مفاتيح السجل. على سبيل المثال، ParamsOf < "المستخدمون/ { uid } " > هو { uid: سلسلة } ParamsOf < "المستخدمون/ { uid } /السجلات/ { سجل } " > هو {معرف المستخدم: سلسلة؛ سجل: سلسلة } ParamsOf < "بعض/ثابت/البيانات" > هو { }

لأسباب تتعلق بالمرونة، ParamsOf هو سجل < سلسلة، سلسلة >

إمضاء:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

المنطقة المدعومة

قائمة بجميع المناطق التي تدعمها Cloud Functions (الجيل الثاني).

إمضاء:

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";