函式
| 函式 | 說明 |
|---|---|
| defineBoolean(名稱, 選項) | 宣告布林值參數。 |
| defineInt(名稱, 選項) | 宣告整數參數。 |
| defineList(name, options) | 宣告清單參數。 |
| defineSecret(名稱) | 宣告密鑰參數，該參數只會在 Cloud Secret Manager 中保留值。密鑰會以位元組字串的形式依序儲存。使用 ParamOptions.as 可在參數解析期間提供類型提示。 |
| defineString(name, options) | 宣告字串參數。 |
類別
| 類別 | 說明 |
|---|---|
| 運算式 |
變數
| 變數 | 說明 |
|---|---|
| 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.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">;