params namespace

功能

功能描述
定義布林值（名稱，選項）聲明一個布林參數。
定義Int（名稱，選項）聲明一個整數參數。
定義清單（名稱，選項）聲明一個列表參數。
定義秘密（名稱）聲明一個秘密參數，該參數僅在 Cloud Secret Manager 中保留值。秘密以位元組字串的形式儲存在內部。使用參數選項。 as參數解析期間提供類型提示。
定義字串（名稱，選項）聲明一個字串參數。

課程

班級描述
表達

變數

多變的描述
資料庫URL一個內建參數，可解析為與專案關聯的預設 RTDB 資料庫 URL，而不提示部署人員。如果不存在則為空字串。
聲明的參數
gcloud項目解析為雲端項目 ID 的內建參數，無需提示部署人員。
專案ID一個內建參數，可解析為與專案關聯的雲端項目 ID，而不提示部署人員。
儲存桶一個內建參數，可解析為與該函數關聯的雲端儲存儲存桶，而無需提示部署者。如果未定義則為空字串。

類型別名

類型別名描述
參數選項可用於自訂 Param 的提示行為的設定選項。

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">;