Interfejs API 2 generacji dla Cloud Functions dla Firebase. Ten pakiet SDK obsługuje precyzyjne importowanie. Na przykład przestrzeń nazw pubsub jest dostępna pod adresem firebase-functions/v2 lub można ją zaimportować bezpośrednio z firebase-functions/v2/pubsub.
Funkcje
| Funkcja | Opis |
|---|---|
| setGlobalOptions(options). | Ustawia opcje domyślne dla wszystkich funkcji napisanych za pomocą pakietu SDK 2 generacji. |
Zajęcia
| Klasa | Opis |
|---|---|
| Zmień | Interfejs Cloud Functions dla zdarzeń, które zmieniają stan, takich jak Baza danych czasu rzeczywistego lub Cloud Firestore onWrite i onUpdate.Więcej informacji o formacie używanym do tworzenia obiektów Change znajdziesz poniżej. |
Interfejsy
| Interfejs | Opis |
|---|---|
| CloudEvent | (BETA) CloudEventBase to podstawa wieloplatformowego formatu kodowania zdarzeń bezserwerowych. Więcej informacji znajdziesz na stronie https://github.com/cloudevents/spec. |
| Funkcja w Cloud Functions | (BETA) Moduł obsługi CloudEvents. |
| EventHandlerOptions | Dodatkowe pola, które można ustawić w przypadku dowolnej funkcji obsługi zdarzeń. |
| GlobalOptions (Opcje globalne). | GlobalOptions to opcje, które można ustawić w całym projekcie. Te opcje są typowe dla protokołu HTTPS i funkcji obsługi zdarzeń. |
Przestrzenie nazw
| Przestrzeń nazw | Opis |
|---|---|
| alerty | |
| baza danych | |
| eventarc | |
| firestore | |
| https | |
| tożsamość | |
| rejestrator | |
| parametry | |
| pubsub | |
| remoteConfig | |
| harmonogram | |
| miejsce na dane | |
| zadania | |
| testLab |
Aliasy typu
| Wpisz alias | Opis |
|---|---|
| Ustawienia ruchu przychodzącego | Lista opcji dostępnych w przypadku usługi IngressSettings. |
| MemoryOption | Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions. |
| Parametry | Typ, który mapuje wszystkie grupy przechwytywania parametrów na klucze rekordu. Na przykład ParamsOf<"users/{uid}"> to { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"jakiś/statyczny/dane"> to {}Ze względu na elastyczność parametr ParamsOf |
| ObsługiwanyRegion | Lista wszystkich regionów obsługiwanych przez Cloud Functions (2 generacji). |
| Ustawienia VpcEgressSettings | Lista opcji dostępnych w przypadku usługi VpcConnectorEgressSettings. |
setGlobalOptions()
Ustawia opcje domyślne dla wszystkich funkcji napisanych za pomocą pakietu SDK 2 generacji.
Podpis:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | GlobalOptions (Opcje globalne). | Opcje ustawione jako domyślne |
Zwroty:
nieważne
Ustawienie ruchu przychodzącego
Lista opcji dostępnych dla: IngressSettings.
Podpis:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
MemoryOption
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 wszystkie grupy przechwytywania parametrów na klucze rekordu. Na przykład ParamsOf<"users/{uid}"> to { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"jakiś/statyczny/dane"> to {}
Ze względu na elastyczność parametr ParamsOf
Podpis:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
ObsługiwanyRegion
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 opcji dostępnych dla: VpcConnectorEgressSettings.
Podpis:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";