אפשרויות ההגדרה שניתנו ל-InitializeServerApp()
Signature:
export interface FirebaseServerAppSettings extends FirebaseAppSettings
תוספים: FirebaseAppSettings
תכונות
| מאפיין (property) | סוג | תיאור |
|---|---|---|
| authIdToken | מחרוזת | אסימון אופציונלי של Auth ID המשמש להמשך סשן של משתמש מחובר מסביבת זמן ריצה של לקוח.הפעלת getAuth עם FirebaseServerApp שהוגדר עם authIdToken מאומת גורמת לניסיון כניסה אוטומטי למשתמש שהמערכת authIdToken מייצגת. כדי שהפעולה הזו תצליח, צריך ליצור את האסימון לאחרונה.אם האסימון נכשל באימות המקומי, או אם שירות האימות לא הצליח לאמת אותו כשה-Auth SDK הופעל, תוצג אזהרה במסוף ו-Auth SDK לא יכניס משתמש בזמן האתחול.אם משתמש נכנס לחשבון בהצלחה, תהליך הקריאה החוזרת (callback) של מכונת האימות ב-onAuthStateChanged מופעל רגיל עם האובייקט User בהתאם. עם זאת, לאובייקטים של User שנוצרו באמצעות authIdToken אין אסימון רענון. refreshToken פעולות נכשלו. |
| name | undefined | אין פעולת getApp() עבור FirebaseServerApp, ולכן השם לא רלוונטי לאפליקציות. עם זאת, ניתן להשתמש בו באופן פנימי, והוא מוצהר כאן כדי ש-FirebaseServerApp יתאים לממשק FirebaseApp. |
| releaseOnDeref | אובייקט | אובייקט אופציונלי. אם ה-SDK של Firebase מספק, ה-SDK משתמש באובייקט FinalizationRegistry כדי לעקוב אחר סטטוס איסוף האשפה של האובייקט שסופק. ה-SDK של Firebase משחרר את ההתייחסות שלו למופע <br class="ph-2-0"> כאשר האובייקט שסופק <br class="ph-2-1"> נאסף אשפה.<br class="ph-2- 2">תוכל להשתמש בשדה זה כדי להפחית את תקורה של ניהול זיכרון עבור היישום שלך. אם משתמשים ב-SSR, אין צורך לבצע ניקוי FirebaseServerApp כל עוד אובייקט ההפניה נמחק (למשל, על ידי יציאה מהיקף ה-SSR).אם לא צוין אובייקט, האפליקציה חייבת לנקות את מכונת FirebaseServerApp על ידי הפעלת deleteApp.אם האפליקציה מספקת אובייקט בפרמטר הזה, אבל האפליקציה מופעלת במנוע JavaScript שמקדים את השגיאה ב-FinalizationRegistry (מבוא, 6.4 לפני התמיכה בצומת SSR).FirebaseServerApp |
FirebaseServerAppSettings.authIdToken
אסימון אופציונלי של Auth ID המשמש להמשך סשן של משתמש מחובר מסביבת זמן ריצה של לקוח.
פעולת getAuth עם FirebaseServerApp שהוגדרה באמצעות authIdToken מאומת תגרום לניסיון כניסה אוטומטי למשתמש ש-authIdToken מייצג. האסימון הופק לאחרונה כדי שהפעולה הזו תצליח.
אם האסימון נכשל באימות המקומי, או אם שירות האימות לא הצליח לאמת אותו כשה-Auth SDK מופעל, תופיע אזהרה במסוף ו-Auth SDK לא יכניס משתמש במהלך האתחול.
אם משתמש ייכנס בהצלחה, אז הקריאה החוזרת (callback) onAuthStateChanged של מופע האימות תופעל עם האובייקט User בהתאם לתהליכי האימות הרגילים. עם זאת, לאובייקטים של User שנוצרו באמצעות authIdToken אין אסימון רענון. refreshToken פעולות נכשלו.
Signature:
authIdToken?: string;
FirebaseServerAppSettings.name
אין פעולת getApp() עבור FirebaseServerApp, ולכן השם לא רלוונטי לאפליקציות. עם זאת, ניתן להשתמש בו באופן פנימי, והוא מוצהר כאן כדי ש-FirebaseServerApp יתאים לממשק FirebaseApp.
Signature:
name?: undefined;
FirebaseServerAppSettings.releaseOnDeref
אובייקט אופציונלי. אם ה-SDK של Firebase מספק, ה-SDK משתמש באובייקט FinalizationRegistry כדי לעקוב אחר סטטוס איסוף האשפה של האובייקט שסופק. ה-SDK של Firebase משחרר את ההפניה שלו במופע של FirebaseServerApp כשהאובייקט releaseOnDeref שסופק נאסף כמו אשפה.
ניתן להשתמש בשדה הזה כדי להפחית את התקורה של ניהול הזיכרון עבור האפליקציה. אם מגדירים אפליקציה שפועלת באישור SSR, אין צורך לבצע ניקוי FirebaseServerApp, כל עוד אובייקט ההפניה נמחק (למשל, על ידי יציאה מטווח ה-SSR).
אם לא מזינים אובייקט, האפליקציה חייבת לנקות את המופע של FirebaseServerApp על ידי הפעלת deleteApp.
אם האפליקציה מספקת אובייקט בפרמטר הזה, אך האפליקציה מופעלת במנוע JavaScript שקודם לתמיכה ב-FinalizationRegistry (למשל, הוצג בצומת v14.6.0), תתקבל שגיאה באתחול FirebaseServerApp.
Signature:
releaseOnDeref?: object;