FunctionBuilder class

Signature:

export declare class FunctionBuilder

الشركات المصنِّعة

الشركة المصنِّعة المعدِّلات الوصف
(دالة الإنشاء)(options) إنشاء مثيل جديد لفئة FunctionBuilder

أماكن إقامة

الموقع المعدِّلات النوع الوصف
إحصاءات Google { event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder؛ }
المصادقة { user: (userOptions?: auth.UserOptions) => auth.UserBuilder؛ }
قاعدة بيانات {مثيل: (instance: string) => database.InstanceBuilder؛ ref: <ref extends string>(path: ref) => database.refBuilder<ref>; }
مخزن إطفاء { Document: <Path extends string>(path: Path) => firestore.DocumentBuilder<المسار>؛ مساحة الاسم: (namespace: string) => firestore.NamespaceBuilder؛ قاعدة البيانات: (database: string) => firestore.DatabaseBuilder؛ }
https { onRequest: (handler: (req: https.Request, resp: Express.Response) => null | Promise< معيّنة>) => import("./cloud-functions").HttpsFunction; onCall: (المعالِج: (data: any، السياق: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").قابلة للتشغيل<any>; }
pubsub { topic: (الموضوع: السلسلة) => pubsub.TopicBuilder؛ الجدولة: (الجدول الزمني: السلسلة) => pubsub.scheduleBuilder؛ }
remoteConfig { onUpdate: (handler: (version: remoteConfig.TemplateVersion، السياق: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }
مساحة التخزين { bucket: (bucket?: string) => storage.BucketBuilder; الكائن: () => storage.ObjectBuilder؛ }
المهام {taskVLOOKUP: (options?: tasks.Task playlistOptions) => tasks.Task playlistBuilder؛ }
testLab { testMatrix: () => testLab.TestMatrixBuilder؛ }

الطُرق

الطريقة المعدِّلات الوصف
region(المناطق) اضبط المناطق التي يتم نشر الدالة فيها.
runWith(runtimeOptions) يمكنك ضبط خيارات بيئة التشغيل للدالة.

FunctionBuilder.(دالة إنشائية)

إنشاء مثيل جديد لفئة FunctionBuilder

Signature:

constructor(options: DeploymentOptions);

المَعلمات

المعلمة النوع الوصف
خيارات DeploymentOptions

FunctionBuilder.analytics

Signature:

get analytics(): {
        event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
    };

FunctionBuilder.auth

Signature:

get auth(): {
        user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
    };

FunctionBuilder.database

Signature:

get database(): {
        instance: (instance: string) => database.InstanceBuilder;
        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
    };

FunctionBuilder.firestore

Signature:

get firestore(): {
        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
        namespace: (namespace: string) => firestore.NamespaceBuilder;
        database: (database: string) => firestore.DatabaseBuilder;
    };

FunctionBuilder.https

Signature:

get https(): {
        onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction;
        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
    };

FunctionBuilder.pubsub

Signature:

get pubsub(): {
        topic: (topic: string) => pubsub.TopicBuilder;
        schedule: (schedule: string) => pubsub.ScheduleBuilder;
    };

FunctionBuilder.remoteConfig

Signature:

get remoteConfig(): {
        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
    };

FunctionBuilder.storage

Signature:

get storage(): {
        bucket: (bucket?: string) => storage.BucketBuilder;
        object: () => storage.ObjectBuilder;
    };

FunctionBuilder.tasks

Signature:

get tasks(): {
        taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
    };

FunctionBuilder.testLab

Signature:

get testLab(): {
        testMatrix: () => testLab.TestMatrixBuilder;
    };

FunctionBuilder.region()

اضبط المناطق التي يتم نشر الدالة فيها.

Signature:

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

المَعلمات

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

المرتجعات:

أداة إنشاء الدوال

مثال 1

function.region('us-east1')

مثال 2

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

FunctionBuilder.runWith()

يمكنك ضبط خيارات بيئة التشغيل للدالة.

Signature:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

المَعلمات

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

المرتجعات:

أداة إنشاء الدوال