کارکرد
| تابع | شرح |
|---|---|
| config() | داده های پیکربندی پروژه مانند کلیدهای API شخص ثالث یا تنظیمات دیگر را ذخیره و بازیابی کنید. می توانید مقادیر پیکربندی را با استفاده از Firebase CLI همانطور که در [Environment Configuration] (/docs/functions/config-env) توضیح داده شده است، تنظیم کنید. |
| optionsToEndpoint (گزینه ها) | |
| optionsToTrigger (گزینه ها) | |
| منطقه (مناطق) | مناطقی را که تابع در آنها مستقر شده است پیکربندی کنید. |
| runWith(runtimeOptions) | گزینه های زمان اجرا را برای تابع پیکربندی کنید. |
کلاس ها
| کلاس | شرح |
|---|---|
| تغییر دادن | رابط Cloud Functions برای رویدادهایی که تغییر حالت می دهند، مانند رویدادهای پایگاه داده بیدرنگ یا Cloud Firestore onWrite و onUpdate . برای اطلاعات بیشتر در مورد قالب مورد استفاده برای ساختن اشیاء Change ، به زیر مراجعه کنید. |
| FunctionBuilder |
رابط ها
| رابط | شرح |
|---|---|
| BlockingFunction | نوع عملکرد برای محرک های Auth Blocking. |
| CloudFunction | نوع عملکرد برای همه محرک‌های غیر HTTPS. این باید از فایل جاوا اسکریپت شما برای تعریف یک تابع ابری صادر شود. این نوع یک تابع خاص جاوا اسکریپت است که یک شئ Event قالب را به عنوان تنها آرگومان خود می گیرد. |
| DeploymentOptions | گزینه های پیکربندی برای عملکردی که در حین استقرار عملکرد اعمال می شود. |
| رویداد | قالب سیم برای یک رویداد. |
| EventContext | زمینه ای که یک رویداد در آن رخ داده است. |
| سیاست شکست | گزینه پیکربندی برای خط مشی شکست در توابع پس زمینه. |
| HttpsFunction | نوع عملکرد برای راه‌اندازهای HTTPS. این باید از فایل جاوا اسکریپت شما برای تعریف یک تابع ابری صادر شود. |
| منبع | Resource یک قالب استاندارد برای تعریف یک منبع است (google.rpc.context.AttributeContext.Resource). در توابع ابری، این منبعی است که عملکرد را فعال می کند - مانند یک سطل ذخیره سازی. |
| قابل اجرا | یک Runnable یک روش run دارد که مستقیماً تابع تعریف شده توسط کاربر را فراخوانی می کند - برای آزمایش واحد مفید است. |
| RuntimeOptions | گزینه های پیکربندی برای عملکردی که در زمان اجرا قابل اجرا است. |
| برنامه | گزینه های پیکربندی برای توابع زمان بندی شده |
| ScheduleRetryConfig | گزینه‌های زمان‌بندی دوباره امتحان کنید. فقط برای توابع برنامه ریزی شده اعمال می شود. |
فضاهای نام
| فضای نام | شرح |
|---|---|
| تجزیه و تحلیل | |
| اعتبار | |
| پایگاه داده | |
| آتش نشانی | |
| https | |
| متمرکز ساز | |
| پارامترها | |
| ساب میخانه | |
| remoteConfig | |
| ذخیره سازی | |
| وظایف | |
| تست آزمایشگاه |
متغیرها
| متغیر | شرح |
|---|---|
| برنامه | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | لیست گزینه های موجود برای IngressSettings. |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | حداکثر مقدار زمان وقفه عملکردهای ابری. |
| MIN_TIMEOUT_SECONDS | عملکردهای ابری حداقل مقدار مهلت زمانی. |
| RESET_VALUE | مقدار پیکربندی ویژه برای بازنشانی پیکربندی به پیش فرض پلت فرم. |
| SUPPORTED_REGIONS | لیست تمام مناطق پشتیبانی شده توسط توابع ابری. |
| VALID_MEMORY_OPTIONS | لیست گزینه های حافظه موجود که توسط Cloud Function ها پشتیبانی می شوند. |
| VPC_EGRESS_SETTINGS_OPTIONS | لیست گزینه های موجود برای VpcConnectorEgressSettings. |
config()
داده های پیکربندی پروژه مانند کلیدهای API شخص ثالث یا تنظیمات دیگر را ذخیره و بازیابی کنید. می توانید مقادیر پیکربندی را با استفاده از Firebase CLI همانطور که در [Environment Configuration] (/docs/functions/config-env) توضیح داده شده است، تنظیم کنید.
امضا:
export declare function config(): Record<string, any>;
برمی گرداند:
ضبط <رشته، هر>
optionsToEndpoint()
امضا:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| گزینه ها | DeploymentOptions |
برمی گرداند:
ManifestEndpoint
optionsToTrigger()
امضا:
export declare function optionsToTrigger(options: DeploymentOptions): any;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| گزینه ها | DeploymentOptions |
برمی گرداند:
هر
منطقه ()
مناطقی را که تابع در آنها مستقر شده است پیکربندی کنید.
امضا:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| مناطق | آرایه<(نوع SUPPORTED_REGIONS )[شماره] | رشته | اصطلاح <رشته> | ResetValue> | یکی از رشته های منطقه دیگر. |
برمی گرداند:
مثال 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 : مهلت زمانی برای تابع در ثانیه، true ممکن از 0 failurePolicy 540 است. 4. vpcConnector : شناسه کانکتور VPC در همان پروژه و منطقه. 5. vpcConnectorEgressSettings : هنگامی که یک vpcConnector تنظیم می شود، کنترل کنید که کدام ترافیک خروجی از طریق vpcConnector ارسال شود. 6. serviceAccount : حساب سرویس خاص برای عملکرد. 7. ingressSettings : تنظیمات ورودی برای تابع، که کنترل می کند که یک تابع HTTPS از کجا می تواند فراخوانی شود. مقدار نباید صفر باشد. |
برمی گرداند:
برنامه
امضا:
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
لیست گزینه های حافظه موجود که توسط Cloud Function ها پشتیبانی می شوند.
امضا:
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"]