params namespace

الدوال

دالة	الوصف
defineBoolean(name, options)	تعريف مَعلمة منطقية
defineInt(name, options)	اذكر مَعلمة عدد صحيح.
defineList(name, options)	تعريف مَعلمة القائمة
defineSecret(name)	يعرّف عن معلمة سرية، والتي ستبقى القيم موجودة في Cloud Secret Manager فقط. تُخزَّن الأسرار داخليًا كسلاسل بايت. استخدِم ParamOptions.as لتقديم تعديل النوع أثناء دقة المَعلمة.
defineString(name, options)	تعريف مَعلمة سلسلة
multiSelect(الخيارات)	يمكنك إنشاء إدخال متعدد الاختيارات من سلسلة من القيم.
multiSelect(الخيارات)	يمكنك إنشاء إدخال متعدد الاختيارات من خريطة التصنيفات إلى القيم.
select(options)	يمكنك إنشاء إدخال محدّد من سلسلة قيم.
select(optionsWithLabel)	إنشاء إدخال محدّد من خريطة التصنيفات إلى القيم

صفوف

الفئة	الوصف
التعبير

واجهات

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

المتغيرات

متغير	الوصف
BUCKET_PICKER	يمكنك إنشاء قائمة مجموعات البيانات تلقائيًا في مشروع يمكن للمستخدم الاختيار من بينها.
databaseURL	معلَمة مدمجة يتم حلها إلى عنوان URL التلقائي لقاعدة بيانات RTDB والمرتبط بالمشروع، بدون طلب نشر البيانات. سلسلة فارغة في حال عدم توفّرها.
معلَنات المَعلمات
gcloudProject	معلَمة مدمجة يتم حلها مع رقم تعريف المشروع على Google Cloud، بدون إرسال طلب إلى جهة النشر.
رقم تعريف المشروع	معلَمة مدمجة يتم حلها مع رقم تعريف المشروع على Google Cloud المرتبط بالمشروع، بدون إرسال طلب إلى جهة النشر.
storageBucket	معلَمة مدمجة يتم حلها مع حزمة Cloud Storage المرتبطة بالوظيفة، بدون طلب إذن من جهة النشر. سلسلة فارغة إذا لم يتم تحديدها.

كتابة العناوين البديلة للبريد الإلكتروني

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

params.defineBoolean()

تعريف مَعلمة منطقية

Signature:

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

المَعلمات

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

المرتجعات:

معامل منطقي

مَعلمة من نوع boolean من النوع .value.

params.defineInt()

اذكر مَعلمة عدد صحيح.

Signature:

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

المَعلمات

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

المرتجعات:

كاميرا IntParam

مَعلمة من نوع number من النوع .value.

params.defineList()

تعريف مَعلمة القائمة

Signature:

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

المَعلمات

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

المرتجعات:

رمز القائمة

مَعلمة من نوع string[] من النوع .value.

params.defineSecret()

يعرّف عن معلمة سرية، والتي ستبقى القيم موجودة في Cloud Secret Manager فقط. تُخزَّن الأسرار داخليًا كسلاسل بايت. استخدِم ParamOptions.as لتقديم تعديل النوع أثناء دقة المَعلمة.

Signature:

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

المَعلمات

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

المرتجعات:

كاميرا سرية

مَعلمة من نوع string من النوع .value.

params.defineString()

تعريف مَعلمة سلسلة

Signature:

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

المَعلمات

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

المرتجعات:

برمجة نصية سلسلة

مَعلمة من نوع string من النوع .value.

params.multiSelect()

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

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات	سلسلة[]

المرتجعات:

MultiSelectInput

params.multiSelect()

يمكنك إنشاء إدخال متعدد الاختيارات من خريطة التصنيفات إلى القيم.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات	سجلّ<string, string>

المرتجعات:

MultiSelectInput

params.select()

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

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات	T[]

المرتجعات:

SelectInput<T>

params.select()

إنشاء إدخال محدّد من خريطة التصنيفات إلى القيم

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات مع تصنيفات	سجل<string, T>

المرتجعات:

SelectInput<T>

params.BUCKET_PICKER

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

Signature:

BUCKET_PICKER: ResourceInput

params.databaseURL

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

Signature:

databaseURL: Param<string>

params.advertiserdParams

Signature:

declaredParams: SecretOrExpr[]

params.gcloudProject

معلَمة مدمجة يتم حلها مع رقم تعريف المشروع على Google Cloud، بدون إرسال طلب إلى جهة النشر.

Signature:

gcloudProject: Param<string>

params.projectID

معلَمة مدمجة يتم حلها مع رقم تعريف المشروع على Google Cloud المرتبط بالمشروع، بدون إرسال طلب إلى جهة النشر.

Signature:

projectID: Param<string>

params.storageBucket

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

Signature:

storageBucket: Param<string>

params.ParamOptions

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

Signature:

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