FirebaseServerAppSettings interface

InitializeServerApp() に指定された構成オプション

署名:

export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> 

拡張:<FirebaseAppSettings, 'name'> を省略

プロパティ

プロパティ 種類 説明
authIdToken 文字列 クライアント ランタイム環境からログイン済みユーザー セッションを再開するために使用されるオプションの Auth ID トークン。検証済みの authIdToken で構成された FirebaseServerApp を使用して getAuth を呼び出すと、authIdToken が表すユーザーのログインが自動的に試行されます。この操作を成功させるには、トークンが最近作成された必要があります。ローカル検証に失敗した場合や、Auth SDK の初期化時に Auth サービスがトークンの検証に失敗した場合は、コンソールに警告が出力され、Auth SDK は初期化時にユーザーをログインさせません。ユーザーが正常にログインすると、標準の Auth フローに従って、User オブジェクトで Auth インスタンスの onAuthStateChanged コールバックが呼び出されます。ただし、authIdToken で作成された User オブジェクトには更新トークンがありません。refreshToken オペレーションを行おうとすると、失敗します。
releaseOnDeref オブジェクト オプションのオブジェクト。指定されている場合、Firebase SDK は FinalizationRegistry オブジェクトを使用して、指定されたオブジェクトのガベージ コレクションのステータスをモニタリングします。Firebase SDK は、指定された releaseOnDeref オブジェクトがガベージ コレクションが行われると、FirebaseServerApp インスタンスで参照を解放します。このフィールドを使用すると、アプリケーションのメモリ管理オーバーヘッドを削減できます。指定されている場合、SSR パスで実行されているアプリは、参照オブジェクトが(SSR スコープから抜けるなどして)削除されている限り、FirebaseServerApp のクリーンアップを行う必要はありません。オブジェクトが指定されていない場合、アプリケーションは deleteApp を呼び出して FirebaseServerApp インスタンスをクリーンアップする必要があります。アプリケーションがこのパラメータでオブジェクトを提供しているが、FirebaseServerApp.6 でインスタンス エラーがスローされる前の JavaScript エンジンで、インスタンスがスローされます。FinalizationRegistry

FirebaseServerAppSettings.authIdToken

クライアント ランタイム環境からログイン済みユーザー セッションを再開するために使用されるオプションの Auth ID トークン。

検証済みの authIdToken が構成された FirebaseServerApp を使用して getAuth を呼び出すと、authIdToken が表すユーザーのログインが自動的に試行されます。このオペレーションを成功させるには、トークンが最近作成された必要があります。

トークンがローカルの検証に失敗した場合、または Auth SDK の初期化時に Auth サービスがトークンの検証に失敗した場合は、コンソールに警告がログに記録され、Auth SDK は初期化時にユーザーのログインを行いません。

ユーザーが正常にログインすると、標準の Auth フローに沿って、User オブジェクトで Auth インスタンスの onAuthStateChanged コールバックが呼び出されます。ただし、authIdToken で作成された User オブジェクトには更新トークンがありません。refreshToken オペレーションを行おうとすると、失敗します。

署名:

authIdToken?: string;

FirebaseServerAppSettings.releaseOnDeref

オプションのオブジェクト。指定されている場合、Firebase SDK は FinalizationRegistry オブジェクトを使用して、指定されたオブジェクトのガベージ コレクションのステータスをモニタリングします。Firebase SDK は、指定された releaseOnDeref オブジェクトがガベージ コレクションの対象となるときに、FirebaseServerApp インスタンスで参照を解放します。

このフィールドを使用すると、アプリケーションのメモリ管理オーバーヘッドを削減できます。これを指定した場合、SSR パスで実行されるアプリは、参照オブジェクトが(SSR のスコープ外などで)削除されている限り、FirebaseServerApp クリーンアップを行う必要はありません。

オブジェクトが指定されていない場合、アプリで deleteApp を呼び出して FirebaseServerApp インスタンスをクリーンアップする必要があります。

アプリケーションがこのパラメータでオブジェクトを指定していても、FinalizationRegistry のサポート(たとえばノード v14.6.0 で導入)よりも前の JavaScript エンジンでアプリケーションが実行されている場合、FirebaseServerApp の初期化時にエラーがスローされます。

署名:

releaseOnDeref?: object;