L'API de 2e génération pour Cloud Functions pour Firebase. Ce SDK prend en charge les importations approfondies. Par exemple, l'espace de noms pubsub est disponible sur firebase-functions/v2 ou est directement importable depuis firebase-functions/v2/pubsub .
Les fonctions
| Fonction | Description |
|---|---|
| setGlobalOptions(options) | Définit les options par défaut pour toutes les fonctions écrites à l'aide du SDK de 2e génération. |
Des classes
| Classe | Description |
|---|---|
| Changement | L'interface Cloud Functions pour les événements qui changent d'état, tels que les événements Realtime Database ou Cloud Firestore onWrite et onUpdate . Pour plus d'informations sur le format utilisé pour construire des objets Change , voir ci-dessous. |
Interfaces
| Interface | Description |
|---|---|
| Événement Cloud | (BETA) Un CloudEventBase est la base d'un format multiplateforme pour l'encodage d'un événement sans serveur. Pour plus d'informations, consultez https://github.com/cloudevents/spec. |
| Fonction Cloud | (BETA) Un gestionnaire pour CloudEvents. |
| Options du gestionnaire d'événements | Champs supplémentaires pouvant être définis sur n’importe quelle fonction de gestion d’événements. |
| Options globales | GlobalOptions sont des options qui peuvent être définies sur l'ensemble d'un projet. Ces options sont communes aux fonctions HTTPS et de gestion d’événements. |
Espaces de noms
Tapez les alias
| Tapez l'alias | Description |
|---|---|
| Paramètres d'entrée | Liste des options disponibles pour IngressSettings . |
| Option mémoire | Liste des options de mémoire disponibles prises en charge par Cloud Functions. |
| ParamètresDe | Un type qui mappe tous les groupes de capture de paramètres dans les clés d'un enregistrement. Par exemple, ParamsOf < "utilisateurs/ { uide } " > est { uid : chaîne } ParamsOf < "utilisateurs/ { uide } /journaux/ { enregistrer } " > est {uid : chaîne ; journal : chaîne } ParamsOf < "certains/statiques/données" > est { } Pour des raisons de flexibilité, ParamsOf |
| Région prise en charge | Liste de toutes les régions prises en charge par Cloud Functions (2e génération). |
| VpcEgressSetting | Liste des options disponibles pour VpcConnectorEgressSettings . |
setGlobalOptions()
Définit les options par défaut pour toutes les fonctions écrites à l'aide du SDK de 2e génération.
Signature:
export declare function setGlobalOptions(options: GlobalOptions): void;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| choix | Options globales | Options à définir par défaut |
Retour:
vide
Paramètres d'entrée
Liste des options disponibles pour IngressSettings .
Signature:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
Option mémoire
Liste des options de mémoire disponibles prises en charge par Cloud Functions.
Signature:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamètresDe
Un type qui mappe tous les groupes de capture de paramètres dans les clés d'un enregistrement. Par exemple, ParamsOf < "utilisateurs/ { uide } " > est { uid : chaîne } ParamsOf < "utilisateurs/ { uide } /journaux/ { enregistrer } " > est {uid : chaîne ; journal : chaîne } ParamsOf < "certains/statiques/données" > est { }
Pour des raisons de flexibilité, ParamsOf
Signature:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
Région prise en charge
Liste de toutes les régions prises en charge par Cloud Functions (2e génération).
Signature:
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 des options disponibles pour VpcConnectorEgressSettings .
Signature:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";