Die API der 2. Generation für Cloud Functions für Firebase. Dieses SDK unterstützt Deep-Importe. Der Namespace pubsub ist beispielsweise unter firebase-functions/v2 verfügbar oder kann direkt aus firebase-functions/v2/pubsub importiert werden .
Funktionen
| Funktion | Beschreibung |
|---|---|
| setGlobalOptions(Optionen) | Legt Standardoptionen für alle mit dem SDK der 2. Generation geschriebenen Funktionen fest. |
Klassen
| Klasse | Beschreibung |
|---|---|
| Ändern | Die Cloud Functions-Schnittstelle für Ereignisse, die ihren Status ändern, z. B. Echtzeitdatenbank- oder Cloud Firestore- onWrite und onUpdate Ereignisse. Weitere Informationen zum Format, das zum Erstellen Change Objekten verwendet wird, finden Sie unten. |
Schnittstellen
| Schnittstelle | Beschreibung |
|---|---|
| CloudEvent | (BETA) Eine CloudEventBase ist die Basis eines plattformübergreifenden Formats zum Kodieren eines serverlosen Ereignisses. Weitere Informationen finden Sie unter https://github.com/cloudevents/spec. |
| CloudFunction | (BETA) Ein Handler für CloudEvents. |
| EventHandlerOptions | Zusätzliche Felder, die für jede Ereignisverarbeitungsfunktion festgelegt werden können. |
| GlobalOptions | GlobalOptions sind Optionen, die für ein gesamtes Projekt festgelegt werden können. Diese Optionen gelten für HTTPS- und Ereignisverarbeitungsfunktionen. |
Namensräume
| Namensraum | Beschreibung |
|---|---|
| Warnungen | |
| Datenbank | |
| Eventarc | |
| Feuerladen | |
| https | |
| Identität | |
| Logger | |
| Parameter | |
| pubsub | |
| remoteConfig | |
| Planer | |
| Lagerung | |
| Aufgaben | |
| testLab |
Geben Sie Aliase ein
| Geben Sie Alias ein | Beschreibung |
|---|---|
| IngressSetting | Liste der verfügbaren Optionen für IngressSettings . |
| Speicheroption | Liste der verfügbaren Speicheroptionen, die von Cloud Functions unterstützt werden. |
| ParamsOf | Ein Typ, der alle Parametererfassungsgruppen den Schlüsseln eines Datensatzes zuordnet. Beispiel: ParamsOf < „Benutzer/ { uid } " > ist { uid: string } ParamsOf < „Benutzer/ { uid } /logs/ { Protokoll } " > ist { uid: string; log: string } ParamsOf < „einige/statische/Daten“ > ist { } Aus Flexibilitätsgründen ist ParamsOf |
| UnterstützteRegion | Liste aller von Cloud Functions (2. Generation) unterstützten Regionen. |
| VpcEgressSetting | Liste der verfügbaren Optionen für VpcConnectorEgressSettings . |
setGlobalOptions()
Legt Standardoptionen für alle mit dem SDK der 2. Generation geschriebenen Funktionen fest.
Unterschrift:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Optionen | GlobalOptions | Als Standard festzulegende Optionen |
Kehrt zurück:
Leere
IngressSetting
Liste der verfügbaren Optionen für IngressSettings .
Unterschrift:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
Speicheroption
Liste der verfügbaren Speicheroptionen, die von Cloud Functions unterstützt werden.
Unterschrift:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamsOf
Ein Typ, der alle Parametererfassungsgruppen den Schlüsseln eines Datensatzes zuordnet. Beispiel: ParamsOf < „Benutzer/ { uid } " > ist { uid: string } ParamsOf < „Benutzer/ { uid } /logs/ { Protokoll } " > ist { uid: string; log: string } ParamsOf < „einige/statische/Daten“ > ist { }
Aus Flexibilitätsgründen ist ParamsOf
Unterschrift:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
UnterstützteRegion
Liste aller von Cloud Functions (2. Generation) unterstützten Regionen.
Unterschrift:
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";
VpcEgressSetting
Liste der verfügbaren Optionen für VpcConnectorEgressSettings .
Unterschrift:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";