Funkcje
| Funkcja | Opis |
|---|---|
| defineBoolean(nazwa; opcje) | Zadeklaruj parametr logiczny. |
| defineInt(nazwa; opcje) | Zadeklaruj parametr będący liczbą całkowitą. |
| defineList(nazwa; opcje) | Zadeklaruj parametr listy. |
| defineSecret(nazwa) | Deklaruje parametr obiektu tajnego, który będzie zapamiętywany tylko w usłudze Cloud Secret Manager. Obiekty tajne są przechowywane wewnętrznie jako ciągi bajtów. Aby wskazać typ w trakcie rozpoznawania parametrów, użyj parametru ParamOptions.as. |
| defineString(nazwa; opcje) | Zadeklaruj parametr w postaci ciągu znaków. |
| multiSelect(opcje) | Utwórz dane wejściowe wielokrotnego wyboru na podstawie serii wartości. |
| multiSelect(opcje) | Utwórz dane wejściowe wielokrotnego wyboru z mapowania etykiet na wartości. |
| select(options). | Utwórz dane wejściowe z serii wartości. |
| select(optionsWithlabel) | Utwórz dane wejściowe z mapowania etykiet na wartości. |
Zajęcia
| Klasa | Opis |
|---|---|
| Wyrażenia |
Interfejsy
| Interfejs | Opis |
|---|---|
| Wybór wielokrotny | Określa, że wartość parametru powinna być określona przez interaktywne wybieranie podzbioru z listy wstępnie przygotowanych opcji przez użytkownika podczas wdrażania. Wystąpi błędy w przypadku użycia z parametrami typu innego niż string[]. |
| Wybór danych wejściowych | Określa, że wartość parametru powinna być określana przez interaktywne zaznaczenie przez użytkownika opcji z listy wstępnie przygotowanych opcji podczas wdrażania. |
| SelectOptions | Jedna z opcji dostępnych w SelectInput, zawierająca wartość i opcjonalnie czytelną dla człowieka etykietę do wyświetlenia w interfejsie wyboru. |
| TextInput | Określa, że wartość parametru powinna być określana przez wyświetlenie użytkownikowi prośby o interaktywne wpisanie jej podczas wdrażania. Dane wejściowe niepasujące do podanego wyrażenia VerificationRegex (jeśli występuje) zostaną powtórzone. |
Zmienne
| Zmienna | Opis |
|---|---|
| ZASOBNIK_PICKER | Automatycznie wygeneruj listę zasobników w projekcie, spośród których użytkownik może wybierać. |
| URL bazy danych | Wbudowany parametr, który prowadzi do domyślnego adresu URL bazy danych RTDB powiązanego z projektem bez pytania wdrażającego. Jeśli nie ma takiego ciągu, pole jest puste. |
| zadeklarowane parametry | |
| gcloudProject, | Wbudowany parametr, który przekazuje informacje do identyfikatora projektu Cloud bez pytania wdrażającego. |
| identyfikator projektu | Wbudowany parametr, który przekazuje identyfikator projektu Cloud powiązany z projektem bez pytania wdrażającego. |
| storageBucket, | Wbudowany parametr, który przekazuje informacje do zasobnika Cloud Storage powiązanego z funkcją, bez pytania o aplikację wdrażającą. Jeśli nie został zdefiniowany, pusty ciąg znaków. |
Aliasy typu
| Wpisz alias | Opis |
|---|---|
| ParamOptions | Opcje konfiguracji, które mogą służyć do dostosowywania sposobu wyświetlania próśb o parametry. |
params.defineBoolean()
Zadeklaruj parametr logiczny.
Podpis:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nazwa | ciąg znaków | Nazwa zmiennej środowiskowej, która ma być używana do wczytywania parametru. |
| opcje | ParamOptions<boolean>, | Opcje konfiguracji parametru. |
Zwroty:
Wartość logiczna
Parametr, który zwraca typ boolean dla .value.
params.defineInt()
Zadeklaruj parametr będący liczbą całkowitą.
Podpis:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nazwa | ciąg znaków | Nazwa zmiennej środowiskowej, która ma być używana do wczytywania parametru. |
| opcje | ParamOptions<number> | Opcje konfiguracji parametru. |
Zwroty:
IntParam
Parametr, który zwraca typ number dla .value.
params.defineList()
Zadeklaruj parametr listy.
Podpis:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nazwa | ciąg znaków | Nazwa zmiennej środowiskowej, która ma być używana do wczytywania parametru. |
| opcje | ParamOptions<string[]> | Opcje konfiguracji parametru. |
Zwroty:
Parametr listy
Parametr, który zwraca typ string[] dla .value.
params.defineSecret()
Deklaruje parametr obiektu tajnego, który będzie zapamiętywany tylko w usłudze Cloud Secret Manager. Obiekty tajne są przechowywane wewnętrznie jako ciągi bajtów. Aby wskazać typ w trakcie rozpoznawania parametrów, użyj parametru ParamOptions.as.
Podpis:
export declare function defineSecret(name: string): SecretParam;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nazwa | ciąg znaków | Nazwa zmiennej środowiskowej, która ma być używana do wczytywania parametru. |
Zwroty:
Parametr tajny
Parametr, który zwraca typ string dla .value.
params.defineString()
Zadeklaruj parametr w postaci ciągu znaków.
Podpis:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nazwa | ciąg znaków | Nazwa zmiennej środowiskowej, która ma być używana do wczytywania parametru. |
| opcje | ParamOptions<string> | Opcje konfiguracji parametru. |
Zwroty:
StringParam
Parametr, który zwraca typ string dla .value.
params.multiSelect()
Utwórz dane wejściowe wielokrotnego wyboru na podstawie serii wartości.
Podpis:
export declare function multiSelect(options: string[]): MultiSelectInput;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | ciąg znaków[] |
Zwroty:
params.multiSelect()
Utwórz dane wejściowe wielokrotnego wyboru z mapowania etykiet na wartości.
Podpis:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | Rekord<ciąg, ciąg> |
Zwroty:
params.select()
Utwórz dane wejściowe z serii wartości.
Podpis:
export declare function select<T>(options: T[]): SelectInput<T>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | K[] |
Zwroty:
SelectInput<T>
params.select()
Utwórz dane wejściowe z mapowania etykiet na wartości.
Podpis:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcjeZ etykietami | Rekord<ciąg, T> |
Zwroty:
SelectInput<T>
params.BUCKET_PICKER
Automatycznie wygeneruj listę zasobników w projekcie, spośród których użytkownik może wybierać.
Podpis:
BUCKET_PICKER: ResourceInput
params.databaseURL
Wbudowany parametr, który prowadzi do domyślnego adresu URL bazy danych RTDB powiązanego z projektem bez pytania wdrażającego. Jeśli nie ma takiego ciągu, pole jest puste.
Podpis:
databaseURL: Param<string>
params.referraldParams
Podpis:
declaredParams: SecretOrExpr[]
params.gcloudProject
Wbudowany parametr, który przekazuje informacje do identyfikatora projektu Cloud bez pytania wdrażającego.
Podpis:
gcloudProject: Param<string>
params.projectID
Wbudowany parametr, który przekazuje identyfikator projektu Cloud powiązany z projektem bez pytania wdrażającego.
Podpis:
projectID: Param<string>
params.storageBucket
Wbudowany parametr, który przekazuje informacje do zasobnika Cloud Storage powiązanego z funkcją, bez pytania o to narzędzie wdrażające. Jeśli nie został zdefiniowany, pusty ciąg znaków.
Podpis:
storageBucket: Param<string>
params.ParamOptions
Opcje konfiguracji, które mogą służyć do dostosowywania sposobu wyświetlania próśb o parametry.
Podpis:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;