firebase-functions package

Les fonctions

Fonction Description
configuration() Stockez et récupérez les données de configuration du projet telles que les clés API tierces ou d'autres paramètres. Vous pouvez définir des valeurs de configuration à l'aide de la CLI Firebase comme décrit dans [Configuration de l'environnement](/docs/functions/config-env).
optionsVersPointFin(options)
optionsVersDéclencheur(options)
région(s) régions Configurez les régions dans lesquelles la fonction est déployée.
exécuterAvec(options d'exécution) Configurez les options d'exécution pour la fonction.

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.
Générateur de fonctions

Interfaces

Interface Description
Fonction de blocage Le type de fonction pour les déclencheurs de blocage d’authentification.
Fonction Cloud Le type de fonction pour tous les déclencheurs non HTTPS. Celui-ci doit être exporté depuis votre fichier JavaScript pour définir une fonction Cloud. Ce type est une fonction JavaScript spéciale qui prend un objet Event basé sur un modèle comme seul argument.
Options de déploiement Options de configuration pour une fonction qui s'applique lors du déploiement de la fonction.
Événement Format filaire pour un événement.
Contexte d'événement Le contexte dans lequel un événement s'est produit.
Politique d'échec Option de configuration pour la politique de défaillance sur les fonctions en arrière-plan.
Fonction HTTPS Le type de fonction pour les déclencheurs HTTPS. Celui-ci doit être exporté depuis votre fichier JavaScript pour définir une fonction Cloud.
Ressource Resource est un format standard pour définir une ressource (google.rpc.context.AttributeContext.Resource). Dans Cloud Functions, c'est la ressource qui a déclenché la fonction, comme un bucket de stockage.
Exécutable Un Runnable possède une méthode run qui appelle directement la fonction définie par l'utilisateur - utile pour les tests unitaires.
Options d'exécution Options de configuration pour une fonction applicable au moment de l'exécution.
Calendrier Options de configuration pour les fonctions planifiées.
ScheduleRetryConfig Options de nouvelle tentative du planificateur. S'applique uniquement aux fonctions planifiées.

Espaces de noms

Espace de noms Description
analytique
authentification
base de données
magasin de feu
https
enregistreur
paramètres
pubsub
configuration à distance
stockage
Tâches
laboratoire de test

Variables

Variable Description
application
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS Liste des options disponibles pour IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Valeur du délai d'expiration maximal de Cloud Functions.
MIN_TIMEOUT_SECONDS Valeur minimale du délai d'expiration de Cloud Functions.
RESET_VALUE Valeur de configuration spéciale pour réinitialiser la configuration aux paramètres par défaut de la plateforme.
SUPPORTED_REGIONS Liste de toutes les régions prises en charge par Cloud Functions.
VALID_MEMORY_OPTIONS Liste des options de mémoire disponibles prises en charge par Cloud Functions.
VPC_EGRESS_SETTINGS_OPTIONS Liste des options disponibles pour VpcConnectorEgressSettings.

configuration()

Stockez et récupérez les données de configuration du projet telles que les clés API tierces ou d'autres paramètres. Vous pouvez définir des valeurs de configuration à l'aide de la CLI Firebase comme décrit dans [Configuration de l'environnement](/docs/functions/config-env).

Signature:

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

Retour:

Enregistrer<string, any>

optionsVersPointEnd()

Signature:

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

Paramètres

Paramètre Taper Description
choix Options de déploiement

Retour:

Point de terminaison du manifeste

optionsVersDéclencheur()

Signature:

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

Paramètres

Paramètre Taper Description
choix Options de déploiement

Retour:

n'importe lequel

région()

Configurez les régions dans lesquelles la fonction est déployée.

Signature:

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

Paramètres

Paramètre Taper Description
Régions Tableau<(type de SUPPORTED_REGIONS )[numéro] | chaîne | Expression <chaîne> | Réinitialiser la valeur> Une ou plusieurs chaînes de région.

Retour:

Générateur de fonctions

Exemple 1

fonctions.region('us-east1')

Exemple 2

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

courir avec()

Configurez les options d'exécution pour la fonction.

Signature:

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

Paramètres

Paramètre Taper Description
Options d'exécution Options d'exécution Objet avec champs optionnels : 1. memory : quantité de mémoire à allouer à la fonction, les valeurs possibles sont : '128Mo', '256Mo', '512Mo', '1Go', '2Go', '4Go' et '8Go' . 2. timeoutSeconds : timeout de la fonction en secondes, les valeurs possibles sont 0 à 540. 3. failurePolicy : politique d'échec de la fonction, le booléen true étant équivalent à fournir un objet de nouvelle tentative vide. 4. vpcConnector : identifiant d'un connecteur VPC dans le même projet et la même région. 5. vpcConnectorEgressSettings : lorsqu'un vpcConnector est défini, contrôlez le trafic de sortie envoyé via le vpcConnector. 6. serviceAccount : Compte de service spécifique à la fonction. 7. ingressSettings : paramètres d'entrée pour la fonction, qui contrôlent d'où une fonction HTTPS peut être appelée. La valeur ne doit pas être nulle.

Retour:

Générateur de fonctions

application

Signature:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Signature:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

Liste des options disponibles pour IngressSettings.

Signature:

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

MAX_NUMBER_USER_LABELS

Signature:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Valeur du délai d'expiration maximal de Cloud Functions.

Signature:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Valeur minimale du délai d'expiration de Cloud Functions.

Signature:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Valeur de configuration spéciale pour réinitialiser la configuration aux paramètres par défaut de la plateforme.

Signature:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

Liste de toutes les régions prises en charge par Cloud Functions.

Signature:

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 des options de mémoire disponibles prises en charge par Cloud Functions.

Signature:

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

VPC_EGRESS_SETTINGS_OPTIONS

Liste des options disponibles pour VpcConnectorEgressSettings.

Signature:

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