params namespace

الدوال

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

صفوف

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

المتغيرات

متغير الوصف
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.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">;