firebase-functions package

L'API di seconda generazione per Cloud Functions per Firebase. Questo SDK supporta le importazioni profonde. Ad esempio, lo spazio dei nomi pubsub è disponibile su firebase-functions/v2 o è direttamente importabile da firebase-functions/v2/pubsub .

Funzioni

Funzione Descrizione
setGlobalOptions(opzioni) Imposta le opzioni predefinite per tutte le funzioni scritte utilizzando l'SDK di seconda generazione.

Classi

Classe Descrizione
Modifica L'interfaccia Cloud Functions per gli eventi che cambiano stato, come gli eventi onWrite e onUpdate di Realtime Database o Cloud Firestore. Per ulteriori informazioni sul formato utilizzato per costruire oggetti Change , vedere di seguito.

Interfacce

Interfaccia Descrizione
CloudEvent (BETA) Un CloudEventBase è la base di un formato multipiattaforma per la codifica di un evento serverless. Per ulteriori informazioni, vedere https://github.com/cloudevents/spec.
Funzione Cloud (BETA) Un gestore per CloudEvents.
EventHandlerOptions Campi aggiuntivi che possono essere impostati su qualsiasi funzione di gestione degli eventi.
Opzioni globali GlobalOptions sono opzioni che possono essere impostate su un intero progetto. Queste opzioni sono comuni a HTTPS e alle funzioni di gestione degli eventi.

Spazi dei nomi

Spazio dei nomi Descrizione
avvisi
Banca dati
eventorc
fuoco
https
identità
registratore
parametri
pubsub
remoteConfig
pianificatore
magazzinaggio
compiti
testLab

Digitare Alias

Digita Alias Descrizione
IngressSetting Elenco delle opzioni disponibili per IngressSettings .
Opzione memoria Elenco delle opzioni di memoria disponibili supportate da Cloud Functions.
ParamsOf Un tipo che mappa tutti i gruppi di acquisizione dei parametri nelle chiavi di un record. Ad esempio, ParamsOf < "utenti/ { fluido } " > è { uid: string } ParamsOf < "utenti/ { fluido } /log/ { tronco d'albero } " > è {uid: stringa; log: stringa } ParamsOf < "alcuni/statici/dati" > è { } Per motivi di flessibilità, ParamsOf è Registra < corda, corda >
Regione supportata Elenco di tutte le regioni supportate da Cloud Functions (2a generazione).
VpcEgressSetting Elenco delle opzioni disponibili per VpcConnectorEgressSettings .

setGlobalOptions()

Imposta le opzioni predefinite per tutte le funzioni scritte utilizzando l'SDK di seconda generazione.

Firma:

export declare function setGlobalOptions(options: GlobalOptions): void;

Parametri

Parametro Tipo Descrizione
opzioni Opzioni globali Opzioni da impostare come predefinite

Ritorna:

vuoto

IngressSetting

Elenco delle opzioni disponibili per IngressSettings .

Firma:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

Opzione memoria

Elenco delle opzioni di memoria disponibili supportate da Cloud Functions.

Firma:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ParamsOf

Un tipo che mappa tutti i gruppi di acquisizione dei parametri nelle chiavi di un record. Ad esempio, ParamsOf < "utenti/ { fluido } " > è { uid: string } ParamsOf < "utenti/ { fluido } /log/ { tronco d'albero } " > è {uid: stringa; log: stringa } ParamsOf < "alcuni/statici/dati" > è { }

Per motivi di flessibilità, ParamsOf è Registra < corda, corda >

Firma:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

Regione supportata

Elenco di tutte le regioni supportate da Cloud Functions (2a generazione).

Firma:

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

Elenco delle opzioni disponibili per VpcConnectorEgressSettings .

Firma:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";