https namespace

Les fonctions

Fonction Description
onCall (opts, gestionnaire) Déclare une méthode appelable que les clients peuvent appeler à l'aide d'un SDK Firebase.
onCall (gestionnaire) Déclare une méthode appelable que les clients peuvent appeler à l'aide d'un SDK Firebase.
onRequest (opts, gestionnaire) Gère les requêtes HTTPS.
onRequest (gestionnaire) Gère les requêtes HTTPS.

Des classes

Classe Description
HttpsErreur Erreur explicite qui peut être générée par un gestionnaire pour envoyer une erreur au client qui a appelé la fonction.

Interfaces

Interface Description
Fonction appelable Crée une méthode appelable que les clients peuvent appeler à l'aide d'un SDK Firebase.
Optionsappelables Options pouvant être définies sur une fonction HTTPS appelable.
CallableRequest La requête utilisée pour appeler une fonction appelable.
OptionsHttps Options pouvant être définies sur une fonction HTTPS onRequest.
Demande Une demande expresse avec la représentation au format filaire du corps de la demande.

Tapez les alias

Tapez l'alias Description
FonctionsErrorCode L'ensemble des codes d'état des fonctions Firebase. Les codes sont les mêmes que ceux exposés par gRPC .
Fonction HTTPS Gère les requêtes HTTPS.

https.onCall()

Déclare une méthode appelable que les clients peuvent appeler à l'aide d'un SDK Firebase.

Signature:

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

Paramètres

Paramètre Taper Description
opte Optionsappelables Options à paramétrer sur cette fonction.
gestionnaire (demande : CallableRequest <T>) => Retour Une fonction qui prend un https.CallableRequest .

Retour:

CallableFunction<T, Retour>

Une fonction que vous pouvez exporter et déployer.

https.onCall()

Déclare une méthode appelable que les clients peuvent appeler à l'aide d'un SDK Firebase.

Signature:

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

Paramètres

Paramètre Taper Description
gestionnaire (demande : CallableRequest <T>) => Retour Une fonction qui prend un https.CallableRequest .

Retour:

CallableFunction<T, Retour>

Une fonction que vous pouvez exporter et déployer.

https.onRequest()

Gère les requêtes HTTPS.

Signature:

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

Paramètres

Paramètre Taper Description
opte OptionsHttps Options à paramétrer sur cette fonction
gestionnaire (demande : demande , réponse : express.Response) => void | Promesse<vide> Une fonction qui prend un objet https.Request et réponse, même signature qu'une application Express.

Retour:

Fonction HTTPS

Une fonction que vous pouvez exporter et déployer.

https.onRequest()

Gère les requêtes HTTPS.

Signature:

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

Paramètres

Paramètre Taper Description
gestionnaire (demande : demande , réponse : express.Response) => void | Promesse<vide> Une fonction qui prend un objet https.Request et réponse, même signature qu'une application Express.

Retour:

Fonction HTTPS

Une fonction que vous pouvez exporter et déployer.

https.FunctionsErrorCode

L'ensemble des codes d'état des fonctions Firebase. Les codes sont les mêmes que ceux exposés par gRPC .

Valeurs possibles:

  • cancelled : L'opération a été annulée (généralement par l'appelant).

  • unknown : Erreur inconnue ou erreur provenant d'un domaine d'erreur différent.

  • invalid-argument : Le client a spécifié un argument non valide. Notez que cela diffère de failed-precondition . invalid-argument indique les arguments qui posent problème quel que soit l'état du système (par exemple un nom de champ invalide).

  • deadline-exceeded : Délai expiré avant la fin de l'opération. Pour les opérations qui modifient l'état du système, cette erreur peut être renvoyée même si l'opération s'est terminée avec succès. Par exemple, une réponse réussie d'un serveur aurait pu être retardée suffisamment longtemps pour que le délai expire.

  • not-found : Certains documents demandés n'ont pas été trouvés.

  • already-exists : Un document que nous avons tenté de créer existe déjà.

  • permission-denied : L'appelant n'est pas autorisé à exécuter l'opération spécifiée.

  • resource-exhausted : Une ressource a été épuisée, peut-être un quota par utilisateur, ou peut-être que l'ensemble du système de fichiers manque d'espace.

  • failed-precondition : L'opération a été rejetée car le système n'est pas dans un état requis pour l'exécution de l'opération.

  • aborted : L'opération a été interrompue, généralement en raison d'un problème de concurrence tel qu'un abandon de transaction, etc.

  • out-of-range : Une opération a été tentée au-delà de la plage valide.

  • unimplemented : L'opération n'est pas implémentée ou n'est pas prise en charge/activée.

  • internal : Erreurs internes. Cela signifie que certains invariants attendus par le système sous-jacent ont été brisés. Si vous voyez l’une de ces erreurs, quelque chose est vraiment cassé.

  • unavailable : Le service est actuellement indisponible. Il s'agit très probablement d'une condition transitoire qui peut être corrigée en réessayant avec une interruption.

  • data-loss : Perte ou corruption de données irrécupérables.

  • unauthenticated : la demande ne dispose pas d'informations d'authentification valides pour l'opération.

Signature:

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.HttpsFonction

Gère les requêtes HTTPS.

Signature:

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