機能
| 関数 | 説明 |
|---|---|
| defineBoolean(名前, オプション) | ブール型パラメータを宣言します。 |
| defineInt(名前, オプション) | 整数パラメータを宣言します。 |
| defineList(名前, オプション) | リストパラメータを宣言します。 |
| 秘密を定義(名前) | Cloud Secret Manager でのみ値を保持するシークレット パラメータを宣言します。シークレットはバイト文字列として内部的に保存されます。 ParamOptions を使用します。パラメータ解決中に型ヒントas提供します。 |
| 定義文字列(名前、オプション) | 文字列パラメータを宣言します。 |
クラス
| クラス | 説明 |
|---|---|
| 表現 |
変数
| 変数 | 説明 |
|---|---|
| データベースURL | デプロイヤにプロンプトを表示せずに、プロジェクトに関連付けられたデフォルトの RTDB データベース URL に解決される組み込みパラメータ。存在しない場合は空の文字列。 |
| 宣言されたパラメータ | |
| gcloudプロジェクト | デプロイ担当者にプロンプトを表示せずに、クラウド プロジェクト ID に解決される組み込みパラメータ。 |
| プロジェクトID | デプロイ担当者にプロンプトを表示せずに、プロジェクトに関連付けられたクラウド プロジェクト ID に解決される組み込みパラメータ。 |
| 保管バケツ | デプロイヤにプロンプトを表示せずに、関数に関連付けられたクラウド ストレージ バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。 |
タイプエイリアス
| タイプエイリアス | 説明 |
|---|---|
| パラメータオプション | Param のプロンプト動作をカスタマイズするために使用できる構成オプション。 |
params.defineBoolean()
ブール型パラメータを宣言します。
サイン：
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
| オプション | パラメータオプション<ブール値> | パラメータの設定オプション。 |
戻り値：
ブールパラメータ
.valueのboolean戻り値型を持つ Param 。
params.defineInt()
整数パラメータを宣言します。
サイン：
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
| オプション | パラメータオプション<番号> | パラメータの設定オプション。 |
戻り値：
IntParam
.valueの戻り値の型がnumberである Param 。
params.defineList()
リストパラメータを宣言します。
サイン：
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
| オプション | パラメータオプション<文字列[]> | パラメータの設定オプション。 |
戻り値：
リストパラメータ
.valueの戻り値の型がstring[]の Param 。
params.defineSecret()
Cloud Secret Manager でのみ値を保持するシークレット パラメータを宣言します。シークレットはバイト文字列として内部的に保存されます。 ParamOptions を使用します。パラメータ解決中に型ヒントas提供します。
サイン：
export declare function defineSecret(name: string): SecretParam;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
戻り値：
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.declaredParams
サイン：
declaredParams: SecretOrExpr[]
params.gcloudプロジェクト
デプロイ担当者にプロンプトを表示せずに、クラウド プロジェクト ID に解決される組み込みパラメータ。
サイン：
gcloudProject: Param<string>
params.プロジェクトID
デプロイ担当者にプロンプトを表示せずに、プロジェクトに関連付けられたクラウド プロジェクト ID に解決される組み込みパラメータ。
サイン：
projectID: Param<string>
params.storageバケット
デプロイヤにプロンプトを表示せずに、関数に関連付けられたクラウド ストレージ バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。
サイン：
storageBucket: Param<string>
params.ParamOptions
Param のプロンプト動作をカスタマイズするために使用できる構成オプション。
サイン：
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;