firebase-functions package

Funzioni

Funzione Descrizione
configurazione() Archivia e recupera i dati di configurazione del progetto come chiavi API di terze parti o altre impostazioni. È possibile impostare i valori di configurazione utilizzando la CLI Firebase come descritto in [Configurazione dell'ambiente](/docs/functions/config-env).
opzioniToEndpoint(opzioni)
opzioniToTrigger(opzioni)
regione (regioni) Configurare le regioni in cui viene distribuita la funzione.
eseguiCon(opzioniruntime) Configurare le opzioni di runtime per la funzione.

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.
Costruttore di funzioni

Interfacce

Interfaccia Descrizione
Funzione di blocco Il tipo di funzione per i trigger di Blocco autenticazione.
Funzione Cloud Il tipo di funzione per tutti i trigger non HTTPS. Questo dovrebbe essere esportato dal tuo file JavaScript per definire una funzione cloud. Questo tipo è una funzione JavaScript speciale che accetta un oggetto Event basato su modello come unico argomento.
Opzioni di distribuzione Opzioni di configurazione per una funzione che si applica durante la distribuzione della funzione.
Evento Formato wire per un evento.
Contesto eventi Il contesto in cui si è verificato un evento.
Politica di fallimento Opzione di configurazione per la policy di errore sulle funzioni in background.
Funzione Https Il tipo di funzione per i trigger HTTPS. Questo dovrebbe essere esportato dal tuo file JavaScript per definire una funzione cloud.
Risorsa Resource è un formato standard per la definizione di una risorsa (google.rpc.context.AttributeContext.Resource). In Cloud Functions è la risorsa che ha attivato la funzione, ad esempio un bucket di archiviazione.
Percorribile Un Runnable ha un metodo run che richiama direttamente la funzione definita dall'utente, utile per i test unitari.
Opzioni di runtime Opzioni di configurazione per una funzione applicabile in fase di esecuzione.
Programma Opzioni di configurazione per le funzioni pianificate.
ScheduleRetryConfig Opzioni di tentativi dello scheduler. Si applica solo alle funzioni pianificate.

Spazi dei nomi

Spazio dei nomi Descrizione
analitica
aut
Banca dati
fuoco
https
registratore
parametri
pubsub
remoteConfig
magazzinaggio
compiti
testLab

Variabili

Variabile Descrizione
app
DEFAULT_FAILURE_POLICY
INGRESSO_IMPOSTAZIONI_OPZIONI Elenco delle opzioni disponibili per IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Valore di timeout massimo di Cloud Functions.
MIN_TIMEOUT_SECONDS Valore di timeout minimo di Cloud Functions.
RESET_VALORE Valore di configurazione speciale per ripristinare la configurazione sui valori predefiniti della piattaforma.
SUPPORTED_REGIONS Elenco di tutte le regioni supportate da Cloud Functions.
VALID_MEMORIA_OPZIONI Elenco delle opzioni di memoria disponibili supportate da Cloud Functions.
VPC_EGRES_SETTINGS_OPTIONS Elenco delle opzioni disponibili per VpcConnectorEgressSettings.

configurazione()

Archivia e recupera i dati di configurazione del progetto come chiavi API di terze parti o altre impostazioni. È possibile impostare i valori di configurazione utilizzando la CLI Firebase come descritto in [Configurazione dell'ambiente](/docs/functions/config-env).

Firma:

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

Ritorna:

Registra<stringa, qualsiasi>

opzioniToEndpoint()

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni Opzioni di distribuzione

Ritorna:

Endpoint manifesto

opzioniToTrigger()

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni Opzioni di distribuzione

Ritorna:

Qualunque

regione()

Configurare le regioni in cui viene distribuita la funzione.

Firma:

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

Parametri

Parametro Tipo Descrizione
regioni Array<(tipo di SUPPORTED_REGIONS )[numero] | stringa | Espressione <stringa> | Reimpostavalore> Una o più stringhe regionali.

Ritorna:

Costruttore di funzioni

Esempio 1

funzioni.region('us-east1')

Esempio 2

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

Corri con()

Configurare le opzioni di runtime per la funzione.

Firma:

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

Parametri

Parametro Tipo Descrizione
runtimeOptions Opzioni di runtime Oggetto con campi facoltativi: 1. memory : quantità di memoria da allocare alla funzione, i valori possibili sono: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' e '8GB' . 2. timeoutSeconds : timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540. 3. failurePolicy : politica di errore della funzione, con booleano true equivalente a fornire un oggetto di tentativo vuoto. 4. vpcConnector : ID di un connettore VPC nello stesso progetto e regione. 5. vpcConnectorEgressSettings : quando viene impostato un vpcConnector, controlla quale traffico in uscita viene inviato tramite vpcConnector. 6. serviceAccount : account di servizio specifico per la funzione. 7. ingressSettings : impostazioni di ingresso per la funzione, che controllano da dove può essere chiamata una funzione HTTPS. Il valore non deve essere nullo.

Ritorna:

Costruttore di funzioni

app

Firma:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Firma:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESSO_IMPOSTAZIONI_OPZIONI

Elenco delle opzioni disponibili per IngressSettings.

Firma:

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

MAX_NUMBER_USER_LABELS

Firma:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Valore di timeout massimo di Cloud Functions.

Firma:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Valore di timeout minimo di Cloud Functions.

Firma:

MIN_TIMEOUT_SECONDS = 0

RESET_VALORE

Valore di configurazione speciale per ripristinare la configurazione sui valori predefiniti della piattaforma.

Firma:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

Elenco di tutte le regioni supportate da Cloud Functions.

Firma:

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_MEMORIA_OPZIONI

Elenco delle opzioni di memoria disponibili supportate da Cloud Functions.

Firma:

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

VPC_EGRES_SETTINGS_OPTIONS

Elenco delle opzioni disponibili per VpcConnectorEgressSettings.

Firma:

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