firebase-functions package

Funktionen

Funktion Beschreibung
config() Speichern und rufen Sie Projektkonfigurationsdaten wie API-Schlüssel von Drittanbietern oder andere Einstellungen ab. Sie können Konfigurationswerte mithilfe der Firebase-CLI festlegen, wie unter [Umgebungskonfiguration](/docs/functions/config-env) beschrieben.
optionsToEndpoint(Optionen)
optionsToTrigger(Optionen)
Region(Regionen) Konfigurieren Sie die Regionen, in denen die Funktion bereitgestellt wird.
runWith(runtimeOptions) Konfigurieren Sie Laufzeitoptionen für die Funktion.

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.
FunctionBuilder

Schnittstellen

Schnittstelle Beschreibung
Blockierungsfunktion Der Funktionstyp für Authentifizierungsblockierungs-Trigger.
CloudFunction Der Funktionstyp für alle Nicht-HTTPS-Trigger. Dies sollte aus Ihrer JavaScript-Datei exportiert werden, um eine Cloud-Funktion zu definieren. Bei diesem Typ handelt es sich um eine spezielle JavaScript-Funktion, die als einziges Argument ein vorlagenbasiertes Event Objekt verwendet.
Bereitstellungsoptionen Konfigurationsoptionen für eine Funktion, die während der Funktionsbereitstellung angewendet werden.
Ereignis Wire-Format für eine Veranstaltung.
EventContext Der Kontext, in dem ein Ereignis aufgetreten ist.
Fehlerrichtlinie Konfigurationsoption für Fehlerrichtlinie für Hintergrundfunktionen.
HttpsFunction Der Funktionstyp für HTTPS-Trigger. Dies sollte aus Ihrer JavaScript-Datei exportiert werden, um eine Cloud-Funktion zu definieren.
Ressource Ressource ist ein Standardformat zum Definieren einer Ressource (google.rpc.context.AttributeContext.Resource). In Cloud Functions ist es die Ressource, die die Funktion ausgelöst hat – beispielsweise ein Speicher-Bucket.
Lauffähig Ein Runnable verfügt über eine run , die die benutzerdefinierte Funktion direkt aufruft – nützlich für Unit-Tests.
Laufzeitoptionen Konfigurationsoptionen für eine Funktion, die zur Laufzeit anwendbar sind.
Zeitplan Konfigurationsmöglichkeiten für geplante Funktionen.
ScheduleRetryConfig Wiederholungsoptionen des Planers. Gilt nur für geplante Funktionen.

Namensräume

Namensraum Beschreibung
Analytik
Autor
Datenbank
Feuerladen
https
Logger
Parameter
pubsub
remoteConfig
Lagerung
Aufgaben
testLab

Variablen

Variable Beschreibung
App
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS Liste der verfügbaren Optionen für IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Maximaler Zeitüberschreitungswert für Cloud Functions.
MIN_TIMEOUT_SECONDS Mindestzeitüberschreitungswert für Cloud Functions.
RESET_VALUE Spezieller Konfigurationswert zum Zurücksetzen der Konfiguration auf die Plattformstandards.
UNTERSTÜTZTE_REGIONS Liste aller von Cloud Functions unterstützten Regionen.
VALID_MEMORY_OPTIONS Liste der verfügbaren Speicheroptionen, die von Cloud Functions unterstützt werden.
VPC_EGRESS_SETTINGS_OPTIONS Liste der verfügbaren Optionen für VpcConnectorEgressSettings.

config()

Speichern und rufen Sie Projektkonfigurationsdaten wie API-Schlüssel von Drittanbietern oder andere Einstellungen ab. Sie können Konfigurationswerte mithilfe der Firebase-CLI festlegen, wie unter [Umgebungskonfiguration](/docs/functions/config-env) beschrieben.

Unterschrift:

export declare function config(): Record<string, any>;

Kehrt zurück:

Record<string, any>

optionsToEndpoint()

Unterschrift:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

Parameter

Parameter Typ Beschreibung
Optionen Bereitstellungsoptionen

Kehrt zurück:

ManifestEndpoint

optionsToTrigger()

Unterschrift:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Parameter

Parameter Typ Beschreibung
Optionen Bereitstellungsoptionen

Kehrt zurück:

beliebig

Region()

Konfigurieren Sie die Regionen, in denen die Funktion bereitgestellt wird.

Unterschrift:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parameter

Parameter Typ Beschreibung
Regionen Array<(Typ von SUPPORTED_REGIONS )[Anzahl] | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen> Einer oder mehrere Regionsstrings.

Kehrt zurück:

FunctionBuilder

Beispiel 1

Funktionen.Region('us-east1')

Beispiel 2

Funktionen.region('us-east1', 'us-central1')

runWith()

Konfigurieren Sie Laufzeitoptionen für die Funktion.

Unterschrift:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parameter

Parameter Typ Beschreibung
Laufzeitoptionen Laufzeitoptionen Objekt mit optionalen Feldern: 1. memory : Speichermenge, die der Funktion zugewiesen werden soll. Mögliche Werte sind: „128 MB“, „256 MB“, „512 MB“, „1 GB“, „2 GB“, „4 GB“ und „8 GB“. . 2. timeoutSeconds : Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540. 3. failurePolicy : Fehlerrichtlinie der Funktion, wobei boolean true der Bereitstellung eines leeren Wiederholungsobjekts entspricht. 4. vpcConnector : ID eines VPC-Connectors im selben Projekt und in der gleichen Region. 5. vpcConnectorEgressSettings : Wenn ein vpcConnector festgelegt ist, steuern Sie, welcher ausgehende Datenverkehr über den vpcConnector gesendet wird. 6. serviceAccount : Spezifisches Dienstkonto für die Funktion. 7. ingressSettings : Eingangseinstellungen für die Funktion, die steuern, von wo aus eine HTTPS-Funktion aufgerufen werden kann. Der Wert darf nicht null sein.

Kehrt zurück:

FunctionBuilder

App

Unterschrift:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Unterschrift:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

Liste der verfügbaren Optionen für IngressSettings.

Unterschrift:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

Unterschrift:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Maximaler Zeitüberschreitungswert für Cloud Functions.

Unterschrift:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Mindestzeitüberschreitungswert für Cloud Functions.

Unterschrift:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Spezieller Konfigurationswert zum Zurücksetzen der Konfiguration auf die Plattformstandards.

Unterschrift:

RESET_VALUE: ResetValue

UNTERSTÜTZTE_REGIONS

Liste aller von Cloud Functions unterstützten Regionen.

Unterschrift:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

VALID_MEMORY_OPTIONS

Liste der verfügbaren Speicheroptionen, die von Cloud Functions unterstützt werden.

Unterschrift:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

Liste der verfügbaren Optionen für VpcConnectorEgressSettings.

Unterschrift:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]