Konfigurationsoptionen für initialServerApp()
Unterschrift:
export interface FirebaseServerAppSettings extends FirebaseAppSettings
Erweitert: FirebaseAppSettings
Attribute
| Property | Typ | Beschreibung |
|---|---|---|
| authIdToken | String | Ein optionales Authentifizierungs-ID-Token, das zum Fortsetzen einer angemeldeten Nutzersitzung aus einer Client-Laufzeitumgebung verwendet wird.Das Aufrufen von getAuth mit einer FirebaseServerApp, die mit einer validierten authIdToken konfiguriert ist, führt zu einem automatischen Versuch, den Nutzer anzumelden, den die authIdToken repräsentiert. Das Token muss vor Kurzem erstellt worden sein, damit dieser Vorgang erfolgreich ist.Wenn das Token die lokale Überprüfung nicht besteht oder der Auth-Dienst es bei der Initialisierung des Auth SDK nicht validieren konnte, wird eine Warnung in der Konsole protokolliert und das Auth SDK meldet einen Nutzer bei der Initialisierung nicht an.Wenn ein Nutzer erfolgreich angemeldet wurde, wird der onAuthStateChanged-Callback der Auth-Instanz gemäß den Standard-Auth-Abläufen mit dem User-Objekt aufgerufen. User-Objekte, die über authIdToken erstellt wurden, haben jedoch kein Aktualisierungstoken. Versuchte refreshToken-Vorgänge schlagen fehl. |
| name | nicht definiert | Für FirebaseServerApp gibt es keinen getApp()-Vorgang, daher ist der Name für Anwendungen nicht relevant. Sie kann jedoch intern verwendet werden und wird hier so deklariert, dass FirebaseServerApp der FirebaseApp-Schnittstelle entspricht. |
| releaseOnDeref | Objekt | Ein optionales Objekt. Falls angegeben, verwendet das Firebase SDK ein FinalizationRegistry-Objekt, um den Status der automatischen Speicherbereinigung des bereitgestellten Objekts zu überwachen. Das Firebase SDK gibt die Referenz auf der FirebaseServerApp-Instanz frei, wenn das bereitgestellte releaseOnDeref-Objekt automatisch bereinigt wird.Mit diesem Feld können Sie den Aufwand für die Arbeitsspeicherverwaltung Ihrer Anwendung reduzieren. Wenn angegeben, muss eine App, die in einer SSR-Karte ausgeführt wird, keine FirebaseServerApp-Bereinigung ausführen, solange das Referenzobjekt gelöscht ist (z. B.indem es außerhalb des SSR-Bereichs liegt.)Wenn kein Objekt angegeben wird, muss die Anwendung die FirebaseServerApp-Instanz durch Aufrufen von deleteApp bereinigen.Wenn die Anwendung ein Objekt in diesem Parameter bereitstellt, die Anwendung aber in einer JavaScript-Engine ausgeführt wird, die vor der Unterstützung von FinalizationRegistry erfolgte (v14-Instanz ist die Unterstützung von FinalizationRegistry).FirebaseServerApp |
FirebaseServerAppSettings.authIdToken
Ein optionales Authentifizierungs-ID-Token, das zum Fortsetzen einer angemeldeten Nutzersitzung aus einer Clientlaufzeitumgebung verwendet wird.
Wenn Sie getAuth mit einer FirebaseServerApp aufrufen, die mit einer validierten authIdToken konfiguriert ist, wird automatisch versucht, den Nutzer anzumelden, der von der authIdToken repräsentiert wird. Das Token muss vor Kurzem erstellt worden sein, damit dieser Vorgang erfolgreich ist.
Wenn die lokale Bestätigung des Tokens fehlschlägt oder der Auth-Dienst es bei der Initialisierung des Auth SDK nicht validieren konnte, wird eine Warnung in der Konsole protokolliert und das Auth SDK meldet einen Nutzer bei der Initialisierung nicht an.
Wenn ein Nutzer erfolgreich angemeldet wurde, wird der onAuthStateChanged-Callback der Auth-Instanz gemäß den Standard-Auth-Abläufen mit dem User-Objekt aufgerufen. User-Objekte, die über authIdToken erstellt wurden, haben jedoch kein Aktualisierungstoken. Versuchte refreshToken-Vorgänge schlagen fehl.
Unterschrift:
authIdToken?: string;
FirebaseServerAppSettings.name
Für FirebaseServerApp gibt es keinen getApp()-Vorgang, daher ist der Name für Anwendungen nicht relevant. Sie kann jedoch intern verwendet werden und wird hier so deklariert, dass FirebaseServerApp der FirebaseApp-Schnittstelle entspricht.
Unterschrift:
name?: undefined;
FirebaseServerAppSettings.releaseOnDeref
Ein optionales Objekt. Falls angegeben, verwendet das Firebase SDK ein FinalizationRegistry-Objekt, um den Status der automatischen Speicherbereinigung des bereitgestellten Objekts zu überwachen. Das Firebase SDK gibt seine Referenz für die FirebaseServerApp-Instanz frei, wenn das bereitgestellte releaseOnDeref-Objekt eine automatische Speicherbereinigung aufweist.
Sie können dieses Feld verwenden, um den Speicherverwaltungsaufwand für Ihre Anwendung zu reduzieren. Wenn angegeben, muss für eine App, die auf einer SSR-Karte ausgeführt wird, keine FirebaseServerApp-Bereinigung durchgeführt werden, solange das Referenzobjekt gelöscht wird, z. B. weil es nicht den SSR-Geltungsbereich hat.
Wenn kein Objekt angegeben ist, muss die Anwendung die FirebaseServerApp-Instanz durch Aufrufen von deleteApp bereinigen.
Wenn die Anwendung in diesem Parameter ein Objekt bereitstellt, die Anwendung aber in einer JavaScript-Engine ausgeführt wird, die älter als die Unterstützung von FinalizationRegistry ist (z. B. in Knoten v14.6.0 eingeführt), wird bei der Initialisierung von FirebaseServerApp ein Fehler ausgegeben.
Unterschrift:
releaseOnDeref?: object;