params namespace

功能

课程

变量

类型别名

params.defineBoolean()

声明一个布尔参数。

签名：

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

参数

返回：

布尔参数

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

params.defineInt()

声明一个整数参数。

签名：

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

参数

返回：

内部参数

具有.value number返回类型的 Param 。

params.defineList()

声明一个列表参数。

签名：

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

参数

返回：

列表参数

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

params.defineSecret()

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

签名：

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

参数

返回：

秘密参数

具有.value string返回类型的 Param 。

params.defineString()

声明一个字符串参数。

签名：

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

参数

返回：

字符串参数

具有.value string返回类型的 Param 。

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

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

签名：

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