指派給 InitialServerApp() 的設定選項
簽名:
export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'>
擴充:Omit<FirebaseAppSettings, 'name'>
屬性
屬性 | 類型 | 說明 |
---|---|---|
authIdToken | 字串 | 這是選用的驗證 ID 權杖,可用於從用戶端執行階段環境繼續執行已登入的使用者工作階段。只要在 FirebaseServerApp 中設定具有已驗證 authIdToken 的 FirebaseServerApp ,系統會自動嘗試登入 authIdToken 代表的使用者。getAuth 你必須最近曾擷取這個權杖,這項作業才能成功。如果權杖在本機驗證失敗,或驗證服務無法在 Auth SDK 初始化時驗證憑證,系統就會在控制台記錄警告,並在初始化時讓使用者登入 Auth SDK。如果使用者成功登入,系統會依照 User 驗證流程叫用 Auth 執行個體的 onAuthStateChanged 回呼。不過,透過 authIdToken 建立的 User 物件沒有更新權杖。嘗試 refreshToken 作業失敗。 |
releaseOnDeref | 物件 | 選用的物件。如果提供此選項,Firebase SDK 會使用 FinalizationRegistry 物件監控指定物件的垃圾收集狀態。如果提供的 releaseOnDeref 物件含有垃圾資訊,Firebase SDK 會在 FirebaseServerApp 例項上釋出其參照。您可以使用這個欄位,降低應用程式的記憶體管理負擔。若提供此屬性,在 SSR 傳遞中執行的應用程式不需要執行 FirebaseServerApp 清理,只要參照物件遭到刪除 (例如從 SSR 範圍消失) 即可。若未提供物件,應用程式必須叫用 deleteApp 來清除 FirebaseServerApp 例項。如果應用程式會在初次支援 FinalizationRegistry 節點中提供物件,但應用程式是在初次支援 FinalizationRegistry 節點時執行,4.1.FirebaseServerApp |
FirebaseServerAppSettings.authIdToken
選用的驗證 ID 權杖,可用於從用戶端執行階段環境繼續執行已登入的使用者工作階段。
以已驗證的 authIdToken
設定的 FirebaseServerApp
叫用 getAuth
時,會自動嘗試登入 authIdToken
代表的使用者。憑證最近才剛建立完畢,這項作業才能成功。
如果權杖在本機驗證失敗,或是在 Auth SDK 初始化時驗證服務驗證失敗,系統就會記錄控制台顯示警告,且 Auth SDK 不會在初始化時登入使用者。
如果使用者成功登入,系統就會根據標準驗證流程,使用 User
物件叫用驗證執行個體的 onAuthStateChanged
回呼。不過,透過 authIdToken
建立的 User
物件沒有更新權杖。嘗試 refreshToken
作業失敗。
簽名:
authIdToken?: string;
FirebaseServerAppSettings.releaseOnDeref
選用的物件。如果提供此選項,Firebase SDK 會使用 FinalizationRegistry
物件監控指定物件的垃圾收集狀態。如果提供的 releaseOnDeref
物件已進行垃圾收集,Firebase SDK 會在 FirebaseServerApp
例項上釋出其參照。
您可以使用這個欄位來減少應用程式的記憶體管理負擔。如有提供,在 SSR 票證中執行的應用程式無須執行 FirebaseServerApp
清理作業,只要參照物件遭到刪除即可 (例如,脫離 SSR 範圍)。
如未提供物件,應用程式必須叫用 deleteApp
來清除 FirebaseServerApp
例項。
如果應用程式在此參數中提供物件,但應用程式是在之前支援 FinalizationRegistry
的 JavaScript 引擎中執行 (例如,在節點 v14.6.0 中導入),則 FirebaseServerApp
初始化時會擲回錯誤。
簽名:
releaseOnDeref?: object;