Interfejs API drugiej generacji dla Cloud Functions dla Firebase. Ten zestaw SDK obsługuje głębokie importy. Na przykład przestrzeń nazw pubsub
jest dostępna pod firebase-functions/v2
lub można ją bezpośrednio zaimportować z firebase-functions/v2/pubsub
.
Funkcje
Funkcjonować | Opis |
---|---|
setGlobalOptions(opcje) | Ustawia domyślne opcje dla wszystkich funkcji napisanych przy użyciu zestawu SDK drugiej generacji. |
Zajęcia
Klasa | Opis |
---|---|
Zmiana | Interfejs Cloud Functions dla zdarzeń zmieniających stan, takich jak zdarzenia Realtime Database lub Cloud Firestore onWrite i onUpdate . Więcej informacji na temat formatu używanego do konstruowania obiektów Change można znaleźć poniżej. |
Interfejsy
Interfejs | Opis |
---|---|
Wydarzenie w chmurze | (BETA) CloudEventBase jest podstawą wieloplatformowego formatu do kodowania zdarzenia bezserwerowego. Więcej informacji można znaleźć na stronie https://github.com/cloudevents/spec. |
Funkcja chmury | (BETA) Procedura obsługi CloudEvents. |
Opcje obsługi zdarzeń | Dodatkowe pola, które można ustawić w dowolnej funkcji obsługi zdarzeń. |
Opcje globalne | GlobalOptions to opcje, które można ustawić w całym projekcie. Opcje te są wspólne dla funkcji HTTPS i obsługi zdarzeń. |
Przestrzenie nazw
Przestrzeń nazw | Opis |
---|---|
alerty | |
Baza danych | |
wydarzenierc | |
sklep z ogniem | |
https | |
tożsamość | |
rejestrator | |
parametry | |
pubsub | |
zdalna konfiguracja | |
planista | |
składowanie | |
zadania | |
laboratorium testowe |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
Ustawienie wejścia | Lista dostępnych opcji dla IngressSettings . |
Opcja pamięci | Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions. |
Parametry | Typ, który mapuje całą grupę przechwytywania parametrów na klucze rekordu. Na przykład ParamsOf < „użytkownicy/ { uid } " > to {uid: string} ParamsOf < „użytkownicy/ { uid } /logi/ { dziennik } " > jest {uid: string; log: ciąg } ParamsOf < „niektóre/statyczne/dane” > jest { } Ze względu na elastyczność ParamsOf |
Obsługiwany region | Lista wszystkich regionów obsługiwanych przez Cloud Functions (2. generacji). |
Ustawienie VpcEgress | Lista dostępnych opcji dla VpcConnectorEgressSettings . |
ustawOpcjeGlobalne()
Ustawia domyślne opcje dla wszystkich funkcji napisanych przy użyciu zestawu SDK drugiej generacji.
Podpis:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje globalne | Opcje do ustawienia jako domyślne |
Zwroty:
próżnia
Ustawienie wejścia
Lista dostępnych opcji IngressSettings
.
Podpis:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
Opcja pamięci
Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions.
Podpis:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
Parametry
Typ, który mapuje całą grupę przechwytywania parametrów na klucze rekordu. Na przykład ParamsOf < „użytkownicy/ { uid } " > to {uid: string} ParamsOf < „użytkownicy/ { uid } /logi/ { dziennik } " > jest {uid: string; log: ciąg } ParamsOf < „niektóre/statyczne/dane” > jest { }
Ze względu na elastyczność ParamsOf
Podpis:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
Obsługiwany region
Lista wszystkich regionów obsługiwanych przez Cloud Functions (2. generacji).
Podpis:
export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";
Ustawienie VpcEgress
Lista dostępnych opcji dla VpcConnectorEgressSettings
.
Podpis:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";