Funktionen
| Funktion | Beschreibung |
|---|---|
| defineBoolean(name, Optionen) | Deklarieren Sie einen booleschen Parameter. |
| defineInt(name, Optionen) | Deklarieren Sie einen ganzzahligen Parameter. |
| defineList(name, Optionen) | Deklarieren Sie einen Listenparameter. |
| defineSecret(name) | Deklariert einen geheimen Parameter, der Werte nur im Cloud Secret Manager beibehält. Geheimnisse werden intern als Bytestrings gespeichert. Verwenden Sie ParamOptions. as Typhinweise während der Parameterauflösung bereitzustellen. |
| defineString(name, Optionen) | Deklarieren Sie einen String-Parameter. |
Klassen
| Klasse | Beschreibung |
|---|---|
| Ausdruck |
Variablen
| Variable | Beschreibung |
|---|---|
| DatenbankURL | Ein integrierter Parameter, der ohne Aufforderung an den Bereitsteller in die mit dem Projekt verknüpfte Standard-RTDB-Datenbank-URL aufgelöst wird. Leere Zeichenfolge, falls keine vorhanden ist. |
| deklarierteParams | |
| gcloudProject | Ein integrierter Parameter, der in die Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. |
| Projekt-ID | Ein integrierter Parameter, der in die mit dem Projekt verknüpfte Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. |
| storageBucket | Ein integrierter Parameter, der in den mit der Funktion verknüpften Cloud-Speicher-Bucket aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. Leere Zeichenfolge, falls nicht definiert. |
Geben Sie Aliase ein
| Geben Sie Alias ein | Beschreibung |
|---|---|
| ParamOptions | Konfigurationsoptionen, mit denen das Aufforderungsverhalten eines Parameters angepasst werden kann. |
params.defineBoolean()
Deklarieren Sie einen booleschen Parameter.
Unterschrift:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll. |
| Optionen | ParamOptions <boolean> | Konfigurationsmöglichkeiten für den Parameter. |
Kehrt zurück:
BooleanParam
Ein Param mit einem boolean Rückgabetyp für .value .
params.defineInt()
Deklarieren Sie einen ganzzahligen Parameter.
Unterschrift:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll. |
| Optionen | ParamOptions <Nummer> | Konfigurationsmöglichkeiten für den Parameter. |
Kehrt zurück:
IntParam
Ein Parameter mit einem number für .value .
params.defineList()
Deklarieren Sie einen Listenparameter.
Unterschrift:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll. |
| Optionen | ParamOptions <string[]> | Konfigurationsmöglichkeiten für den Parameter. |
Kehrt zurück:
ListParam
Ein Param mit einem string[] -Rückgabetyp für .value .
params.defineSecret()
Deklariert einen geheimen Parameter, der Werte nur im Cloud Secret Manager beibehält. Geheimnisse werden intern als Bytestrings gespeichert. Verwenden Sie ParamOptions. as Typhinweise während der Parameterauflösung bereitzustellen.
Unterschrift:
export declare function defineSecret(name: string): SecretParam;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll. |
Kehrt zurück:
SecretParam
Ein Param mit einem string Rückgabetyp für .value .
params.defineString()
Deklarieren Sie einen String-Parameter.
Unterschrift:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll. |
| Optionen | ParamOptions <string> | Konfigurationsmöglichkeiten für den Parameter. |
Kehrt zurück:
StringParam
Ein Param mit einem string Rückgabetyp für .value .
params.databaseURL
Ein integrierter Parameter, der ohne Aufforderung an den Bereitsteller in die mit dem Projekt verknüpfte Standard-RTDB-Datenbank-URL aufgelöst wird. Leere Zeichenfolge, falls keine vorhanden ist.
Unterschrift:
databaseURL: Param<string>
params.declaredParams
Unterschrift:
declaredParams: SecretOrExpr[]
params.gcloudProject
Ein integrierter Parameter, der in die Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern.
Unterschrift:
gcloudProject: Param<string>
params.projectID
Ein integrierter Parameter, der in die mit dem Projekt verknüpfte Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern.
Unterschrift:
projectID: Param<string>
params.storageBucket
Ein integrierter Parameter, der in den mit der Funktion verknüpften Cloud-Speicher-Bucket aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. Leere Zeichenfolge, falls nicht definiert.
Unterschrift:
storageBucket: Param<string>
params.ParamOptions
Konfigurationsoptionen, mit denen das Aufforderungsverhalten eines Parameters angepasst werden kann.
Unterschrift:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;