params namespace

کارکرد

کلاس ها

رابط ها

متغیرها

نام مستعار را تایپ کنید

params.defineBoolean()

یک پارامتر بولی را اعلام کنید.

امضا:

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

مولفه های

برمی‌گرداند:

BooleanParam

پارامتری با نوع بازگشتی boolean برای .value .

params.defineInt()

یک پارامتر عدد صحیح را اعلام کنید.

امضا:

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

مولفه های

برمی‌گرداند:

IntParam

یک پارامتر با نوع برگشتی number برای .value .

params.defineList()

یک پارامتر لیست را اعلام کنید.

امضا:

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

مولفه های

برمی‌گرداند:

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;

مولفه های

برمی‌گرداند:

StringParam

پارامتری با نوع string برای .value .

params.multiSelect()

یک ورودی چند انتخابی از یک سری مقادیر ایجاد کنید.

امضا:

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

مولفه های

برمی‌گرداند:

MultiSelectInput

params.multiSelect()

یک ورودی چند انتخابی از نقشه برچسب ها به مقادیر ایجاد کنید.

امضا:

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

مولفه های

برمی‌گرداند:

MultiSelectInput

params.select()

یک ورودی انتخابی از یک سری مقادیر ایجاد کنید.

امضا:

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

مولفه های

برمی‌گرداند:

ورودی را انتخاب کنید <T>

params.select()

یک ورودی انتخابی از نقشه برچسب‌ها به مقادیر ایجاد کنید.

امضا:

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

مولفه های

برمی‌گرداند:

ورودی را انتخاب کنید <T>

params.BUCKET_PICKER

ایجاد خودکار لیستی از سطل ها در یک پروژه که کاربر می تواند از بین آنها انتخاب کند.

امضا:

BUCKET_PICKER: ResourceInput

params.databaseURL

یک پارامتر داخلی که به URL پایگاه داده RTDB پیش‌فرض مرتبط با پروژه، بدون درخواست از توسعه‌دهنده، حل می‌شود. اگر هیچ رشته ای وجود ندارد، رشته را خالی کنید.

امضا:

databaseURL: Param<string>

params.declaredParams

امضا:

declaredParams: SecretOrExpr[]

params.gcloudProject

یک پارامتر داخلی که به ID پروژه Cloud، بدون درخواست از توسعه‌دهنده، حل می‌شود.

امضا:

gcloudProject: Param<string>

params.projectID

یک پارامتر داخلی که به ID پروژه Cloud مرتبط با پروژه، بدون درخواست از توسعه‌دهنده، حل می‌شود.

امضا:

projectID: Param<string>

params.storageBucket

یک پارامتر داخلی که به سطل ذخیره سازی Cloud مرتبط با عملکرد، بدون درخواست از Deployer، حل می شود. رشته خالی اگر تعریف نشده باشد.

امضا:

storageBucket: Param<string>

params.ParamOptions

گزینه های پیکربندی که می توانند برای سفارشی کردن رفتار درخواستی یک پارامتر استفاده شوند.

امضا:

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