functions package

Funzioni cloud per Firebase

Funzioni

Funzione Descrizione
funzione(app, ...)
getFunctions(app, regioneOrCustomDomain) Restituisce un'istanza di Funzioni per l'app specificata.
funzione(funzioniIstanza, ...)
connectFunctionsEmulator(functionsInstance, host, port) Modifica questa istanza per comunicare con l'emulatore Cloud Functions. Nota: questo deve essere chiamato prima che questa istanza venga utilizzata per eseguire qualsiasi operazione.
httpsCallable(functionsInstance, nome, opzioni) Restituisce un riferimento al trigger HTTPS richiamabile con il nome specificato.
httpsCallableFromURL(functionsInstance, url, opzioni) Restituisce un riferimento al trigger HTTPS richiamabile con l'URL specificato.

Interfacce

Interfaccia Descrizione
Funzioni Un'istanza Functions .
FunzioniErrore Un errore restituito dall'SDK del client Firebase Functions.
HttpsCallableOptions Un'interfaccia per i metadati su come dovrebbero essere eseguite le chiamate.
HttpsCallableResult Un HttpsCallableResult racchiude un singolo risultato da una chiamata di funzione.

Digitare Alias

Digita Alias Descrizione
FunzioniErrorCode L'insieme di codici di stato delle funzioni Firebase. I codici sono gli stessi esposti da gRPC qui: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Valori possibili: - 'cancelled': l'operazione è stata annullata (tipicamente dal chiamante). - 'sconosciuto': errore sconosciuto o errore proveniente da un dominio di errore diverso. - 'argomento-invalido': il client ha specificato un argomento non valido. Si noti che questo differisce dalla "precondizione fallita". 'argomento-invalido' indica argomenti che sono problematici indipendentemente dallo stato del sistema (ad esempio un nome di campo non valido). - 'deadline-exceeded': la scadenza è scaduta prima che l'operazione potesse essere completata. Per le operazioni che modificano lo stato del sistema, questo errore potrebbe essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta riuscita da un server potrebbe essere stata ritardata abbastanza a lungo da far scadere la scadenza. - 'non trovato': alcuni documenti richiesti non sono stati trovati. - 'già-esiste': alcuni documenti che abbiamo tentato di creare esistono già. - 'permission-denied': il chiamante non ha il permesso di eseguire l'operazione specificata. - 'resource-exhausted': alcune risorse sono state esaurite, forse una quota per utente o forse l'intero file system ha esaurito lo spazio. - 'failed-precondition': l'operazione è stata rifiutata perché il sistema non si trova nello stato richiesto per l'esecuzione dell'operazione. - 'aborted': l'operazione è stata interrotta, in genere a causa di un problema di concorrenza come l'interruzione delle transazioni, ecc. - 'out-of-range': l'operazione è stata tentata oltre l'intervallo valido. - 'non implementato': l'operazione non è implementata o non è supportata/abilitata. - 'interno': errori interni. Significa che alcune invarianti previste dal sistema sottostante sono state interrotte. Se vedi uno di questi errori, qualcosa è molto rotto. - 'non disponibile': il servizio non è attualmente disponibile. Si tratta molto probabilmente di una condizione transitoria e può essere corretta riprovando con un backoff. - "perdita di dati": perdita o danneggiamento irrecuperabile dei dati. - 'unauthenticated': la richiesta non dispone di credenziali di autenticazione valide per l'operazione.
FunzioniErrorCodeCore Stringa del codice di errore delle funzioni aggiunta dopo il prefisso del prodotto "funzioni/". Vedi FunctionsErrorCode per la documentazione completa dei codici.
HttpsCallable Un riferimento a un trigger HTTP "richiamabile" in Google Cloud Functions.

funzione(app, ...)

getFunctions(app, regioneOrCustomDomain)

Restituisce un'istanza di Funzioni per l'app specificata.

Firma:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Parametri

