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