https namespace

Funzioni

Funzione Descrizione
onCall(opzioni, gestore) Dichiara un metodo richiamabile che i client possono chiamare utilizzando un SDK Firebase.
onCall(gestore) Dichiara un metodo richiamabile che i client possono chiamare utilizzando un SDK Firebase.
onRequest(opzioni, gestore) Gestisce le richieste HTTPS.
onRequest(gestore) Gestisce le richieste HTTPS.

Classi

Classe Descrizione
HTTPSError Un errore esplicito che può essere generato da un gestore per inviare un errore al client che ha chiamato la funzione.

Interfacce

Interfaccia Descrizione
Funzione richiamabile Crea un metodo richiamabile che i client possono chiamare utilizzando un SDK Firebase.
CallableOptions Opzioni che possono essere impostate su una funzione HTTPS richiamabile.
Richiesta richiamabile La richiesta utilizzata per chiamare una funzione richiamabile.
Opzioni HTTPS Opzioni che possono essere impostate su una funzione HTTPS onRequest.
Richiesta Una richiesta espressa con la rappresentazione in formato wire del corpo della richiesta.

Digitare Alias

Digita Alias Descrizione
FunzioniErrorCode L'insieme di codici di stato delle funzioni Firebase. I codici sono gli stessi esposti da gRPC .
Funzione Https Gestisce le richieste HTTPS.

https.onCall()

Dichiara un metodo richiamabile che i client possono chiamare utilizzando un SDK Firebase.

Firma:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parametri

Parametro Tipo Descrizione
opta CallableOptions Opzioni da impostare su questa funzione.
gestore (richiesta: CallableRequest <T>) => Ritorno Una funzione che accetta un https.CallableRequest .

Ritorna:

CallableFunction<T, Return>

Una funzione che puoi esportare e distribuire.

https.onCall()

Dichiara un metodo richiamabile che i client possono chiamare utilizzando un SDK Firebase.

Firma:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parametri

Parametro Tipo Descrizione
gestore (richiesta: CallableRequest <T>) => Ritorno Una funzione che accetta un https.CallableRequest .

Ritorna:

CallableFunction<T, Return>

Una funzione che puoi esportare e distribuire.

https.onRequest()

Gestisce le richieste HTTPS.

Firma:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parametri

Parametro Tipo Descrizione
opta Opzioni HTTPS Opzioni da impostare su questa funzione
gestore (richiesta: richiesta , risposta: express.Response) => void | Promesso<vuoto> Una funzione che accetta un oggetto https.Request e risposta, la stessa firma di un'app Express.

Ritorna:

Funzione Https

Una funzione che puoi esportare e distribuire.

https.onRequest()

Gestisce le richieste HTTPS.

Firma:

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parametri

Parametro Tipo Descrizione
gestore (richiesta: richiesta , risposta: express.Response) => void | Promesso<vuoto> Una funzione che accetta un oggetto https.Request e risposta, la stessa firma di un'app Express.

Ritorna:

Funzione Https

Una funzione che puoi esportare e distribuire.

https.FunctionsErrorCode

L'insieme di codici di stato delle funzioni Firebase. I codici sono gli stessi esposti da gRPC .

Valori possibili:

  • cancelled : L'operazione è stata annullata (normalmente dal chiamante).

  • unknown : errore sconosciuto o errore da un dominio di errore diverso.

  • invalid-argument : Il client ha specificato un argomento non valido. Tieni presente che questo differisce dalla failed-precondition . invalid-argument 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.

  • not-found : Alcuni documenti richiesti non sono stati trovati.

  • already-exists : alcuni documenti che abbiamo tentato di creare esistono già.

  • permission-denied : il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata.

  • resource-exhausted : alcune risorse sono state esaurite, forse una quota per utente o forse l'intero file system è esaurito.

  • failed-precondition : L'operazione è stata rifiutata perché il sistema non è in uno 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.

  • unimplemented : L'operazione non è implementata o non è supportata/abilitata.

  • internal : Errori interni. Significa che alcune invarianti previste dal sistema sottostante sono state interrotte. Se vedi uno di questi errori, qualcosa è molto rotto.

  • unavailable : Il servizio non è al momento disponibile. Si tratta molto probabilmente di una condizione transitoria e può essere corretta riprovando con un backoff.

  • data-loss : perdita o danneggiamento irrecuperabile dei dati.

  • unauthenticated : la richiesta non dispone di credenziali di autenticazione valide per l'operazione.

Firma:

export type FunctionsErrorCode = "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";

https.HttpsFunction

Gestisce le richieste HTTPS.

Firma:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};