params namespace

المهام

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

الطبقات

فصل وصف
تعبير

واجهات

واجهه المستخدم وصف
MultiSelectInput يحدد أنه يجب تحديد قيمة المعلمة من خلال جعل المستخدم يحدد مجموعة فرعية من قائمة الخيارات الجاهزة بشكل تفاعلي في وقت النشر. سيؤدي إلى حدوث أخطاء إذا تم استخدامه على معلمات من نوع آخر غير string[] .
حدد الإدخال يحدد أنه يجب تحديد قيمة المعلمة من خلال جعل المستخدم يحدد من قائمة الخيارات الجاهزة مسبقًا بشكل تفاعلي في وقت النشر.
اشر على الخيارات أحد الخيارات المتوفرة لـ SelectInput ، والذي يحتوي على قيمة وتسمية يمكن قراءتها اختياريًا لعرضها في واجهة التحديد.
إدخال النص يحدد أنه يجب تحديد قيمة المعلمة من خلال مطالبة المستخدم بكتابتها بشكل تفاعلي في وقت النشر. ستتم إعادة محاولة الإدخال الذي لا يتطابق مع التحقق من الصحة المقدم، إذا كان موجودًا.

المتغيرات

عامل وصف
BUCKET_PICKER إنشاء قائمة بالمجموعات تلقائيًا في المشروع والتي يمكن للمستخدم الاختيار من بينها.
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. يتم تخزين الأسرار داخليًا على شكل سلاسل بايت. استخدم ParamOptions.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 .

معلمات.multiSelect()

قم بإنشاء إدخال متعدد التحديد من سلسلة من القيم.

إمضاء:

export declare function multiSelect(options: string[]): MultiSelectInput;

حدود

معامل يكتب وصف
خيارات خيط[]

عائدات:

MultiSelectInput

معلمات.multiSelect()

قم بإنشاء إدخال متعدد التحديد من خريطة التسميات إلى القيم.

إمضاء:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

حدود

معامل يكتب وصف
خيارات سجل <سلسلة، سلسلة>

عائدات:

MultiSelectInput

المعلمات.حدد ()

قم بإنشاء إدخال محدد من سلسلة من القيم.

إمضاء:

export declare function select<T>(options: T[]): SelectInput<T>;

حدود

معامل يكتب وصف
خيارات ت[]

عائدات:

حدد الإدخال <ت>

المعلمات.حدد ()

قم بإنشاء إدخال محدد من خريطة التسميات إلى القيم.

إمضاء:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

حدود

معامل يكتب وصف
optionsWithLabels سجل <سلسلة، T>

عائدات:

حدد الإدخال <ت>

params.BUCKET_PICKER

إنشاء قائمة بالمجموعات تلقائيًا في المشروع والتي يمكن للمستخدم الاختيار من بينها.

إمضاء:

BUCKET_PICKER: ResourceInput

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