functions package

Fonctions cloud pour Firebase

Les fonctions

Fonction Description
fonction(application, ...)
getFunctions (application, région ou domaine personnalisé) Renvoie une instance Functions pour l’application donnée.
fonction(fonctionsInstance, ...)
connectFunctionsEmulator (fonctionsInstance, hôte, port) Modifiez cette instance pour communiquer avec l'émulateur Cloud Functions. Remarque : cela doit être appelé avant que cette instance ne soit utilisée pour effectuer des opérations.
httpsCallable (fonctionsInstance, nom, options) Renvoie une référence au déclencheur HTTPS appelable avec le nom donné.
httpsCallableFromURL (fonctionsInstance, URL, options) Renvoie une référence au déclencheur HTTPS appelable avec l'URL spécifiée.

Interfaces

Interface Description
Les fonctions Une instance Functions .
FonctionsErreur Une erreur renvoyée par le SDK client Firebase Functions.
HttpsCallableOptions Une interface pour les métadonnées sur la façon dont les appels doivent être exécutés.
HttpsCallableResult Un HttpsCallableResult encapsule un seul résultat d'un appel de fonction.

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 ici : https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Valeurs possibles : - 'annulé' : L'opération a été annulée (typiquement par l'appelant). - 'inconnu' : 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 « échec de précondition ». 'invalid-argument' indique les arguments qui posent problème quel que soit l'état du système (par exemple un nom de champ invalide). - « délai dépassé » : le délai a expiré avant que l'opération puisse se terminer. 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. - 'non trouvé' : Un document demandé n'a pas été trouvé. - « existe déjà » : un document que nous avons tenté de créer existe déjà. - 'autorisation refusée' : l'appelant n'a pas l'autorisation d'exécuter l'opération spécifiée. - « ressource épuisée » : 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é abandonnée, généralement en raison d'un problème de concurrence comme des abandons de transactions, etc. - « hors plage » : l'opération a été tentée au-delà de la plage valide. - 'non implémenté' : l'opération n'est pas implémentée ou n'est pas prise en charge/activée. - 'interne' : 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é. - 'indisponible' : 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. - « perte de données » : perte ou corruption irrécupérable de données. - « non authentifié » : la demande ne dispose pas d'informations d'authentification valides pour l'opération.
FonctionsErrorCodeCore Chaîne de code d'erreur de fonctions ajoutée après le préfixe de produit « fonctions/ ». Voir FunctionsErrorCode pour une documentation complète des codes.
HttpsAppelable Une référence à un déclencheur HTTP « appelable » dans Google Cloud Functions.

fonction(application, ...)

getFunctions (application, région ou domaine personnalisé)

Renvoie une instance Functions pour l’application donnée.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp La FirebaseApp à utiliser.
régionOuCustomDomain chaîne l'un des éléments suivants : a) La région dans laquelle se trouvent les fonctions appelables (ex : us-central1) b) Un domaine personnalisé hébergeant les fonctions appelables (ex : https://mydomain.com)

Retour:

Les fonctions

fonction(fonctionsInstance, ...)

connectFunctionsEmulator (fonctionsInstance, hôte, port)

Modifiez cette instance pour communiquer avec l'émulateur Cloud Functions.

Signature:

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

Paramètres

Paramètre Taper Description
fonctionsInstance Les fonctions
hôte chaîne L'hôte de l'émulateur (ex : localhost)
port nombre Le port de l'émulateur (ex : 5001)

Retour:

vide

httpsCallable (fonctionsInstance, nom, options)

Renvoie une référence au déclencheur HTTPS appelable avec le nom donné.

Signature:

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

Paramètres

Paramètre Taper Description
fonctionsInstance Les fonctions
nom chaîne Le nom du déclencheur.
choix HttpsCallableOptions

Retour:

HttpsAppelable <RequestData, ResponseData>

httpsCallableFromURL (fonctionsInstance, URL, options)

Renvoie une référence au déclencheur HTTPS appelable avec l'URL spécifiée.

Signature:

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

Paramètres

Paramètre Taper Description
fonctionsInstance Les fonctions
URL chaîne L'URL du déclencheur.
choix HttpsCallableOptions

Retour:

HttpsAppelable <RequestData, ResponseData>

FonctionsErrorCode

L'ensemble des codes d'état des fonctions Firebase. Les codes sont les mêmes que ceux exposés par gRPC ici : https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valeurs possibles : - 'annulé' : L'opération a été annulée (typiquement par l'appelant). - 'inconnu' : 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 « échec de précondition ». 'invalid-argument' indique les arguments qui posent problème quel que soit l'état du système (par exemple un nom de champ invalide). - « délai dépassé » : le délai a expiré avant que l'opération puisse se terminer. 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. - 'non trouvé' : Un document demandé n'a pas été trouvé. - « existe déjà » : un document que nous avons tenté de créer existe déjà. - 'autorisation refusée' : l'appelant n'a pas l'autorisation d'exécuter l'opération spécifiée. - « ressource épuisée » : 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é abandonnée, généralement en raison d'un problème de concurrence comme des abandons de transactions, etc. - « hors plage » : l'opération a été tentée au-delà de la plage valide. - 'non implémenté' : l'opération n'est pas implémentée ou n'est pas prise en charge/activée. - 'interne' : 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é. - 'indisponible' : 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. - « perte de données » : perte ou corruption irrécupérable de données. - « non authentifié » : la demande ne dispose pas d'informations d'authentification valides pour l'opération.

Signature:

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

FonctionsErrorCodeCore

Chaîne de code d'erreur de fonctions ajoutée après le préfixe de produit « fonctions/ ». Voir FunctionsErrorCode pour une documentation complète des codes.

Signature:

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';

HttpsAppelable

Une référence à un déclencheur HTTP « appelable » dans Google Cloud Functions.

Signature:

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