函数
| 函数 | 说明 |
|---|---|
| defineBoolean(name, options) | 声明一个布尔值参数。 |
| defineInt(name, options) | 声明一个整数参数。 |
| defineList(name, options) | 声明一个列表参数。 |
| defineSecret(name) | 声明一个 Secret 参数，该参数将仅在 Cloud Secret Manager 中保留值。Secret 在内部以字节串的形式存储。使用 ParamOptions.as 在参数解析期间提供类型提示。 |
| defineString(name, options) | 声明一个字符串参数。 |
| multiSelect(options) | 根据一系列值创建多选输入。 |
| multiSelect(options) | 创建从标签映射至值的多选输入。 |
| select(options) | 从一系列值创建选择输入。 |
| select(optionsWithLabel) | 从标签到值的映射创建选择输入。 |
类
| 类 | 说明 |
|---|---|
| 表达式 |
接口
| 接口 | 说明 |
|---|---|
| MultiSelectInput | 指定应通过以下方式确定参数的值：在部署时让用户以交互方式从预预设选项列表中选择一个子集。如果用于非 string[] 类型的参数，则会导致错误。 |
| SelectInput | 指定应通过以下方式确定参数的值：在部署时让用户以交互方式从预预设选项列表中进行选择。 |
| SelectOptions | 提供给 SelectInput 的选项之一，包含一个值，以及要在选择界面中显示的人类可读标签（可选）。 |
| TextInput | 指定应在部署时提示用户以交互方式输入参数的值来确定参数的值。系统将重试与提供的 verificationRegex 不匹配的输入（如果存在）。 |
变量
| 变量 | 说明 |
|---|---|
| 存储分区选择器 | 在项目中自动生成可供用户选择的存储分区列表。 |
| database网址 | 一个内置参数，会在不提示部署者的情况下解析为与项目关联的默认 RTDB 数据库网址。如果不存在，则为空字符串。 |
| claimdParams | |
| gcloud 项目 | 内置参数，会在不提示部署者的情况下解析为 Cloud 项目 ID。 |
| 项目 ID | 内置参数，会在不提示部署者的情况下解析为与项目关联的 Cloud 项目 ID。 |
| storageBucket | 内置参数，会解析为与函数关联的 Cloud Storage 存储分区，而不会提示部署者。如果未定义，则为空字符串。 |
类型别名
| 类型别名 | 说明 |
|---|---|
| ParamOptions | 可用于自定义参数的提示行为的配置选项。 |
params.defineBoolean()
声明一个布尔值参数。
签名：
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | ParamOptions<布尔值> | 参数的配置选项。 |
返回：
布尔值参数
一个具有 boolean 返回值类型的 .value 参数。
params.defineInt()
声明一个整数参数。
签名：
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | ParamOptions<数字> | 参数的配置选项。 |
返回：
IntParam
一个具有 number 返回值类型的 .value 参数。
params.defineList()
声明一个列表参数。
签名：
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | 参数选项<string[]> | 参数的配置选项。 |
返回：
列表参数
一个具有 string[] 返回值类型的 .value 参数。
params.defineSecret()
声明一个 Secret 参数，该参数将仅在 Cloud Secret Manager 中保留值。Secret 在内部以字节串的形式存储。使用 ParamOptions.as 在参数解析期间提供类型提示。
签名：
export declare function defineSecret(name: string): SecretParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
返回：
SecretParam
一个具有 string 返回值类型的 .value 参数。
params.defineString()
声明一个字符串参数。
签名：
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | ParamOptions<字符串> | 参数的配置选项。 |
返回：
字符串参数
一个具有 string 返回值类型的 .value 参数。
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[] |
返回：
SelectInput<T>
params.select()
从标签到值的映射创建选择输入。
签名：
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 包含标签的选项 | 记录<string, T> |
返回：
SelectInput<T>
params.BUCKET_PICKER
在项目中自动生成可供用户选择的存储分区列表。
签名：
BUCKET_PICKER: ResourceInput
params.database网址
一个内置参数，会在不提示部署者的情况下解析为与项目关联的默认 RTDB 数据库网址。如果不存在，则为空字符串。
签名：
databaseURL: Param<string>
params.DeclaredParams
签名：
declaredParams: SecretOrExpr[]
params.gcloud 项目
内置参数，会在不提示部署者的情况下解析为 Cloud 项目 ID。
签名：
gcloudProject: Param<string>
params.projectID
内置参数，会在不提示部署者的情况下解析为与项目关联的 Cloud 项目 ID。
签名：
projectID: Param<string>
params.storageBucket
内置参数，会解析为与函数关联的 Cloud Storage 存储分区，而不会提示部署者。如果未定义，则为空字符串。
签名：
storageBucket: Param<string>
params.ParamOptions
可用于自定义参数的提示行为的配置选项。
签名：
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;