کارکرد
| تابع | شرح |
|---|---|
| defineBoolean (نام، گزینه ها) | یک پارامتر بولی را اعلام کنید. |
| defineInt (نام، گزینه‌ها) | یک پارامتر عدد صحیح را اعلام کنید. |
| defineList (نام، گزینه ها) | یک پارامتر لیست را اعلام کنید. |
| defineSecret(نام) | یک پارامتر مخفی را اعلام می کند که مقادیر را فقط در Cloud Secret Manager حفظ می کند. اسرار به صورت درونی به عنوان بای تست ذخیره می شوند. از ParamOptions استفاده کنید. as ارائه اشاره نوع در طول وضوح پارامتر. |
| defineString (نام، گزینه ها) | یک پارامتر رشته را اعلام کنید. |
کلاس ها
| کلاس | شرح |
|---|---|
| اصطلاح |
متغیرها
| متغیر | شرح |
|---|---|
| پایگاه داده URL | یک پارامتر داخلی که به URL پایگاه داده RTDB پیش‌فرض مرتبط با پروژه، بدون درخواست از Deployer حل می‌شود. اگر رشته ای وجود ندارد، رشته را خالی کنید. |
| Params را اعلام کرد | |
| gcloudProject | یک پارامتر داخلی که بدون درخواست از Deployer به شناسه پروژه Cloud حل می شود. |
| شناسه پروژه | یک پارامتر داخلی که به ID پروژه Cloud مرتبط با پروژه، بدون درخواست از Deployer حل می شود. |
| سطل ذخیره سازی | یک پارامتر داخلی که به سطل ذخیره سازی Cloud مرتبط با عملکرد، بدون درخواست از Deployer حل می شود. رشته خالی اگر تعریف نشده باشد. |
نام مستعار را تایپ کنید
| نام مستعار را تایپ کنید | شرح |
|---|---|
| ParamOptions | گزینه های پیکربندی که می توانند برای سفارشی کردن رفتار درخواستی یک Param استفاده شوند. |
params.defineBoolean()
یک پارامتر بولی را اعلام کنید.
امضا:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| نام | رشته | نام متغیر محیطی که برای بارگیری پارامتر استفاده می شود. |
| گزینه ها | ParamOptions <بولی> | گزینه های پیکربندی برای پارامتر. |
برمی‌گرداند:
BooleanParam
یک Param با نوع بازگشتی boolean برای .value .
params.defineInt()
یک پارامتر عدد صحیح را اعلام کنید.
امضا:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| نام | رشته | نام متغیر محیطی که برای بارگیری پارامتر استفاده می شود. |
| گزینه ها | ParamOptions <تعداد> | گزینه های پیکربندی برای پارامتر. |
برمی‌گرداند:
IntParam
یک Param با نوع برگشتی number برای .value .
params.defineList()
یک پارامتر لیست را اعلام کنید.
امضا:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| نام | رشته | نام متغیر محیطی که برای بارگیری پارامتر استفاده می شود. |
| گزینه ها | ParamOptions <رشته[]> | گزینه های پیکربندی برای پارامتر. |
برمی‌گرداند:
ListParam
یک Param با یک string[] نوع بازگشتی برای .value .
params.defineSecret()
یک پارامتر مخفی را اعلام می کند که مقادیر را فقط در Cloud Secret Manager حفظ می کند. اسرار به صورت درونی به عنوان بای تست ذخیره می شوند. از ParamOptions استفاده کنید. as ارائه اشاره نوع در طول وضوح پارامتر.
امضا:
export declare function defineSecret(name: string): SecretParam;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| نام | رشته | نام متغیر محیطی که برای بارگیری پارامتر استفاده می شود. |
برمی‌گرداند:
SecretParam
یک Param با یک نوع string برای .value .
params.defineString()
یک پارامتر رشته را اعلام کنید.
امضا:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| نام | رشته | نام متغیر محیطی که برای بارگیری پارامتر استفاده می شود. |
| گزینه ها | ParamOptions <رشته> | گزینه های پیکربندی برای پارامتر. |
برمی‌گرداند:
StringParam
یک Param با یک نوع string برای .value .
params.databaseURL
یک پارامتر داخلی که به URL پایگاه داده RTDB پیش‌فرض مرتبط با پروژه، بدون درخواست از Deployer حل می‌شود. اگر رشته ای وجود ندارد، رشته را خالی کنید.
امضا:
databaseURL: Param<string>
params.declaredParams
امضا:
declaredParams: SecretOrExpr[]
params.gcloudProject
یک پارامتر داخلی که بدون درخواست از Deployer به شناسه پروژه Cloud حل می شود.
امضا:
gcloudProject: Param<string>
params.projectID
یک پارامتر داخلی که به ID پروژه Cloud مرتبط با پروژه، بدون درخواست از Deployer حل می شود.
امضا:
projectID: Param<string>
params.storageBucket
یک پارامتر داخلی که به سطل ذخیره سازی Cloud مرتبط با عملکرد، بدون درخواست از Deployer حل می شود. رشته خالی اگر تعریف نشده باشد.
امضا:
storageBucket: Param<string>
params.ParamOptions
گزینه های پیکربندی که می توانند برای سفارشی کردن رفتار درخواستی یک Param استفاده شوند.
امضا:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;