函式
| 函式 | 說明 |
|---|---|
| defineBoolean(名稱, 選項) | 宣告布林值參數。 |
| defineInt(名稱, 選項) | 宣告整數參數。 |
| defineList(name, options) | 宣告清單參數。 |
| defineSecret(名稱) | 宣告密鑰參數，該參數只會在 Cloud Secret Manager 中保留值。密鑰會在內部儲存為位元組字串。使用 ParamOptions.as 在參數解析期間提供類型提示。 |
| defineString(name, options) | 宣告字串參數。 |
| multiSelect(選項) | 從一系列值中建立複選題。 |
| multiSelect(選項) | 建立從標籤對應到值的複選輸入項目。 |
| select(選項) | 從一系列值中建立選取輸入內容。 |
| select(optionsWithLabels) | 建立從標籤對應到值的選取輸入項目。 |
類別
| 類別 | 說明 |
|---|---|
| 運算式 |
介面
| 介面 | 說明 |
|---|---|
| MultiSelectInput | 指出在部署期間，讓使用者從預先制式選項清單中選取子集，藉此決定參數值。如果用於 string[] 以外的類型參數，就會發生錯誤。 |
| 選取輸入來源 | 指定參數值應在部署期間，讓使用者從預先掃描選項清單中選取，以決定參數值。 |
| 選取選項 | 提供給 SelectInput 的選項之一，其中包含一個值以及 (選擇性) 要在選取介面中顯示的標籤。 |
| TextInput | 指定應在部署期間提示使用者以互動方式輸入參數值，藉此決定參數值。如果輸入的內容與所提供 verificationRegex 不相符，系統會重試。 |
變數
| 變數 | 說明 |
|---|---|
| BUCKET_PICKER | 自動產生專案中的值區清單，供使用者選取。 |
| databaseURL | 內建參數，可解析為與專案相關聯的預設 RTDB 資料庫網址，而不會提示部署者。如果沒有，則為空白字串。 |
| 宣告參數 | |
| gcloud 專案 | 會在不提示部署者的情況下解析 Cloud 專案 ID 的內建參數。 |
| projectID | 內建參數，可解析為與專案相關聯的 Cloud 專案 ID，而不會提示部署者。 |
| storage 值區 | 內建參數，可解析與函式相關聯的 Cloud Storage 值區，而且不會提示部署者。如未定義，則為空白字串。 |
型別別名
| 類型別名 | 說明 |
|---|---|
| 參數選項 | 設定選項，可用來自訂參數的提示行為。 |
params.defineBoolean()
宣告布林值參數。
簽名：
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 用於載入參數的環境變數名稱。 |
| 選項 | 參數選項<boolean> | 參數的設定選項。 |
傳回：
BooleanParam
具有 boolean 傳回類型 .value 的參數。
params.defineInt()
宣告整數參數。
簽名：
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 用於載入參數的環境變數名稱。 |
| 選項 | 參數選項<數字> | 參數的設定選項。 |
傳回：
IntParam
具有 number 傳回類型 .value 的參數。
params.defineList()
宣告清單參數。
簽名：
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 用於載入參數的環境變數名稱。 |
| 選項 | ParamOptions<string[]> | 參數的設定選項。 |
傳回：
列出參數
具有 string[] 傳回類型 .value 的參數。
params.defineSecret()
宣告密鑰參數，該參數只會在 Cloud Secret Manager 中保留值。密鑰會在內部儲存為位元組字串。使用 ParamOptions.as 在參數解析期間提供類型提示。
簽名：
export declare function defineSecret(name: string): SecretParam;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 用於載入參數的環境變數名稱。 |
傳回：
SecretParam
具有 string 傳回類型 .value 的參數。
params.defineString()
宣告字串參數。
簽名：
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 用於載入參數的環境變數名稱。 |
| 選項 | ParamOptions<string> | 參數的設定選項。 |
傳回：
StringParam
具有 string 傳回類型 .value 的參數。
params.multiSelect()
從一系列值中建立複選題。
簽名：
export declare function multiSelect(options: string[]): MultiSelectInput;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | string[] |
傳回：
params.multiSelect()
建立從標籤對應到值的複選輸入項目。
簽名：
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | 錄音<字串, 字串> |
傳回：
params.select()
從一系列值中建立選取輸入內容。
簽名：
export declare function select<T>(options: T[]): SelectInput<T>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | 二 [] |
傳回：
選取輸入來源<T>
params.select()
建立從標籤對應到值的選取輸入項目。
簽名：
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| optionsWithLabels | 錄音<字串, T> |
傳回：
選取輸入來源<T>
params.BUCKET_PICKER
自動產生專案中的值區清單，供使用者選取。
簽名：
BUCKET_PICKER: ResourceInput
params.databaseURL
內建參數，可解析為與專案相關聯的預設 RTDB 資料庫網址，而不會提示部署者。如果沒有，則為空白字串。
簽名：
databaseURL: Param<string>
params.宣告 dParams
簽名：
declaredParams: SecretOrExpr[]
params.gcloudProject
會在不提示部署者的情況下解析 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">;