نسل دوم API برای توابع ابری برای Firebase. این SDK از واردات عمیق پشتیبانی می کند. به عنوان مثال، فضای نامی pubsub در firebase-functions/v2 موجود است یا مستقیماً از firebase-functions/v2/pubsub قابل وارد کردن است. .
کارکرد
| تابع | شرح |
|---|---|
| setGlobalOptions (گزینه‌ها) | گزینه های پیش فرض را برای همه توابع نوشته شده با استفاده از SDK نسل دوم تنظیم می کند. |
کلاس ها
| کلاس | شرح |
|---|---|
| تغییر دادن | رابط Cloud Functions برای رویدادهایی که تغییر حالت می دهند، مانند رویدادهای پایگاه داده بیدرنگ یا Cloud Firestore onWrite و onUpdate . برای اطلاعات بیشتر در مورد قالب مورد استفاده برای ساختن اشیاء Change ، به زیر مراجعه کنید. |
رابط ها
| رابط | شرح |
|---|---|
| CloudEvent | (بتا) یک CloudEventBase پایه یک قالب چند پلتفرمی برای رمزگذاری یک رویداد بدون سرور است. برای اطلاعات بیشتر به https://github.com/cloudevents/spec مراجعه کنید. |
| CloudFunction | (بتا) یک کنترل کننده برای CloudEvents. |
| EventHandlerOptions | فیلدهای اضافی که می توانند روی هر عملکرد مدیریت رویداد تنظیم شوند. |
| GlobalOptions | GlobalOptions گزینه هایی هستند که می توانند در کل پروژه تنظیم شوند. این گزینه ها برای HTTPS و توابع مدیریت رویداد مشترک هستند. |
فضاهای نام
| فضای نام | شرح |
|---|---|
| هشدارها | |
| پایگاه داده | |
| eventtarc | |
| آتش نشانی | |
| https | |
| هویت | |
| متمرکز ساز | |
| پارامترها | |
| ساب میخانه | |
| remoteConfig | |
| زمانبندی | |
| ذخیره سازی | |
| وظایف | |
| تست آزمایشگاه |
نام مستعار را تایپ کنید
| نام مستعار را تایپ کنید | شرح |
|---|---|
| IngressSetting | فهرست گزینه های موجود برای IngressSettings . |
| MemoryOption | لیست گزینه های حافظه موجود که توسط Cloud Function ها پشتیبانی می شوند. |
| ParamsOf | نوعی که تمام گروپ های ضبط پارامترها را در کلیدهای یک رکورد نگاشت می کند. به عنوان مثال، ParamsOf < "کاربران/ { uid } " > { uid: string } ParamsOf است < "کاربران/ { uid } /logs/ { ورود به سیستم } " > { uid: string; 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";
MemoryOption
لیست گزینه های حافظه موجود که توسط Cloud Function ها پشتیبانی می شوند.
امضا:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamsOf
نوعی که تمام گروپ های ضبط پارامترها را در کلیدهای یک رکورد نگاشت می کند. به عنوان مثال، ParamsOf < "کاربران/ { uid } " > { uid: string } ParamsOf است < "کاربران/ { uid } /logs/ { ورود به سیستم } " > { uid: string; 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";