Parametro Tipo Descrizione
app FirebaseApp La FirebaseApp da utilizzare.
regioneOrCustomDomain corda uno tra: a) La regione in cui si trovano le funzioni richiamabili (es: us-central1) b) Un dominio personalizzato che ospita le funzioni richiamabili (es: https://mydomain.com)

Ritorna:

Funzioni

funzione(funzioniIstanza, ...)

connectFunctionsEmulator(functionsInstance, host, port)

Modifica questa istanza per comunicare con l'emulatore Cloud Functions.

Firma:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Parametri

Parametro Tipo Descrizione
funzioniIstanza Funzioni
ospite corda L'host dell'emulatore (es: localhost)
porta numero La porta dell'emulatore (es: 5001)

Ritorna:

vuoto

httpsCallable(functionsInstance, nome, opzioni)

Restituisce un riferimento al trigger HTTPS richiamabile con il nome specificato.

Firma:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parametri

Parametro Tipo Descrizione
funzioniIstanza Funzioni
nome corda Il nome del trigger.
opzioni HttpsCallableOptions

Ritorna:

HttpsCallable <Dati richiesta, Dati risposta>

httpsCallableFromURL(functionsInstance, url, opzioni)

Restituisce un riferimento al trigger HTTPS richiamabile con l'URL specificato.

Firma:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Parametri

Parametro Tipo Descrizione
funzioniIstanza Funzioni
URL corda L'URL del trigger.
opzioni HttpsCallableOptions

Ritorna:

HttpsCallable <Dati richiesta, Dati risposta>

FunzioniErrorCode

L'insieme di codici di stato delle funzioni Firebase. I codici sono gli stessi esposti da gRPC qui: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valori possibili: - 'cancelled': l'operazione è stata annullata (tipicamente dal chiamante). - 'sconosciuto': errore sconosciuto o errore proveniente da un dominio di errore diverso. - 'argomento-invalido': il client ha specificato un argomento non valido. Si noti che questo differisce dalla "precondizione fallita". 'argomento-invalido' indica argomenti che sono problematici indipendentemente dallo stato del sistema (ad esempio un nome di campo non valido). - 'deadline-exceeded': la scadenza è scaduta prima che l'operazione potesse essere completata. Per le operazioni che modificano lo stato del sistema, questo errore potrebbe essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta riuscita da un server potrebbe essere stata ritardata abbastanza a lungo da far scadere la scadenza. - 'non trovato': alcuni documenti richiesti non sono stati trovati. - 'già-esiste': alcuni documenti che abbiamo tentato di creare esistono già. - 'permission-denied': il chiamante non ha il permesso di eseguire l'operazione specificata. - 'resource-exhausted': alcune risorse sono state esaurite, forse una quota per utente o forse l'intero file system ha esaurito lo spazio. - 'failed-precondition': l'operazione è stata rifiutata perché il sistema non si trova nello stato richiesto per l'esecuzione dell'operazione. - 'aborted': l'operazione è stata interrotta, in genere a causa di un problema di concorrenza come l'interruzione delle transazioni, ecc. - 'out-of-range': l'operazione è stata tentata oltre l'intervallo valido. - 'non implementato': l'operazione non è implementata o non è supportata/abilitata. - 'interno': errori interni. Significa che alcune invarianti previste dal sistema sottostante sono state interrotte. Se vedi uno di questi errori, qualcosa è molto rotto. - 'non disponibile': il servizio non è attualmente disponibile. Si tratta molto probabilmente di una condizione transitoria e può essere corretta riprovando con un backoff. - "perdita di dati": perdita o danneggiamento irrecuperabile dei dati. - 'non autenticato': la richiesta non dispone di credenziali di autenticazione valide per l'operazione.

Firma:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunzioniErrorCodeCore

Stringa del codice di errore delle funzioni aggiunta dopo il prefisso del prodotto "funzioni/". Vedi FunctionsErrorCode per la documentazione completa dei codici.

Firma:

export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

HttpsCallable

Un riferimento a un trigger HTTP "richiamabile" in Google Cloud Functions.

Firma:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;