Options de configuration fournies pour initialServerApp()
Signature :
export interface FirebaseServerAppSettings extends FirebaseAppSettings
Extension:FirebaseAppSettings
Propriétés
| Propriété | Type | Description |
|---|---|---|
| authIdToken | chaîne | Jeton d'authentification facultatif utilisé pour reprendre une session utilisateur connectée à partir d'un environnement d'exécution client.Si vous appelez getAuth avec un FirebaseServerApp configuré avec un authIdToken validé, une tentative de connexion automatique de l'utilisateur représenté par authIdToken est déclenchée. Le jeton doit avoir été généré récemment pour que cette opération aboutisse.Si le jeton échoue lors de la validation locale, ou si le service Auth n'a pas réussi à le valider lors de l'initialisation du SDK Auth, un avertissement est consigné dans la console et le SDK Auth ne se connecte pas à un utilisateur lors de l'initialisation.Si un utilisateur est correctement connecté, le rappel onAuthStateChanged de l'instance Auth est appelé avec l'objet User, conformément aux flux d'authentification standards. Toutefois, les objets User créés via un authIdToken n'ont pas de jeton d'actualisation. Les tentatives d'opérations refreshToken échouent. |
| name | undefined | Il n'existe pas d'opération getApp() pour FirebaseServerApp. Ce nom n'est donc pas pertinent pour les applications. Cependant, il peut être utilisé en interne et est déclaré ici afin que FirebaseServerApp soit conforme à l'interface FirebaseApp. |
| releaseOnDeref | objet | Objet facultatif. S'il est fourni, le SDK Firebase utilise un objet FinalizationRegistry pour surveiller l'état de la récupération de mémoire de l'objet fourni. Le SDK Firebase libère sa référence sur l'instance FirebaseServerApp lorsque l'objet releaseOnDeref fourni a fait l'objet d'une récupération de mémoire.Vous pouvez utiliser ce champ afin de réduire les frais de gestion de la mémoire pour votre application. S'il est fourni, une application exécutée dans une carte SSR n'a pas besoin d'effectuer de nettoyage FirebaseServerApp, tant que l'objet de référence est supprimé (par exemple, en dehors du champ d'application SSR).Si aucun objet n'est fourni, l'application doit nettoyer l'instance FirebaseServerApp en appelant deleteApp.Si l'application fournit un objet dans ce paramètre, mais que l'application est exécutée dans un moteur JavaScript qui est exécuté dans un moteur JavaScript qui est antérieur à la prise en charge de FinalizationRegistry, une erreur est générée pour FirebaseServerApp. |
FirebaseServerAppSettings.authIdToken
Jeton d'authentification facultatif utilisé pour reprendre une session utilisateur connectée à partir d'un environnement d'exécution client.
Appeler getAuth avec un FirebaseServerApp configuré avec un authIdToken validé entraîne une tentative automatique de connexion à l'utilisateur représenté par authIdToken. Le jeton doit avoir été récemment saisi pour que cette opération aboutisse.
Si la validation locale du jeton échoue, ou si le service Auth n'a pas réussi à le valider lors de l'initialisation du SDK Auth, un avertissement est consigné dans la console, et le SDK Auth ne connecte aucun utilisateur lors de l'initialisation.
Si un utilisateur est connecté, le rappel onAuthStateChanged de l'instance Auth est appelé avec l'objet User, conformément aux flux d'authentification standards. Toutefois, les objets User créés via un authIdToken n'ont pas de jeton d'actualisation. Les tentatives d'opérations refreshToken échouent.
Signature :
authIdToken?: string;
FirebaseServerAppSettings.name
Il n'existe pas d'opération getApp() pour FirebaseServerApp. Ce nom n'est donc pas pertinent pour les applications. Cependant, il peut être utilisé en interne et est déclaré ici afin que FirebaseServerApp soit conforme à l'interface FirebaseApp.
Signature :
name?: undefined;
FirebaseServerAppSettings.releaseOnDeref
Objet facultatif. S'il est fourni, le SDK Firebase utilise un objet FinalizationRegistry pour surveiller l'état de la récupération de mémoire de l'objet fourni. Le SDK Firebase libère sa référence sur l'instance FirebaseServerApp lorsque l'objet releaseOnDeref fourni est éliminé par la récupération de mémoire.
Vous pouvez utiliser ce champ afin de réduire les frais de gestion de la mémoire pour votre application. S'il est fourni, une application exécutée dans une passe SSR n'a pas besoin d'effectuer de nettoyage des FirebaseServerApp, tant que l'objet de référence est supprimé (parce qu'il ne fait plus partie du champ d'application SSR, par exemple).
Si aucun objet n'est fourni, l'application doit nettoyer l'instance FirebaseServerApp en appelant deleteApp.
Si l'application fournit un objet dans ce paramètre, mais qu'elle est exécutée dans un moteur JavaScript antérieur à la prise en charge de FinalizationRegistry (introduite dans la version 14.6.0 du nœud, par exemple), une erreur est générée lors de l'initialisation de FirebaseServerApp.
Signature :
releaseOnDeref?: object;