Funkcje
| Funkcja | Opis |
|---|---|
| defineBoolean(nazwa; opcje) | Zadeklaruj parametr logiczny. |
| defineInt(nazwa; opcje) | Deklarowanie parametru liczby całkowitej. |
| defineList(nazwa; opcje) | Zadeklarowanie parametru 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. Użyj ParamOptions.as, aby wskazać wskazówkę typu podczas rozpoznawania parametrów. |
| defineString(nazwa; opcje) | Zadeklarowanie parametru w postaci ciągu znaków. |
Zajęcia
| Klasa | Opis |
|---|---|
| Wyrażenia |
Zmienne
| Zmienna | Opis |
|---|---|
| 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 identyfikator 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 wdrażającego. Jeśli nie został zdefiniowany, pusty ciąg znaków. |
Aliasy typu
| Wpisz alias | Opis |
|---|---|
| ParamOptions | Opcje konfiguracji, których można używać do dostosowania wyświetlania prośby o parametr. |
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 dla parametru. |
Zwroty:
Wartość logiczna
Parametr z typem zwracanym boolean dla .value.
params.defineInt()
Deklarowanie parametru liczby całkowitej.
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 dla parametru. |
Zwroty:
IntParam
Parametr z typem zwracanym number dla .value.
params.defineList()
Zadeklarowanie parametru 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 dla parametru. |
Zwroty:
Parametr listy
Parametr z typem zwracanym 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. Użyj ParamOptions.as, aby wskazać wskazówkę typu podczas rozpoznawania parametrów.
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 z typem zwracanym string dla .value.
params.defineString()
Zadeklarowanie parametru 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 dla parametru. |
Zwroty:
StringParam
Parametr z typem zwracanym string dla .value.
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 identyfikator 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 wdrażającego. Jeśli nie został zdefiniowany, pusty ciąg znaków.
Podpis:
storageBucket: Param<string>
params.ParamOptions
Opcje konfiguracji, których można używać do dostosowania wyświetlania prośby o parametr.
Podpis:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;