params namespace

المهام

وظيفة وصف
تعريف منطقي (الاسم، الخيارات) قم بتعريف معلمة منطقية.
تعريف Int (الاسم والخيارات) قم بتعريف معلمة عدد صحيح.
قائمة التعريف (الاسم، الخيارات) قم بتعريف قائمة المعلمة.
تعريف السر (الاسم) يعلن عن معلمة سرية، والتي ستستمر في القيم فقط في Cloud Secret Manager. يتم تخزين الأسرار بشكل داخلي كسلاسل بايت. استخدم خيارات Param. as تلميح النوع أثناء تحليل المعلمة.
تعريف السلسلة (الاسم، الخيارات) قم بتعريف معلمة سلسلة.

الطبقات

فصل وصف
تعبير

المتغيرات

عامل وصف
dataURL معلمة مضمنة تعمل على حل عنوان URL الافتراضي لقاعدة بيانات RTDB المرتبطة بالمشروع، دون مطالبة الموزع. سلسلة فارغة في حالة عدم وجودها.
أعلنParams
gcloudProject معلمة مضمنة تعمل على حل معرف مشروع السحابة، دون مطالبة الناشر.
معرف المشروع معلمة مضمنة تعمل على حل معرف مشروع السحابة المرتبط بالمشروع، دون مطالبة الناشر.
com.storageBucket معلمة مدمجة تعمل على حل حاوية التخزين السحابية المرتبطة بالوظيفة، دون مطالبة الناشر. سلسلة فارغة إذا لم يتم تعريفها.

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

اكتب الاسم المستعار وصف
ParamOptions خيارات التكوين التي يمكن استخدامها لتخصيص سلوك المطالبة للمعلمة.

params.defineBoolean()

قم بتعريف معلمة منطقية.

إمضاء:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

حدود

معامل يكتب وصف
اسم خيط اسم متغير البيئة الذي سيتم استخدامه لتحميل المعلمة.
خيارات ParamOptions <منطقية> خيارات التكوين للمعلمة.

عائدات:

BooleanParam

معلمة بنوع إرجاع boolean لـ .value .

params.defineInt()

قم بتعريف معلمة عدد صحيح.

إمضاء:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

حدود

معامل يكتب وصف
اسم خيط اسم متغير البيئة الذي سيتم استخدامه لتحميل المعلمة.
خيارات ParamOptions <رقم> خيارات التكوين للمعلمة.

عائدات:

إنتبارام

معلمة مع نوع إرجاع number لـ .value .

params.defineList()

قم بتعريف قائمة المعلمة.

إمضاء:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

حدود

معامل يكتب وصف
اسم خيط اسم متغير البيئة الذي سيتم استخدامه لتحميل المعلمة.
خيارات ParamOptions <سلسلة[]> خيارات التكوين للمعلمة.

عائدات:

ListParam

معلمة مع نوع الإرجاع string[] لـ .value .

params.defineSecret()

يعلن عن معلمة سرية، والتي ستستمر في القيم فقط في Cloud Secret Manager. يتم تخزين الأسرار بشكل داخلي كسلاسل بايت. استخدم خيارات Param. as تلميح النوع أثناء تحليل المعلمة.

إمضاء:

export declare function defineSecret(name: string): SecretParam;

حدود

معامل يكتب وصف
اسم خيط اسم متغير البيئة الذي سيتم استخدامه لتحميل المعلمة.

عائدات:

SecretParam

معلمة مع نوع إرجاع string لـ .value .

params.defineString()

قم بتعريف معلمة سلسلة.

إمضاء:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

حدود

معامل يكتب وصف
اسم خيط اسم متغير البيئة الذي سيتم استخدامه لتحميل المعلمة.
خيارات ParamOptions <سلسلة> خيارات التكوين للمعلمة.

عائدات:

StringParam

معلمة مع نوع إرجاع string لـ .value .

params.databaseURL

معلمة مضمنة تعمل على حل عنوان URL الافتراضي لقاعدة بيانات RTDB المرتبطة بالمشروع، دون مطالبة الناشر. سلسلة فارغة في حالة عدم وجودها.

إمضاء:

databaseURL: Param<string>

params.declaredParams

إمضاء:

declaredParams: SecretOrExpr[]

params.gcloudProject

معلمة مضمنة تعمل على حل معرف مشروع السحابة، دون مطالبة الناشر.

إمضاء:

gcloudProject: Param<string>

params.projectID

معلمة مضمنة تعمل على حل معرف مشروع السحابة المرتبط بالمشروع، دون مطالبة الناشر.

إمضاء:

projectID: Param<string>

params.storageBucket

معلمة مدمجة تعمل على حل حاوية التخزين السحابية المرتبطة بالوظيفة، دون مطالبة الناشر. سلسلة فارغة إذا لم يتم تعريفها.

إمضاء:

storageBucket: Param<string>

params.ParamOptions

خيارات التكوين التي يمكن استخدامها لتخصيص سلوك المطالبة للمعلمة.

إمضاء:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;