firebase-functions package

المهام

وظيفة وصف
التكوين () قم بتخزين واسترداد بيانات تكوين المشروع مثل مفاتيح واجهة برمجة التطبيقات التابعة لجهات خارجية أو الإعدادات الأخرى. يمكنك تعيين قيم التكوين باستخدام واجهة سطر أوامر Firebase كما هو موضح في [تكوين البيئة](/docs/functions/config-env).
خيارات إلى نقطة النهاية (خيارات)
خيارات تو تريجر (خيارات)
المنطقة (المناطق) قم بتكوين المناطق التي يتم نشر الوظيفة فيها.
تشغيل مع (خيارات وقت التشغيل) تكوين خيارات وقت التشغيل للوظيفة.

الطبقات

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

واجهات

واجهه المستخدم وصف
وظيفة الحظر نوع الوظيفة لتشغيل حظر المصادقة.
وظيفة السحابة نوع الوظيفة لجميع المشغلات غير HTTPS. يجب أن يتم تصدير هذا من ملف JavaScript الخاص بك لتحديد وظيفة السحابة. هذا النوع عبارة عن وظيفة JavaScript خاصة تأخذ كائن Event المُصمم كوسيطة وحيدة لها.
خيارات النشر خيارات التكوين لوظيفة يتم تطبيقها أثناء نشر الوظيفة.
حدث تنسيق الأسلاك لهذا الحدث.
EventContext السياق الذي وقع فيه الحدث.
سياسة الفشل خيار التكوين لسياسة الفشل في وظائف الخلفية.
وظيفة هتبس نوع الوظيفة لمشغلات HTTPS. يجب أن يتم تصدير هذا من ملف JavaScript الخاص بك لتحديد وظيفة السحابة.
الموارد المورد هو تنسيق قياسي لتحديد المورد (google.rpc.context.AttributeContext.Resource). في وظائف السحابة، يكون المورد هو الذي قام بتشغيل الوظيفة - مثل حاوية التخزين.
قابل للتشغيل يحتوي Runnable على طريقة run تستدعي الوظيفة المحددة من قبل المستخدم مباشرة - وهي مفيدة لاختبار الوحدة.
خيارات وقت التشغيل خيارات التكوين لوظيفة قابلة للتطبيق في وقت التشغيل.
جدول خيارات التكوين للوظائف المجدولة.
جدولة إعادة المحاولةالتكوين خيارات إعادة محاولة المجدول. ينطبق فقط على الوظائف المجدولة.

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

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

المتغيرات

عامل وصف
برنامج
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS قائمة الخيارات المتاحة لإعدادات الدخول.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS الحد الأقصى لقيمة المهلة للوظائف السحابية.
MIN_TIMEOUT_SECONDS الحد الأدنى لقيمة المهلة للوظائف السحابية.
RESET_VALUE قيمة تكوين خاصة لإعادة ضبط التكوين على النظام الأساسي الافتراضي.
SUPPORTED_REGIONS قائمة بجميع المناطق التي تدعمها وظائف السحابة.
VALID_MEMORY_OPTIONS قائمة بخيارات الذاكرة المتوفرة التي تدعمها Cloud Functions.
VPC_EGRESS_SETTINGS_OPTIONS قائمة الخيارات المتاحة لـ VpcConnectorEgressSettings.

التكوين ()

قم بتخزين واسترداد بيانات تكوين المشروع مثل مفاتيح واجهة برمجة التطبيقات التابعة لجهات خارجية أو الإعدادات الأخرى. يمكنك تعيين قيم التكوين باستخدام واجهة سطر أوامر Firebase كما هو موضح في [تكوين البيئة](/docs/functions/config-env).

إمضاء:

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

عائدات:

سجل <سلسلة، أي>

أوبتيونستوندبوينت ()

إمضاء:

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

حدود

معامل يكتب وصف
خيارات خيارات النشر

عائدات:

ManifestEndpoint

خيارات تو تريجر ()

إمضاء:

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

حدود

معامل يكتب وصف
خيارات خيارات النشر

عائدات:

أي

منطقة()

قم بتكوين المناطق التي يتم نشر الوظيفة فيها.

إمضاء:

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

حدود

معامل يكتب وصف
المناطق المصفوفة<(نوع SUPPORTED_REGIONS )[الرقم] | سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة> واحدة من أكثر سلاسل المنطقة.

عائدات:

FunctionBuilder

مثال 1

وظائف. المنطقة ('us-east1')

مثال 2

وظائف. المنطقة ('us-east1'، 'us-central1')

إركض مع()

تكوين خيارات وقت التشغيل للوظيفة.

إمضاء:

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

حدود

معامل يكتب وصف
runtimeOptions خيارات وقت التشغيل كائن يحتوي على حقول اختيارية: 1. memory : مقدار الذاكرة التي سيتم تخصيصها للوظيفة، والقيم المحتملة هي: "128 ميجابايت"، و"256 ميجابايت"، و"512 ميجابايت"، و"1 جيجابايت"، و"2 جيجابايت"، و"4 جيجابايت"، و"8 جيجابايت" . 2. timeoutSeconds : مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540. 3. سياسة failurePolicy : سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ. 4. vpcConnector : معرف موصل VPC في نفس المشروع والمنطقة. 5. vpcConnectorEgressSettings : عند تعيين vpcConnector، يمكنك التحكم في حركة مرور الخروج التي يتم إرسالها عبر vpcConnector. serviceAccount : حساب خدمة محدد للوظيفة. 7. ingressSettings : إعدادات الدخول للوظيفة، والتي تتحكم في المكان الذي يمكن استدعاء وظيفة HTTPS منه. يجب ألا تكون القيمة فارغة.

عائدات:

FunctionBuilder

برنامج

إمضاء:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

إمضاء:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

قائمة الخيارات المتاحة لإعدادات الدخول.

إمضاء:

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

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

إمضاء:

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