InitializeServerApp() に指定された構成オプション
署名:
export interface FirebaseServerAppSettings extends FirebaseAppSettings
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
| authIdToken | 文字列 | クライアント ランタイム環境からログイン ユーザー セッションを再開するために使用されるオプションの Auth ID トークン。検証済みの authIdToken で構成された FirebaseServerApp で getAuth を呼び出すと、authIdToken が表すユーザーのログインが自動的に試行されます。このオペレーションが成功するには、トークンが最近作成された必要があります。トークンがローカル検証で不合格だった場合、または Auth SDK の初期化時に Auth サービスで検証に失敗した場合、警告がコンソールに記録され、Auth SDK は初期化時にユーザーがログインしません。ユーザーが正常にログインすると、標準の Auth フローに従って Auth インスタンスの onAuthStateChanged コールバックが User オブジェクトで呼び出されます。ただし、authIdToken で作成された User オブジェクトには更新トークンがありません。試行した refreshToken オペレーションが失敗しました。 |
| name | 未定義 | FirebaseServerApp には getApp() オペレーションがないため、この名前はアプリケーションに関係ありません。ただし、内部で使用することは可能で、FirebaseServerApp が FirebaseApp インターフェースに準拠するようにここで宣言されています。 |
| releaseOnDeref | オブジェクト | オプションのオブジェクト。指定されている場合、Firebase SDK は FinalizationRegistry オブジェクトを使用して、指定されたオブジェクトのガベージ コレクションのステータスをモニタリングします。指定された releaseOnDeref オブジェクトがガベージ コレクションの対象となると、Firebase SDK は FirebaseServerApp インスタンスで参照を解放します。このフィールドを使用すると、アプリケーションのメモリ管理オーバーヘッドを削減できます。指定すると、参照オブジェクトが削除されている限り（SSR スコープ外になるなど）、SSR パスで実行されるアプリは FirebaseServerApp のクリーンアップを実行する必要がありません。オブジェクトが指定されていない場合、アプリケーションは deleteApp を呼び出して FirebaseServerApp インスタンスをクリーンアップする必要があります。アプリケーションがこのパラメータにオブジェクトを提供しているが、FirebaseServerApp のサポート日が 6 より前の JavaScript エンジンでアプリケーションが実行される場合は、初期値 6 がスローされます（v1 で導入）。FinalizationRegistry |
FirebaseServerAppSettings.authIdToken
ログインしたユーザー セッションをクライアントのランタイム環境から再開するために使用される、省略可能な Auth ID トークン。
検証済みの authIdToken で構成された FirebaseServerApp で getAuth を呼び出すと、authIdToken が表すユーザーのログインが自動的に試行されます。このオペレーションを成功させるには、トークンが最近作成された必要があります。
トークンがローカルで検証できなかった場合、または Auth SDK の初期化時に Auth サービスによる検証で不合格だった場合は、コンソールに警告が記録され、Auth SDK は初期化時にユーザーをログインさせません。
ユーザーが正常にログインすると、標準の Auth フローに従って Auth インスタンスの onAuthStateChanged コールバックが User オブジェクトで呼び出されます。ただし、authIdToken で作成された User オブジェクトには更新トークンがありません。試行した refreshToken オペレーションが失敗しました。
署名:
authIdToken?: string;
FirebaseServerAppSettings.name
FirebaseServerApp には getApp() オペレーションがないため、この名前はアプリケーションに関係ありません。ただし、内部で使用することは可能で、FirebaseServerApp が FirebaseApp インターフェースに準拠するようにここで宣言されています。
署名:
name?: undefined;
FirebaseServerAppSettings.releaseOnDeref
オプションのオブジェクト。指定されている場合、Firebase SDK は FinalizationRegistry オブジェクトを使用して、指定されたオブジェクトのガベージ コレクションのステータスをモニタリングします。Firebase SDK は、指定された releaseOnDeref オブジェクトがガベージ コレクションの対象になると、FirebaseServerApp インスタンスで参照を解放します。
このフィールドを使用して、アプリケーションのメモリ管理オーバーヘッドを削減できます。この属性を指定すると、SSR パスで実行されるアプリは、参照オブジェクトが削除された場合（SSR スコープ外になるなど）を除き、FirebaseServerApp をクリーンアップする必要はありません。
オブジェクトが指定されていない場合、アプリケーションは deleteApp を呼び出して FirebaseServerApp インスタンスをクリーンアップする必要があります。
アプリケーションがこのパラメータにオブジェクトを指定しても、FinalizationRegistry のサポート（ノード v14.6.0 などで導入）より前の JavaScript エンジンで実行される場合は、FirebaseServerApp の初期化時にエラーがスローされます。
署名:
releaseOnDeref?: object;