params namespace

功能

功能描述
定义布尔值（名称，选项）声明一个布尔参数。
定义Int（名称，选项）声明一个整数参数。
定义列表（名称，选项）声明一个列表参数。
定义秘密（名称）声明一个秘密参数，该参数仅在 Cloud Secret Manager 中保留值。秘密在内部存储为字节串。使用ParamOptions.as在参数解析期间提供类型提示。
定义字符串（名称，选项）声明一个字符串参数。
多选（选项）从一系列值创建多选输入。
多选（选项）创建从标签到值的映射的多选输入。
选择（选项）从一系列值中创建选择输入。
选择（带有标签的选项）创建从标签到值的映射的选择输入。

课程

班级描述
表达

接口

界面描述
多选输入指定参数的值应通过让用户在部署时以交互方式从预装选项列表中选择子集来确定。如果用于string[]以外类型的参数，将导致错误。
选择输入指定参数的值应通过让用户在部署时从预先设置的选项列表中进行交互选择来确定。
选择选项提供给SelectInput的选项之一，包含一个值和一个可选的人类可读标签以显示在选择界面中。
文本输入指定应通过在部署时提示用户以交互方式键入参数值来确定参数值。与提供的validationRegex（如果存在）不匹配的输入将被重试。

变量

多变的描述
BUCKET_PICKER自动生成项目中的存储桶列表，用户可以从中进行选择。
数据库URL一个内置参数，可解析为与项目关联的默认 RTDB 数据库 URL，而不提示部署人员。如果不存在则为空字符串。
声明的参数
gcloud项目解析为云项目 ID 的内置参数，无需提示部署人员。
项目ID一个内置参数，可解析为与项目关联的云项目 ID，而无需提示部署人员。
存储桶一个内置参数，可解析为与该函数关联的云存储存储桶，而无需提示部署者。如果未定义则为空字符串。

类型别名

类型别名描述
参数选项配置选项可用于自定义参数的提示行为。

params.defineBoolean()

声明一个布尔参数。

签名：

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

参数

范围类型描述
姓名细绳用于加载参数的环境变量的名称。
选项参数选项<布尔值>参数的配置选项。

返回：

布尔参数

.value具有boolean返回类型的参数。

params.defineInt()

声明一个整数参数。

签名：

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

参数

范围类型描述
姓名细绳用于加载参数的环境变量的名称。
选项参数选项<数字>参数的配置选项。

返回：

内部参数

具有.value number类型的参数。

params.defineList()

声明一个列表参数。

签名：

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

参数

范围类型描述
姓名细绳用于加载参数的环境变量的名称。
选项参数选项<字符串[]>参数的配置选项。

返回：

列表参数

.value的返回类型为string[]的参数。

params.defineSecret()

声明一个秘密参数，该参数仅在 Cloud Secret Manager 中保留值。秘密在内部存储为字节串。使用ParamOptions.as在参数解析期间提供类型提示。

签名：

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

参数

范围类型描述
姓名细绳用于加载参数的环境变量的名称。

返回：

秘密参数

具有.value string返回类型的参数。

params.defineString()

声明一个字符串参数。

签名：

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

参数

范围类型描述
姓名细绳用于加载参数的环境变量的名称。
选项参数选项<字符串>参数的配置选项。

返回：

字符串参数

具有.value string返回类型的参数。

params.multiSelect()

从一系列值创建多选输入。

签名：

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

参数

范围类型描述
选项细绳[]

返回：

多选输入

params.multiSelect()

创建从标签到值的映射的多选输入。

签名：

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

参数

范围类型描述
选项记录<字符串，字符串>

返回：

多选输入

params.select()

从一系列值中创建选择输入。

签名：

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

参数

范围类型描述
选项T[]

返回：

选择输入<T>

params.select()

创建从标签到值的映射的选择输入。

签名：

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

参数

范围类型描述
带标签的选项记录<字符串，T>

返回：

选择输入<T>

params.BUCKET_PICKER

自动生成项目中的存储桶列表，用户可以从中进行选择。

签名：

BUCKET_PICKER: ResourceInput

params.databaseURL

一个内置参数，可解析为与项目关联的默认 RTDB 数据库 URL，而不提示部署人员。如果不存在则为空字符串。

签名：

databaseURL: Param<string>

params.声明的Params

签名：

declaredParams: SecretOrExpr[]

params.gcloudProject

解析为云项目 ID 的内置参数，无需提示部署人员。

签名：

gcloudProject: Param<string>

params.projectID

一个内置参数，可解析为与项目关联的云项目 ID，而无需提示部署人员。

签名：

projectID: Param<string>

params.storageBucket

一个内置参数，可解析为与该函数关联的云存储存储桶，而无需提示部署者。如果未定义则为空字符串。

签名：

storageBucket: Param<string>

params.ParamOptions

配置选项可用于自定义参数的提示行为。

签名：

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