函数
| 函数 | 说明 |
|---|---|
| defineBoolean(name, options) | 声明一个布尔值参数。 |
| defineInt(name, options) | 声明一个整数参数。 |
| defineList(name, options) | 声明一个列表参数。 |
| defineSecret(name) | 声明一个 Secret 参数，该参数将仅在 Cloud Secret Manager 中保留值。Secret 在内部作为字节串存储。使用 ParamOptions.as 在参数解析期间提供类型提示。 |
| defineString(name, options) | 声明一个字符串参数。 |
类
| 类 | 说明 |
|---|---|
| 表达式 |
变量
| 变量 | 说明 |
|---|---|
| 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<布尔值> | 参数的配置选项。 |
返回：
布尔值参数
.value 的返回值类型为 boolean 的参数。
params.defineInt()
声明一个整数参数。
签名：
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | ParamOptions<数字> | 参数的配置选项。 |
返回：
IntParam
.value 的返回值类型为 number 的参数。
params.defineList()
声明一个列表参数。
签名：
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | 参数选项<string[]> | 参数的配置选项。 |
返回：
列表参数
.value 的返回值类型为 string[] 的参数。
params.defineSecret()
声明一个 Secret 参数，该参数将仅在 Cloud Secret Manager 中保留值。Secret 在内部作为字节串存储。使用 ParamOptions.as 在参数解析期间提供类型提示。
签名：
export declare function defineSecret(name: string): SecretParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
返回：
SecretParam
.value 的返回值类型为 string 的参数。
params.defineString()
声明一个字符串参数。
签名：
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 字符串 | 用于加载参数的环境变量的名称。 |
| 选项 | ParamOptions<字符串> | 参数的配置选项。 |
返回：
字符串参数
.value 的返回值类型为 string 的参数。
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">;