params namespace

Funkcje

Funkcjonować Opis
zdefiniujBoolean(nazwa, opcje) Zadeklaruj parametr logiczny.
zdefiniujInt(nazwa, opcje) Zadeklaruj parametr będący liczbą całkowitą.
zdefiniujList(nazwa, opcje) Zadeklaruj parametr listy.
zdefiniujSecret(nazwa) Deklaruje tajny parametr, który będzie utrwalał wartości tylko w Cloud Secret Manager. Sekrety są przechowywane wewnętrznie jako ciągi bajtowe. Użyj opcji ParamOptions. as zapewnić wskazówkę dotyczącą typu podczas rozpoznawania parametrów.
zdefiniujString(nazwa, opcje) Zadeklaruj parametr ciągu.

Zajęcia

Klasa Opis
Wyrażenie

Zmienne

Zmienny Opis
adres URL bazy danych Wbudowany parametr, który zwraca domyślny adres URL bazy danych RTDB powiązany z projektem, bez monitowania osoby wdrażającej. Pusty ciąg znaków, jeśli żaden nie istnieje.
zadeklarowaneParamy
gcloudProject Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu Cloud bez monitowania osoby wdrażającej.
identyfikator projektu Wbudowany parametr, który przekształca się w identyfikator projektu Cloud powiązany z projektem, bez monitowania wdrażającego.
Wiadro do przechowywania Wbudowany parametr, który przekłada się na zasobnik w chmurze powiązany z funkcją, bez monitowania wdrażającego. Pusty ciąg znaków, jeśli nie został zdefiniowany.

Wpisz aliasy

Wpisz Alias Opis
Opcje parametrów Opcje konfiguracyjne, których można użyć do dostosowania zachowania monitującego parametru.

parametry.definicjaBoolean()

Zadeklaruj parametr logiczny.

Podpis:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

Parametry

Parametr Typ Opis
nazwa strunowy Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru.
opcje Opcje parametrów <wartość logiczna> Opcje konfiguracji dla parametru.

Zwroty:

Wartość logiczna

Param z zwracanym typem boolean dla .value .

parametry.definicjaInt()

Zadeklaruj parametr będący liczbą całkowitą.

Podpis:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Parametry

Parametr Typ Opis
nazwa strunowy Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru.
opcje Opcje parametrów <numer> Opcje konfiguracji dla parametru.

Zwroty:

Parametr wewnętrzny

Param z typem zwracanym number dla .value .

parametry.definicjaLista()

Zadeklaruj parametr listy.

Podpis:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Parametry

Parametr Typ Opis
nazwa strunowy Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru.
opcje Opcje parametrów <ciąg[]> Opcje konfiguracji dla parametru.

Zwroty:

ListaParam

Param z typem zwracanym string[] dla .value .

parametry.definicjaSecret()

Deklaruje tajny parametr, który będzie utrwalał wartości tylko w Cloud Secret Manager. Sekrety są przechowywane wewnętrznie jako ciągi bajtowe. Użyj opcji ParamOptions. as zapewnić wskazówkę dotyczącą typu podczas rozpoznawania parametrów.

Podpis:

export declare function defineSecret(name: string): SecretParam;

Parametry

Parametr Typ Opis
nazwa strunowy Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru.

Zwroty:

SekretnyParam

Param z zwracanym typem string dla .value .

parametry.definicjaString()

Zadeklaruj parametr ciągu.

Podpis:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

Parametry

Parametr Typ Opis
nazwa strunowy Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru.
opcje Opcje parametrów <ciąg> Opcje konfiguracji dla parametru.

Zwroty:

Parametr ciągu

Param z zwracanym typem string dla .value .

params.databaseURL

Wbudowany parametr, który zwraca domyślny adres URL bazy danych RTDB powiązany z projektem, bez monitowania osoby wdrażającej. Pusty ciąg znaków, jeśli żaden nie istnieje.

Podpis:

databaseURL: Param<string>

params.deklarowaneParams

Podpis:

declaredParams: SecretOrExpr[]

params.gcloudProject

Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu Cloud bez monitowania osoby wdrażającej.

Podpis:

gcloudProject: Param<string>

parametry.projectID

Wbudowany parametr, który przekształca się w identyfikator projektu Cloud powiązany z projektem, bez monitowania wdrażającego.

Podpis:

projectID: Param<string>

params.storageBucket

Wbudowany parametr, który przekłada się na zasobnik w chmurze powiązany z funkcją, bez monitowania wdrażającego. Pusty ciąg znaków, jeśli nie został zdefiniowany.

Podpis:

storageBucket: Param<string>

params.ParamOpcje

Opcje konfiguracyjne, których można użyć do dostosowania zachowania monitującego parametru.

Podpis:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;