@firebase/firestore

פונקציות

פוּנקצִיָה תיאור
פונקציה (אפליקציה,...)
getFirestore(אפליקציה) מחזירה את מופע ברירת המחדל הקיים של Firestore המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.
getFirestore(app, databaseId) (ביטא) מחזירה את המופע הקיים בשם Firestore המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.
initializeFirestore(אפליקציה, הגדרות, זיהוי מסד נתונים) מאתחל מופע חדש של Firestore עם ההגדרות שסופקו. ניתן לקרוא רק לפני כל פונקציה אחרת, כולל getFirestore() . אם ההגדרות המותאמות אישית ריקות, פונקציה זו שווה ערך לקריאה getFirestore() .
פונקציה (firestore, ...)
clearIndexedDbPersistence(firestore) מנקה את האחסון המתמשך. זה כולל כתיבה ממתינה ומסמכים מאוחסנים במטמון. יש לקרוא בזמן שהמופע של Firestore אינו מופעל (לאחר סיום האפליקציה או כשהאפליקציה מאותחלת לראשונה). בעת ההפעלה, יש לקרוא לפונקציה זו לפני פונקציות אחרות (מלבד initializeFirestore() או getFirestore() )). אם המופע של Firestore עדיין פועל, ההבטחה תידחה עם קוד השגיאה של failed-precondition . הערה: clearIndexedDbPersistence() נועד בעיקר לעזור בכתיבת בדיקות אמינות המשתמשות ב-Cloud Firestore. הוא משתמש במנגנון יעיל להורדת נתונים קיימים אך אינו מנסה להחליף בצורה מאובטחת או להפוך את הנתונים המאוחסנים במטמון לבלתי ניתנים לשחזור. עבור יישומים שרגישים לחשיפת נתונים בקובץ שמור בין הפעלות משתמש, אנו ממליצים בחום לא לאפשר התמדה כלל.
אוסף (firestore, path, pathSegments) מקבל מופע CollectionReference המתייחס לאוסף בנתיב המוחלט שצוין.
collectionGroup(firestore, collectionId) יוצר ומחזיר מופע Query חדש הכולל את כל המסמכים במסד הנתונים הכלולים באוסף או תת-אוסף עם ה- collectionId הנתון.
connectFirestoreEmulator (firestore, host, port, options) שנה מופע זה כדי לתקשר עם אמולטור Cloud Firestore. הערה: יש לקרוא לזה לפני שנעשה שימוש במופע זה לביצוע פעולות כלשהן.
disableNetwork(firestore) משבית את השימוש ברשת עבור מופע זה. ניתן להפעיל אותו מחדש באמצעות enableNetwork() . בזמן שהרשת מושבתת, כל מאזיני תמונת מצב, שיחות getDoc() או getDocs() יחזירו תוצאות מהמטמון, וכל פעולות כתיבה יעמדו בתור עד לשחזור הרשת.
doc(firestore, path, pathSegments) מקבל מופע DocumentReference המתייחס למסמך בנתיב המוחלט שצוין.
enableIndexedDbPersistence(firestore, persistenceSettings) ניסיונות לאפשר אחסון מתמשך, אם אפשר. במקרה של כישלון, enableIndexedDbPersistence() ידחה את ההבטחה או יזרוק חריגה. ישנן מספר סיבות מדוע זה יכול להיכשל, אשר ניתן לזהות על ידי code על השגיאה. * תנאי מוקדם נכשל: האפליקציה כבר פתוחה בלשונית דפדפן אחרת. * לא מיושם: הדפדפן אינו תואם להטמעת ההתמדה הלא מקוונת. שים לב שגם לאחר כשל, מופע Firestore יישאר שמיש, אולם התמדה במצב לא מקוון תושבת. הערה: יש לקרוא ל- enableIndexedDbPersistence() לפני כל פונקציה אחרת (מלבד initializeFirestore() , getFirestore() או clearIndexedDbPersistence() . לא ניתן להשתמש ב-persistence בסביבת Node.js.
enableMultiTabIndexedDbPersistence(firestore) ניסיונות לאפשר אחסון קבוע מרובה כרטיסיות, אם אפשר. אם מופעלת בכל הכרטיסיות, כל הפעולות חולקות גישה להתמדה מקומית, כולל ביצוע משותף של שאילתות ועדכוני מסמכים מקומיים המתוגמלים בזמן השהייה בכל המופעים המחוברים. במקרה של כישלון, enableMultiTabIndexedDbPersistence() ידחה את ההבטחה או יזרוק חריגה. ישנן מספר סיבות מדוע זה יכול להיכשל, אשר ניתן לזהות על ידי code על השגיאה. * תנאי מוקדם נכשל: האפליקציה כבר פתוחה בכרטיסיית דפדפן אחרת והריבוי לשוניות לא מופעלת. * לא מיושם: הדפדפן אינו תואם להטמעת ההתמדה הלא מקוונת. שים לב שגם לאחר כשל, מופע Firestore יישאר שמיש, אולם התמדה במצב לא מקוון תושבת.
enableNetwork(firestore) מאפשר מחדש שימוש ברשת עבור מופע Firestore זה לאחר קריאה קודמת ל- disableNetwork() .
getPersistentCacheIndexManager(firestore) מחזירה את PersistentCache Index Manager המשמש את אובייקט Firestore הנתון. מופע PersistentCacheIndexManager , או null אם אחסון מתמשך מקומי אינו בשימוש.
loadBundle(firestore, bundleData) טוען חבילת Firestore למטמון המקומי.
namedQuery(firestore, name) קורא שאילתת Firestore ממטמון מקומי, מזוהה לפי השם הנתון. השאילתות הנקובות ארוזות בחבילות בצד השרת (יחד עם המסמכים המתקבלים), ונטענות למטמון מקומי באמצעות loadBundle . פעם אחת במטמון המקומי, השתמש בשיטה זו כדי לחלץ שאילתה לפי שם.
onSnapshotsInSync (firestore, observer) מצרף מאזין לאירוע צילומי מצב מסונכרן. אירוע ה-Snapshot-in-Sync מציין שכל המאזינים שהושפעו משינוי נתון ירו, גם אם שינוי יחיד שנוצר על ידי שרת משפיע על מספר מאזינים. הערה: אירוע ה-Snapshot-In-Sync מציין רק שמאזינים מסונכרנים זה עם זה, אך אינו קשור לשאלה האם התמונות האלה מסונכרנות עם השרת. השתמש ב-SnapshotMetadata במאזינים הבודדים כדי לקבוע אם תמונת מצב היא מהמטמון או מהשרת.
onSnapshotsInSync (firestore, onSync) מצרף מאזין לאירוע צילומי מצב מסונכרן. אירוע ה-Snapshot-in-Sync מציין שכל המאזינים שהושפעו משינוי נתון ירו, גם אם שינוי יחיד שנוצר על ידי שרת משפיע על מספר מאזינים. הערה: אירוע ה-Snapshot-In-Sync מציין רק שמאזינים מסונכרנים זה עם זה, אך אינו קשור לשאלה האם התמונות האלה מסונכרנות עם השרת. השתמש SnapshotMetadata במאזינים הבודדים כדי לקבוע אם תמונת מצב היא מהמטמון או מהשרת.
runTransaction (firestore, updateFunction, options) מבצע את updateFunction הנתון ולאחר מכן מנסה לבצע את השינויים שהוחלו בתוך העסקה. אם מסמך כלשהו שנקרא בתוך העסקה השתנה, Cloud Firestore מנסה שוב את updateFunction . אם הוא לא מצליח להתחייב לאחר 5 ניסיונות, העסקה נכשלת. המספר המרבי של כתיבה המותר בעסקה בודדת הוא 500.
setIndexConfiguration(Firestore, Configuration) (ביטא) מגדיר יצירת אינדקס לביצוע שאילתה מקומית. כל תצורת אינדקס קודמת מבוטלת. Promise נפתרת ברגע שתצורת האינדקס נמשכת. ערכי האינדקס עצמם נוצרים באופן אסינכרוני. אתה יכול להמשיך להשתמש בשאילתות הדורשות אינדקס גם אם המדדים עדיין לא זמינים. ביצוע שאילתה יתחיל להשתמש באינדקס באופן אוטומטי לאחר כתיבת ערכי האינדקס. אינדקסים נתמכים רק עם התמדה של IndexedDb. אם IndexedDb אינו מופעל, מתעלמים מכל תצורת אינדקס.
setIndexConfiguration(firestore, json) (ביטא) מגדיר יצירת אינדקס לביצוע שאילתה מקומית. כל תצורת אינדקס קודמת מבוטלת. Promise נפתרת ברגע שתצורת האינדקס נמשכת. ערכי האינדקס עצמם נוצרים באופן אסינכרוני. אתה יכול להמשיך להשתמש בשאילתות הדורשות אינדקס גם אם המדדים עדיין לא זמינים. ביצוע שאילתה יתחיל להשתמש באינדקס באופן אוטומטי לאחר כתיבת ערכי האינדקס. אינדקסים נתמכים רק עם התמדה של IndexedDb. הפעל את enableIndexedDbPersistence() או enableMultiTabIndexedDbPersistence() לפני הגדרת תצורת אינדקס. אם IndexedDb אינו מופעל, מתעלמים מכל תצורת אינדקס. השיטה מקבלת את פורמט JSON המיוצא על ידי Firebase CLI ( firebase firestore:indexes ). אם פורמט JSON אינו חוקי, שיטה זו זורקת שגיאה.
terminate (firestore) מסיים את מופע Firestore שסופק. לאחר קריאת terminate() ניתן להשתמש רק בפונקציה clearIndexedDbPersistence() . כל פונקציה אחרת תזרוק FirestoreError . כדי להפעיל מחדש לאחר סיום, צור מופע חדש של FirebaseFirestore עם getFirestore() . סיום אינו מבטל כתיבה ממתינה וכל הבטחה הממתינה לתגובה מהשרת לא תיפתרנה. אם התמדה מופעלת, בפעם הבאה שתתחיל את המופע הזה, הוא ימשיך לשלוח את הכתבים האלה לשרת. הערה: בנסיבות רגילות, אין צורך בקריאת terminate() . פונקציה זו שימושית רק כאשר אתה רוצה לאלץ את המופע הזה לשחרר את כל המשאבים שלו או בשילוב עם clearIndexedDbPersistence() כדי להבטיח שכל המצב המקומי יושמד בין ריצות בדיקה.
waitForPendingWrites(firestore) ממתין עד שכל הכתיבה הממתינה עבור המשתמש הפעיל יאושרו על ידי הקצה העורפי. ההבטחה המוחזרת נפתרת באופן מיידי אם אין כתיבה יוצאת דופן. אחרת, ההבטחה ממתינה לכל הכתבים שהוצאו בעבר (כולל אלה שנכתבו בהפעלה קודמת של האפליקציה), אך היא לא ממתינה לכתבים שנוספו לאחר קריאת הפונקציה. אם אתה רוצה לחכות לכתיבה נוספת, התקשר שוב waitForPendingWrites() . כל הבטחות מתקיימות waitForPendingWrites() נדחות במהלך שינויים במשתמש.
writeBatch(firestore) יוצר אצווה כתיבה, המשמשת לביצוע כתיבה מרובת כפעולה אטומית אחת. המספר המרבי של כתיבה המותר ב- WriteBatch בודד הוא 500. בניגוד לטרנזקציות, אצוות כתיבה נמשכות במצב לא מקוון ולכן הן עדיפות כאשר אינך צריך להתנות את הכתיבה שלך בנתוני קריאה.
פוּנקצִיָה()
לספור() צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את ספירת המסמכים בערכת התוצאות של שאילתה.
deleteField() מחזירה זקיף לשימוש עם updateDoc() או setDoc() עם {merge: true} כדי לסמן שדה למחיקה.
documentId() מחזירה FieldPath מיוחד להתייחסות למזהה של מסמך. ניתן להשתמש בו בשאילתות כדי למיין או לסנן לפי מזהה המסמך.
getFirestore() מחזירה את מופע ברירת המחדל הקיים של Firestore המשויך ל- FirebaseApp המוגדר כברירת מחדל . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.
memoryEagerGarbageCollector() יוצר מופע של MemoryEagerGarbageCollector . זהו גם אוסף האשפה המוגדר כברירת מחדל, אלא אם צוין אחרת במפורש.
persistentMultipleTabManager() יוצר מופע של PersistentMultipleTabManager .
serverTimestamp() מחזירה זקיף בשימוש עם setDoc() או updateDoc() כדי לכלול חותמת זמן שנוצרת על ידי שרת בנתונים הכתובים.
function(databaseId, ...)
getFirestore(databaseId) (ביטא) מחזירה את המופע הקיים בשם Firestore המשויך לברירת המחדל של FirebaseApp . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.
פונקציה (אלמנטים, ...)
arrayRemove(elements) מחזירה ערך מיוחד שניתן להשתמש בו עם setDoc() או שאומר לשרת להסיר את האלמנטים הנתונים מכל ערך מערך שכבר קיים בשרת. כל המופעים של כל אלמנט שצוין יוסרו מהמערך. אם השדה המשתנה אינו כבר מערך, הוא ידרוס במערך ריק.
arrayUnion(אלמנטים) מחזירה ערך מיוחד שניתן להשתמש בו עם setDoc() או updateDoc() שאומר לשרת לאחד את האלמנטים הנתונים עם כל ערך מערך שכבר קיים בשרת. כל אלמנט שצוין שלא קיים כבר במערך יתווסף לסוף. אם השדה המשתנה אינו כבר מערך, הוא ידרוס במערך המכיל בדיוק את האלמנטים שצוינו.
פונקציה (שדה,...)
ממוצע (שדה) צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את הממוצע של שדה שצוין על פני טווח של מסמכים בערכת התוצאות של שאילתה.
sum(field) צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את הסכום של שדה שצוין על פני טווח של מסמכים בערכת התוצאות של שאילתה.
function(fieldPath, ...)
orderBy(fieldPath, directionStr) יוצר QueryOrderByConstraint הממיין את תוצאת השאילתה לפי השדה שצוין, אופציונלי בסדר יורד במקום עולה. הערה: מסמכים שאינם מכילים את השדה שצוין לא יופיעו בתוצאת השאילתה.
where(fieldPath, opStr, value) יוצר QueryFieldFilterConstraint האוכפת שמסמכים חייבים להכיל את השדה שצוין ושהערך צריך לעמוד באילוץ היחס שסופק.
function(fieldValues, ...)
endAt(fieldValues) יוצר QueryEndAtConstraint שמשנה את ערכת התוצאה כך שתסתיים בשדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.
endBefore(fieldValues) יוצר QueryEndAtConstraint שמשנה את התוצאה שתסתיים לפני השדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.
startAfter(fieldValues) יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה להתחיל אחרי השדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.
startAt(fieldValues) יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה כך שתתחיל בשדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.
function (indexManager, ...)
deleteAllPersistentCacheIndexes(indexManager) מסיר את כל אינדקסי המטמון הקבועים. שימו לב שפונקציה זו תמחק גם אינדקסים שנוצרו על ידי setIndexConfiguration() , אשר הוצא משימוש.
disablePersistentCacheIndexAutoCreation(indexManager) מפסיק ליצור אינדקס מטמון קבוע באופן אוטומטי לביצוע שאילתה מקומית. האינדקסים שנוצרו על ידי קריאה ל- enablePersistentCacheIndexAutoCreation() עדיין נכנסים לתוקף.
enablePersistentCacheIndexAutoCreation(indexManager) מאפשר ל-SDK ליצור אינדקסים קבועים של מטמון באופן אוטומטי לביצוע שאילתה מקומית כאשר ה-SDK מאמין שאינדקסי מטמון יכולים לסייע בשיפור הביצועים. תכונה זו מושבתת כברירת מחדל.
פונקציה (שמאל,...)
aggregateFieldEqual(שמאל, ימין) משווה שני 'AggregateField `מקרים לשוויון.
aggregateQuerySnapshotEqual(שמאל, ימין) משווה בין שני מופעי AggregateQuerySnapshot לצורך שוויון. שני מופעי AggregateQuerySnapshot נחשבים "שווים" אם יש להם שאילתות בסיסיות המשוות שוות, ואותם נתונים.
queryEqual(שמאל, ימין) מחזירה true אם השאילתות שסופקו מצביעות על אותו אוסף ומחילות את אותם אילוצים.
refEqual(שמאל, ימין) מחזירה true אם ההפניות שסופקו שוות.
snapshotEqual(שמאל, ימין) מחזירה אמת אם התמונות שסופקו שוות.
פונקציה (מגבלה,...)
limit (limit) יוצר QueryLimitConstraint שמחזיר רק את המסמכים התואמים הראשונים.
limitToLast(limit) יוצר QueryLimitConstraint שמחזיר רק את המסמכים התואמים האחרונים. עליך לציין לפחות סעיף orderBy אחד עבור שאילתות limitToLast , אחרת ייגרם חריג במהלך הביצוע.
function(logLevel, ...)
setLogLevel(logLevel) מגדיר את המילוליות של יומני Cloud Firestore (ניפוי באגים, שגיאה או שקט).
function(n,...)
תוספת (n) מחזירה ערך מיוחד שניתן להשתמש בו עם setDoc() או updateDoc() שאומר לשרת להגדיל את הערך הנוכחי של השדה בערך הנתון. אם אופרנד או ערך השדה הנוכחי משתמשים בדיוק בנקודה צפה, כל האריתמטיקה עוקבת אחר סמנטיקה של IEEE 754. אם שני הערכים הם מספרים שלמים, ערכים מחוץ לטווח המספרים הבטוח של JavaScript ( Number.MIN_SAFE_INTEGER עד Number.MAX_SAFE_INTEGER ) נתונים גם הם לאובדן דיוק. יתר על כן, לאחר עיבוד על ידי הקצה האחורי של Firestore, כל פעולות המספרים השלמים מוגבלות בין -2^63 ל-2^63-1. אם ערך השדה הנוכחי אינו מסוג number , או אם השדה עדיין לא קיים, השינוי מגדיר את השדה לערך הנתון.
פונקציה (שאילתה,...)
getAggregateFromServer(query, aggregateSpec) מחשב את הצבירות שצוינו על המסמכים בערכת התוצאות של השאילתה הנתונה מבלי להוריד בפועל את המסמכים. השימוש בפונקציה זו לביצוע צבירה יעיל מכיוון שרק ערכי הצבירה הסופיים יורדים, לא נתוני המסמכים. פונקציה זו יכולה לבצע אגרגציות של המסמכים במקרים שבהם ערכת התוצאות היא גדולה עד בלתי אפשרית להורדה כולה (אלפי מסמכים). התוצאה שהתקבלה מהשרת מוצגת, ללא שינוי, ללא התחשבות במדינה מקומית כלשהי. כלומר, מסמכים במטמון המקומי אינם נלקחים בחשבון, וגם שינויים מקומיים שעדיין לא סונכרנו עם השרת. תוצאות שהורדו בעבר, אם ישנן, אינן בשימוש. כל הפעלת פונקציה זו כרוכה בהכרח בנסיעה הלוך ושוב לשרת.
getCountFromServer(שאילתה) מחשב את מספר המסמכים בערכת התוצאות של השאילתה הנתונה מבלי להוריד בפועל את המסמכים. שימוש בפונקציה זו לספירת המסמכים הוא יעיל מכיוון שרק הספירה הסופית יורדת, לא נתוני המסמכים. פונקציה זו יכולה לספור את המסמכים במקרים שבהם ערכת התוצאות היא גדולה עד כדי הורדה מלאה (אלפי מסמכים). התוצאה שהתקבלה מהשרת מוצגת, ללא שינוי, ללא התחשבות במדינה מקומית כלשהי. כלומר, מסמכים במטמון המקומי אינם נלקחים בחשבון, וגם שינויים מקומיים שעדיין לא סונכרנו עם השרת. תוצאות שהורדו בעבר, אם ישנן, אינן בשימוש. כל הפעלת פונקציה זו כרוכה בהכרח בנסיעה הלוך ושוב לשרת.
getDocs(שאילתה) מבצע את השאילתה ומחזיר את התוצאות כ- QuerySnapshot . הערה: getDocs() מנסה לספק נתונים עדכניים במידת האפשר על ידי המתנה לנתונים מהשרת, אך הוא עלול להחזיר נתונים במטמון או להיכשל אם אתה במצב לא מקוון ולא ניתן להגיע לשרת. כדי לציין התנהגות זו, הפעל את getDocsFromCache() או getDocsFromServer() .
getDocsFromCache(שאילתה) מבצע את השאילתה ומחזיר את התוצאות כ- QuerySnapshot מהמטמון. מחזירה ערכת תוצאות ריקה אם אין מסמכים התואמים לשאילתה כרגע במטמון.
getDocsFromServer(שאילתה) מבצע את השאילתה ומחזיר את התוצאות כ QuerySnapshot מהשרת. מחזיר שגיאה אם ​​הרשת אינה זמינה.
onSnapshot(שאילתה, צופה) מצרף מאזין לאירועי QuerySnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . ניתן לבטל את המאזין על ידי קריאה לפונקציה המוחזרת כאשר מתקשרים ל- onSnapshot . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
onSnapshot(שאילתה, אפשרויות, צופה) מצרף מאזין לאירועי QuerySnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . ניתן לבטל את המאזין על ידי קריאה לפונקציה המוחזרת כאשר מתקשרים ל- onSnapshot . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
onSnapshot(שאילתה, onNext, onError, onCompletion) מצרף מאזין לאירועי QuerySnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . ניתן לבטל את המאזין על ידי קריאה לפונקציה המוחזרת כאשר מתקשרים ל- onSnapshot . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
על תמונת מצב (שאילתה, אפשרויות, על הבא, על שגיאה, על השלמה) מצרף מאזין לאירועי QuerySnapshot . אתה יכול להעביר התקשרויות בודדות onNext ו- onError או להעביר אובייקט צופה יחיד עם התקשרות חוזרת next error . ניתן לבטל את המאזין על ידי קריאה לפונקציה המוחזרת כאשר מתקשרים ל- onSnapshot . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
query(query, compositeFilter, queryConstraints) יוצר מופע חדש בלתי ניתן לשינוי של Query שמורחב כך שיכלול גם אילוצי שאילתה נוספים.
query(query, queryConstraints) יוצר מופע חדש בלתי ניתן לשינוי של Query שמורחב כך שיכלול גם אילוצי שאילתה נוספים.
function(queryConstraints, ...)
and(queryConstraints) יוצר QueryCompositeFilterConstraint חדש שהוא שילוב של אילוצי המסנן הנתונים. מסנן צירוף כולל מסמך אם הוא עומד בכל המסננים הנתונים.
or(queryConstraints) יוצר QueryCompositeFilterConstraint חדש המהווה ניתוק של אילוצי המסנן הנתונים. מסנן ניתוק כולל מסמך אם הוא עומד באחד מהמסננים הנתונים.
פונקציה (הפניה, ...)
addDoc(הפניה, נתונים) הוסף מסמך חדש ל- CollectionReference שצוין עם הנתונים הנתונים, הקצה לו מזהה מסמך באופן אוטומטי.
אוסף (הפניה, נתיב, נתיבSegments) מקבל מופע CollectionReference המתייחס לתת-אוסף של reference בנתיב היחסי שצוין.
אוסף (הפניה, נתיב, נתיבSegments) מקבל מופע CollectionReference המתייחס לתת-אוסף של reference בנתיב היחסי שצוין.
deleteDoc (הפניה) מוחק את המסמך שאליו מתייחס DocumentReference שצוין.
doc(reference, path, pathSegments) מקבל מופע DocumentReference המתייחס למסמך בתוך reference בנתיב היחסי שצוין. אם לא צוין נתיב, מזהה ייחודי שנוצר אוטומטית ישמש עבור DocumentReference המוחזר.
doc(reference, path, pathSegments) מקבל מופע DocumentReference המתייחס למסמך בתוך reference בנתיב היחסי שצוין.
getDoc (הפניה) קורא את המסמך שאליו מתייחס DocumentReference זה. הערה: getDoc() מנסה לספק נתונים עדכניים במידת האפשר על ידי המתנה לנתונים מהשרת, אך הוא עלול להחזיר נתונים במטמון או להיכשל אם אתה במצב לא מקוון ולא ניתן להגיע לשרת. כדי לציין התנהגות זו, הפעל את getDocFromCache() או getDocFromServer() .
getDocFromCache (הפניה) קורא את המסמך שאליו מתייחס DocumentReference זה מהמטמון. מחזיר שגיאה אם ​​המסמך אינו שמור כעת.
getDocFromServer(הפניה) קורא את המסמך שאליו מתייחס DocumentReference זה מהשרת. מחזיר שגיאה אם ​​הרשת אינה זמינה.
onSnapshot (הפניה, צופה) מצרף מאזין לאירועי DocumentSnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
onSnapshot (הפניה, אפשרויות, צופה) מצרף מאזין לאירועי DocumentSnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
על תמונת מצב (הפניה, על הבא, על שגיאה, על השלמה) מצרף מאזין לאירועי DocumentSnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
על תמונת מצב (הפניה, אפשרויות, על הבא, בשגיאה, בהשלמה) מצרף מאזין לאירועי DocumentSnapshot . אתה יכול להעביר שיחות חוזרות onNext ו- onError בודדות או להעביר אובייקט צופה בודד עם התקשרויות next error . הערה: למרות שניתן לספק התקשרות חוזרת onCompletion , היא לעולם לא תיקרא כי זרם תמונת המצב אינו נגמר.
setDoc(הפניה, נתונים) כותב למסמך שאליו מתייחס DocumentReference זה. אם המסמך עדיין לא קיים, הוא ייווצר.
setDoc(הפניה, נתונים, אפשרויות) כותב למסמך שאליו מתייחס DocumentReference שצוין. אם המסמך עדיין לא קיים, הוא ייווצר. אם תספק merge או mergeFields , ניתן למזג את הנתונים שסופקו למסמך קיים.
updateDoc(הפניה, נתונים) מעדכן שדות במסמך שאליו מתייחס DocumentReference שצוין. העדכון ייכשל אם יוחל על מסמך שאינו קיים.
updateDoc(reference, field, value, moreFieldsAndValues) עדכון שדות במסמך שאליו מתייחס DocumentReference שצוין העדכון ייכשל אם יוחל על מסמך שאינו קיים. ניתן לעדכן שדות מקוננים על ידי מתן מחרוזות נתיב שדות מופרדות בנקודות או על ידי אספקת אובייקטי FieldPath .
פונקציה (הגדרות,...)
memoryLocalCache(הגדרות) יוצר מופע של MemoryLocalCache . ניתן להגדיר את המופע ל- FirestoreSettings.cache כדי לומר ל-SDK באיזו שכבת מטמון להשתמש.
memoryLruGarbageCollector(הגדרות) יוצר מופע של MemoryLruGarbageCollector . ניתן לציין גודל יעד כחלק מפרמטר ההגדרה. האספן יתחיל למחוק מסמכים ברגע שגודל המטמון חורג מהגודל הנתון. גודל המטמון המוגדר כברירת מחדל הוא 40MB (40*1024*1024 בתים).
persistentLocalCache(הגדרות) יוצר מופע של PersistentLocalCache . ניתן להגדיר את המופע ל- FirestoreSettings.cache כדי לומר ל-SDK באיזו שכבת מטמון להשתמש. לא ניתן להשתמש במטמון מתמשך בסביבת Node.js.
persistentSingleTabManager(הגדרות) יוצר מופע של PersistentSingleTabManager .
פונקציה (תמונת מצב,...)
endAt(תמונה) יוצר QueryEndAtConstraint שמשנה את ערכת התוצאה כך שתסתיים במסמך שסופק (כולל). מיקום הקצה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.
endBefore(תמונה) יוצר QueryEndAtConstraint שמשנה את התוצאה שתסתיים לפני המסמך שסופק (בלעדי). מיקום הקצה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.
startAfter (תמונה) יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה להתחיל אחרי המסמך שסופק (בלעדי). מיקום ההתחלה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.
startAt(תמונה) יוצר QueryStartAtConstraint שמשנה את ערכת התוצאות כדי להתחיל במסמך שסופק (כולל). מיקום ההתחלה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו לפי orderBy לפי שאילתה זו.

שיעורים

מעמד תיאור
שדה מצטבר מייצג צבירה שניתן לבצע על ידי Firestore.
AggregateQuerySnapshot התוצאות של ביצוע שאילתת צבירה.
בתים אובייקט בלתי ניתן לשינוי המייצג מערך של בתים.
הפניה לאוסף ניתן להשתמש באובייקט CollectionReference להוספת מסמכים, קבלת הפניות למסמכים ושאילתה למסמכים (באמצעות query() ).
הפניה למסמך DocumentReference מתייחס למיקום מסמך במסד נתונים של Firestore וניתן להשתמש בו כדי לכתוב, לקרוא או להאזין למיקום. המסמך במיקום הנזכר יכול להיות קיים או לא.
DocumentSnapshot תמונת DocumentSnapshot מכילה נתונים שנקראו ממסמך במסד הנתונים של Firestore. ניתן לחלץ את הנתונים עם .data() או .get(<field>) כדי לקבל שדה ספציפי. עבור DocumentSnapshot המצביע על מסמך לא קיים, כל גישה לנתונים תחזיר 'לא מוגדר'. אתה יכול להשתמש בשיטת exists() כדי לאמת במפורש את קיומו של מסמך.
FieldPath FieldPath מתייחס לשדה במסמך. הנתיב עשוי להיות מורכב משם שדה בודד (המתייחס לשדה ברמה העליונה במסמך), או רשימה של שמות שדות (המתייחס לשדה מקונן במסמך). צור FieldPath על ידי מתן שמות שדות. אם מסופק יותר משם שדה אחד, הנתיב יצביע על שדה מקונן במסמך.
FieldValue ערכי זקיף שניתן להשתמש בהם בעת כתיבת שדות מסמך עם set() או update() .
Firestore ממשק השירות Cloud Firestore. אל תתקשר ישירות לבנאי זה. במקום זאת, השתמש ב-getFirestore() .
FirestoreError שגיאה שהוחזרה על ידי פעולת Firestore.
GeoPoint אובייקט בלתי ניתן לשינוי המייצג מיקום גיאוגרפי ב-Firestore. המיקום מיוצג כזוג קווי רוחב/קו אורך. ערכי קו הרוחב נמצאים בטווח של [-90, 90]. ערכי קו האורך הם בטווח של [-180, 180].
LoadBundleTask מייצג את המשימה של טעינת חבילת Firestore. הוא מספק התקדמות של טעינת החבילות, כמו גם השלמת משימה ואירועי שגיאה. ה-API תואם ל- Promise<LoadBundleTaskProgress> .
PersistentCacheIndexManager PersistentCacheIndexManager לקביעת תצורה של אינדקסי מטמון קבועים המשמשים לביצוע שאילתה מקומית. כדי להשתמש, התקשר ל- getPersistentCacheIndexManager() כדי לקבל מופע.
שאילתא Query מתייחסת לשאילתה שתוכל לקרוא או להאזין לה. אתה יכול גם לבנות אובייקטי Query מעודנים על ידי הוספת מסננים וסדר.
QueryCompositeFilterConstraint QueryCompositeFilterConstraint משמש לצמצום קבוצת המסמכים המוחזרת על ידי שאילתת Firestore על ידי ביצוע OR או AND הלוגיים של QueryFieldFilterConstraint מרובים s או QueryCompositeFilterConstraint ס. QueryCompositeFilterConstraint s נוצרים על ידי הפעלת או() או ו() ואז ניתן להעביר אותם ל- query() כדי ליצור מופע שאילתה חדש המכיל גם את QueryCompositeFilterConstraint .
QueryConstraint QueryConstraint משמש לצמצום קבוצת המסמכים המוחזרת על ידי שאילתת Firestore. QueryConstraint s נוצרים על ידי הפעלת where() , מיין לפי() , מתחיל ב() , startAfter() , endBefore() , נגמר ב() , limit() , limitToLast() ולאחר מכן ניתן להעביר אותו אל query() כדי ליצור מופע שאילתה חדש המכיל גם את QueryConstraint זה.
QueryDocumentSnapshot QueryDocumentSnapshot מכיל נתונים שנקראו ממסמך במסד הנתונים של Firestore שלך ​​כחלק משאילתה. מובטח שהמסמך קיים וניתן לחלץ את הנתונים שלו באמצעות .data() או .get(<field>) כדי לקבל שדה ספציפי. QueryDocumentSnapshot מציע את אותו משטח API כמו DocumentSnapshot . מכיוון שתוצאות השאילתה מכילות רק מסמכים קיימים, המאפיין exists תמיד יהיה true ו- data() לעולם לא יחזיר 'undefined'.
QueryEndAtConstraint QueryEndAtConstraint משמש כדי לא לכלול מסמכים מהסוף של ערכת תוצאות המוחזרת על ידי שאילתת Firestore. s QueryEndAtConstraint נוצרים על ידי הפעלת endAt() או endBefore() ולאחר מכן ניתן להעביר אותם אל query() כדי ליצור מופע שאילתה חדש המכיל גם את QueryEndAtConstraint זה.
QueryFieldFilterConstraint QueryFieldFilterConstraint משמש לצמצום קבוצת המסמכים המוחזרת על ידי שאילתת Firestore על ידי סינון על שדה מסמך אחד או יותר. QueryFieldFilterConstraint s נוצרים על ידי הפעלת where() ואז ניתן להעביר אותם ל- query() כדי ליצור מופע שאילתה חדש המכיל גם QueryFieldFilterConstraint זה.
QueryLimitConstraint QueryLimitConstraint משמש להגבלת מספר המסמכים המוחזרים על ידי שאילתת Firestore. QueryLimitConstraint s נוצרים על ידי הפעלת limit() או limitToLast() ולאחר מכן ניתן להעביר אותם אל query() כדי ליצור מופע שאילתה חדש המכיל גם QueryLimitConstraint זה.
QueryOrderByConstraint QueryOrderByConstraint משמש למיון קבוצת המסמכים המוחזרת על ידי שאילתת Firestore. QueryOrderByConstraint S נוצרים על ידי קריאת מסדרבי () ואז ניתן להעביר אותם לשאילתה () כדי ליצור מופע שאילתה חדש המכיל גם QueryOrderByConstraint זה. הערה: מסמכים שאינם מכילים את שדה ההזמנה לא יהיו קיימים בתוצאת השאילתה.
Querysnapshot QuerySnapshot מכיל אובייקטים של אפס או יותר מסמכים DocumentSnapshot המייצגים את תוצאות השאילתה. ניתן לגשת למסמכים כמערך דרך מאפיין docs או למנות בשיטת forEach . ניתן לקבוע את מספר המסמכים באמצעות המאפיינים empty size .
QueryStartatConstraint QueryStartAtConstraint משמש כדי לא לכלול מסמכים מתחילת התוצאה שהוחזר על ידי שאילתת Firestore. QueryStartAtConstraint S נוצרים על ידי קריאת Startat () או StartAfter () ואז ניתן להעביר אותם לשאילתה () כדי ליצור מופע שאילתה חדש המכיל גם QueryStartAtConstraint .
SNAPSHOTMETADATA מטא נתונים על תמונת מצב, המתארים את מצב התמונת המצב.
חותמת זמן Timestamp מייצגת נקודת זמן ללא תלות בכל אזור זמן או לוח שנה, המיוצגת כשניות ושברים של שניות ברזולוציה של ננו -שניות בזמן EPOCH UTC. הוא מקודד באמצעות לוח השנה הגרגוריאני הפרוטפטי המרחיב את לוח השנה הגרגוריאני לאחור לשנה הראשונה. זה מקודד בהנחה שכל הדקות אורכו 60 שניות, כלומר שניות קפיצות הן "מרוחות" כך שלא נדרשת טבלה שנייה קפיצה לפרשנות. הטווח הוא בין 0001-01-01T00: 00: 00Z ל- 9999-12-31T23: 59: 59.999999999z. לדוגמאות ומפרטים נוספים, עיין בהגדרת חותמת הזמן .
עִסקָה התייחסות לעסקה. אובייקט Transaction המועבר updateFunction של עסקה מספק את השיטות לקריאה וכתבת נתונים בהקשר של העסקה. ראה Runtransaction () .
Writbatch אצווה כתיבה, המשמשת לביצוע כתיבה מרובה כיחידה אטומית יחידה. ניתן לרכוש אובייקט WriteBatch על ידי התקשרות לכתיבה () . הוא מספק שיטות להוספת כתיבה לאצוות הכתיבה. אף אחד מהכתבים לא יבוצע (או נראה מקומי) עד שנקרא WriteBatch.commit () .

ממשקים

מִמְשָׁק תיאור
אגרגטים מציין קבוצה של אגרגציות וכינויים שלהם.
DocumentChange DocumentChange מייצג שינוי במסמכים התואמים לשאילתה. הוא מכיל את המסמך שנפגע וסוג השינוי שהתרחש.
DocumentData מסמך נתוני (לשימוש עם setDoc () ) מורכב משדות הממופים לערכים.
ניסוי אלו -סלוליות אפשרויות המגדירות את התצורה של הובלת הרשת הבסיסית של SDK (WebChannel) בעת השימוש בזיהום ארוך. הערה: ממשק זה הוא "ניסיוני" והוא נתון לשינוי. ראו FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling ו- FirestoreSettings.experimentalLongPollingOptions .
Firestoredataconverter ממיר המשמש את withConverter() כדי להפוך אובייקטים של משתמשים מסוג AppModelType לנתוני FireStore מסוג DbModelType . השימוש בממיר מאפשר לך לציין טיעונים מסוג גנרי בעת אחסון ואחזור אובייקטים מ- Firestore. בהקשר זה, "דוגמנית APP" היא מחלקה המשמשת ביישום לאריזת מידע ופונקציונליות קשורים זה לזה. מחלקה כזו יכולה, למשל, להיות בעלי תכונות עם סוגי נתונים מורכבים ומקוננים, מאפיינים המשמשים לתמורה, מאפיינים של סוגים שאינם נתמכים על ידי Firestore (כגון symbol bigint ) ופונקציות עוזרות המבצעות פעולות מורכבות. שיעורים כאלה אינם מתאימים ו/או אפשריים לאחסן למסד נתונים של FireStore. במקום זאת, יש להמיר מקרים של שיעורים כאלה ל"חפצי JavaScript ישנים רגילים "(Pojos) עם תכונות פרימיטיביות בלעדיות, שעלולות להיות מקוננות בתוך פוג'וס או מערכים אחרים של פוג'וס. בהקשר זה, סוג זה מכונה "DBModel" ויהיה אובייקט המתאים להתמדה לפירסטורה. מטעמי נוחות, יישומים יכולים ליישם FirestoreDataConverter ולרשם את הממיר עם אובייקטים של Firestore, כגון DocumentReference או Query , כדי להמיר אוטומטית AppModel ל- DbModel בעת אחסון FireStore, ולהמיר DbModel ל- AppModel בעת השחרור מ- Firestore.
FireStoresettings מציין תצורות מותאמות אישית למופע ענן Firestore שלך. עליכם להגדיר את אלה לפני שתקראו שיטות אחרות.
אינדקס (בטא) הגדרת SDK של מדד FireStore.
IndexConfiguration (בטא) רשימה של אינדקסים של Firestore כדי להאיץ את ביצוע השאילתה המקומית. ראה פורמט JSON לתיאור הפורמט של הגדרת האינדקס.
אינדקספילד (בטא) אלמנט שדה יחיד בתצורת אינדקס.
LoadBundletaskProgress מייצג עדכון התקדמות או מצב סופי מתוך טעינה של חבילות.
MemoryCacheSettings אובייקט הגדרות להגדרת תצורה של מופע MemoryLocalCache .
RemoryeAggrgarBageCollector אספן זבל מוחק מסמכים בכל פעם שהם אינם חלק משאילתות פעילות, ואין להן מוטציות מקומיות. אספן זה מנסה להבטיח טביעות רגל זיכרון נמוכות ביותר מ- SDK, בסיכון לכך שמסמכים לא יישמרו במטמון בשאלות לא מקוונות או לשאלות ישירות למטמון. השתמש בפונקציית מפעל כדי ליצור מופע של אספן זה.
MemoryLocalCache מספק מטמון זיכרון ל- SDK. זהו מטמון ברירת המחדל אלא אם כן מוגדר באופן מפורש אחרת. לשימוש, צור מופע באמצעות פונקציית המפעל, ואז הגדר את המופע ל- FirestoreSettings.cache והתקשר ל- initializeFirestore באמצעות אובייקט ההגדרות.
MemoryLrugarbageCollector אספן זבל מוחק את המסמכים המשומשים ביותר בפחות באצוות מרובות. אספן זה מוגדר עם גודל יעד, ויבצע רק אוסף כאשר המסמכים במטמון חורגים מגודל היעד. הוא נמנע משאילתת Backend שחוזרת על עצמה לאותה שאילתה או מסמך, בסיכון שיש טביעת רגל זיכרון גדולה יותר. השתמש בפונקציית המפעל כדי ליצור מופע של אספן זה.
התמדה הגדרות שניתן להעביר כדי לאפשר enableIndexedDbPersistence() להגדיר את התמדה של Firestore. לא ניתן להשתמש בהתמדה בסביבת Node.js.
AssistentCachesettings הגדרות אובייקט להגדרת תצורה של מופע PersistentLocalCache . לא ניתן להשתמש במטמון מתמשך בסביבת Node.js.
PersistentLocalcache מספק מטמון מתמשך המגובה על ידי IndexedDB ל- SDK. לשימוש, צור מופע באמצעות פונקציית המפעל, ואז הגדר את המופע ל- FirestoreSettings.cache והתקשר ל- initializeFirestore באמצעות אובייקט ההגדרות.
PersistentMultipletabManager מנהל כרטיסיות התומך בכרטיסיות מרובות. SDK תסנכרן שאילתות ומוטציות שנעשו בכל הכרטיסיות באמצעות SDK.
משוכנע בביצוע מנהל כרטיסיות התומך בכרטיסייה אחת בלבד, שום סנכרון לא יבוצע על פני כרטיסיות.
משכורות משוכנעות הקלד להגדרת תצורה של מופע PersistentSingleTabManager .
SnapShotListenOptions אובייקט אפשרויות שניתן להעביר ל- OnsNapshot () ו- Querysnapshot.docchanges () כדי לשלוט באילו סוגים של שינויים לכלול במערך התוצאות.
תמונת מצב אפשרויות שמגדירות את התצורה של נתונים מאוחסנים מ- DocumentSnapshot (למשל ההתנהגות הרצויה עבור חותמות זמן שרת שטרם הוגדרו לערכם הסופי).
פעולות עסקאות אפשרויות להתאמה אישית של התנהגות עסקה.
בטל את הרישום פונקציה שהוחזרה על ידי onSnapshot() המסלקת את המאזין כאשר היא מופעלת.

משתנים

מִשְׁתַנֶה תיאור
Cache_size_unlimited יש להשבית קבוע המשמש לציון איסוף האשפה של LRU. הגדר ערך זה כ- cacheSizeBytes על ההגדרות שהועברו למופע Firestore .

סוגים סוגים

סוג כינוי תיאור
AddPrefixTokeys מחזירה מפה חדשה בה כל מפתח מקודם עם המפתח החיצוני המצורף לנקודה.
אגרגטפילדפייט האיגוד של כל סוגי AggregateField הנתמכים על ידי Firestore.
אגרגטטים סוג שמפתחותיו נלקחים מ- AggregateSpec , וערכיו הם תוצאה של הצבירה שבוצעה על ידי AggregateField המתאים מה- AggregateSpec הקלט.
AggregAteType סוג האיחוד המייצג את סוג המצטבר שיש לבצע.
ChildUpdateFields עוזר לחישוב השדות המקוננים עבור סוג נתון T1. זה נחוץ כדי להפיץ סוגי איגוד כמו undefined | {...} (קורה עבור אבזרים אופציונליים) או {a: A} | {b: B} . במקרה זה, V משמש להפצת סוגי האיחוד של T[K] Record , מכיוון ש- T[K] מוערך כביטוי ולא מופץ. ראו https://www.typescriptlang.org/docs/handbook/advanced-types.html#distribuling-conditional-tys
DocumentChangetype ניתן להוסיף את סוג ה- DocumentChange ',' להסיר 'או' שינוי '.
FirestoreErrorCode קבוצת קודי המצב של Firestore. הקודים זהים אלה שנחשפו על ידי GRPC כאן: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md ערכים אפשריים: - 'בוטל': הפעולה בוטלה (בדרך כלל על ידי המתקשר). - 'לא ידוע': שגיאה לא ידועה או שגיאה מתחום שגיאות אחר. - 'מסמך לא חוקי': הלקוח ציין טיעון לא חוקי. שים לב שזה שונה מ'הליכה כושלת '. 'לא חוקי-טיעון' מציין טיעונים שהם בעייתיים ללא קשר למצב המערכת (למשל שם שדה לא חוקי). - 'Deadyly-exceepty': המועד האחרון שפג תוקף לפני שהמבצע יכול היה להשלים. עבור פעולות המשנות את מצב המערכת, שגיאה זו עשויה להיות מוחזרת גם אם הפעולה הושלמה בהצלחה. לדוגמה, תגובה מוצלחת משרת הייתה יכולה להתעכב מספיק זמן כדי שתפוג המועד האחרון. - 'לא נולד': לא נמצא כמה מסמך מבוקש. - 'כבר קיימים': איזה מסמך שניסינו ליצור כבר קיים. - 'דויף הרשאה': למתקשר אין אישור לבצע את הפעולה שצוינה. -'התפשטות משאבים': משאב כלשהו היה מותש, אולי מכסה למשתמש, או אולי מערכת הקבצים כולה אינה מחוץ לחלל. - 'תנועה כושלת': הפעולה נדחתה מכיוון שהמערכת אינה במצב הנדרש לביצוע הפעולה. - 'בוטל': המבצע הופסק, בדרך כלל בגלל סוגיה במקביל כמו הפסקות עסקאות וכו '-' מחוץ לטווח ': הפעולה נעברה על פני הטווח התקף. - 'לא יישום': הפעולה אינה מיושמת או לא נתמכת/מופעלת. - 'פנימי': שגיאות פנימיות. פירושו של חלק מהבלטים הצפויים על ידי המערכת הבסיסית נשברה. אם אתה רואה אחת מהטעויות הללו, משהו מאוד שבור. - 'לא זמין': השירות אינו זמין כרגע. ככל הנראה זהו מצב חולף ועשוי לתקן על ידי ניסיון חוזר עם גב. - 'אובדן נתונים': אובדן נתונים או שחיתות בלתי ניתנים לשחזור. - 'לא מאומת': לבקשה אין אישורי אימות תקפים לפעולה.
FirestoreLocalcache סוג האיחוד מכל שכבת המטמון הנתמכת של SDK.
מקרין את המקור תאר את המקור שאילתה מקשיבה אליו. הגדר כברירת default להאזנה לשינויי מטמון וגם לשינויים בשרת. הגדר cache כדי להאזין לשינויים במטמון בלבד.
MemoryGarBageCollector סוג האיחוד מכל תמיכה באספני Gabage למטמון מקומי זיכרון.
NestedUpdateFields עבור כל שדה (למשל 'סרגל'), מצא את כל המפתחות המקוננים (למשל { 'Bar.baz': T1, 'Bar.Qux': T2 } ). צטלבים אותם יחד כדי ליצור מפה אחת המכילה את כל המפתחות האפשריים שכולם מסומנים כ-
סדר ByDirection הכיוון של סעיף סדר () מוגדר כ'- DESC 'או' ASC '(יורד או עולה).
PartialWithFieldValue בדומה ל Partial<T> של TypeScript, אך מאפשר להשמיט שדות מקוננים ולהעביר ערכי שדה כערכי רכוש.
PersistentTabManager איחוד של כל מנהלי הכרטיסיות הזמינים.
פְּרִימִיטִיבִי סוגים פרימיטיביים.
QueryConstraintyPe מתאר את אילוצי השאילתה השונים הזמינים ב- SDK זה.
QueryFilterConstraint QueryFilterConstraint הוא סוג של איחוד עוזר המייצג את QueryfieldFilterConstraint ו- QueryCompositefilterconstraint .
QueryNonfilterConstraint QueryNonFilterConstraint הוא סוג של איחוד עוזר המייצג את קוני הקריאנים המשמשים לצמצום או להזמין את מערך המסמכים, אך שאינם מסננים במפורש בשדה מסמכים. QueryNonFilterConstraint S נוצרים על ידי קריאת מסדרבי () , מתחיל ב() , startafter () , endbest () , נגמר ב() , Limit () או Limittolast () ואז ניתן להעביר אותו לשאילתה () כדי ליצור מופע שאילתה חדש המכיל גם את QueryConstraint .
SetOptions אובייקט אפשרויות המגדיר את התנהגות SetDoc () , ושיחות. ניתן להגדיר שיחות אלה לביצוע מיזוג גרגירי במקום להחליף את מסמכי היעד בשלמותם על ידי מתן SetOptions עם merge: true .
משימות מייצג את מצב משימות העמסת הצרור. גם 'שגיאה' וגם 'הצלחה' שוקעים מצב: המשימה תבטל או תושלם ולא יהיו עוד עדכונים לאחר שדווחו עליהם.
Unumentextersection בהינתן סוג איחוד U = T1 | T2 | ... , מחזיר סוג מצולם (T1 & T2 & ...) . משתמש בסוגי התנאים ומסקנות מהפצות מסוגים מותנים. זה עובד מכיוון שמועמדים מרובים לאותו משתנה בסוג בעמדות משתנות קונסטר-משתנות גורמות להסיק על סוג צומת. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-to-to-intersection -סוּג
עדכן מידע עדכן נתוני (לשימוש עם additedoc () ) זה מורכב מנתיבי שדה (למשל 'foo' או 'foo.baz') ממופים לערכים. שדות המכילים נקודות התייחסות מקוננות בשדות מקוננים בתוך המסמך. ניתן להעביר ערכי שדה כערכי רכוש.
איפה פילטרופ תנאי סינון בסעיף היכן () מוגדרים באמצעות המיתרים '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'מערך מכילים' , 'בתוך', 'מערך מכילים כל', ו'לא-אין '.
עם ערך שדה מאפשר להעביר ערכי שדה כערך נכס תוך שמירה על בטיחות הסוג.

פונקציה (אפליקציה, ...)

getFirestore (אפליקציה)

מחזיר את מופע ה- Firestore הקיים הקיים שקשור ל- FirebaseApp המסופק . אם אין מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

export declare function getFirestore(app: FirebaseApp): Firestore;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה Firebaseapp המופע Firebaseapp אליו קשור למופע FireStore שהוחזר.

החזרות:

Firestore

המופע המוגדר כברירת מחדל של האפליקציה המסופקת.

getFirestore (אפליקציה, בסיס נתונים)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות על סמך משוב שאנו מקבלים. אל תשתמש בממשק API זה בסביבת ייצור.

מחזיר את המופע הקיים בשם Firestore שקשור ל- FirebaseApp המסופק . אם אין מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה Firebaseapp המופע Firebaseapp אליו קשור למופע FireStore שהוחזר.
DataBaseID חוּט שם מסד הנתונים.

החזרות:

Firestore

מופע ה- Firestore שנקבע של האפליקציה שסופקה.

initializefirestore (אפליקציה, הגדרות, מסד נתונים)

אתחל מופע חדש של Firestore עם ההגדרות שסופקו. ניתן לקרוא רק לפני כל פונקציה אחרת, כולל getFirestore () . אם ההגדרות המותאמות אישית ריקות, פונקציה זו שקולה להתקשר ל- GetFirestore () .

חֲתִימָה:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה Firebaseapp ה- Firebaseapp שאיתו ישויך מופע FireStore .
הגדרות FireStoresettings הגדרות אובייקט להגדרת תצורה של מופע FireStore .
DataBaseID חוּט שם מסד הנתונים.

החזרות:

Firestore

מופע של FireStore חדש שאותחל.

פונקציה (Firestore, ...)

ClearIndexedDbpersistence (Firestore)

מנקה את האחסון המתמשך. זה כולל כותבים ממתינים ומסמכים במטמון.

יש לקרוא לו בזמן שמופע FireStore לא מתחיל (לאחר סיום האפליקציה או כאשר האפליקציה מאתחל לראשונה). בעת ההפעלה, יש לקרוא לפונקציה זו לפני פונקציות אחרות (מלבד initicalizefirestore () או getFirestore () )). אם מופע FireStore עדיין פועל, ההבטחה תידחה עם קוד השגיאה של failed-precondition .

חֲתִימָה:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע FireStore לנקות את ההתמדה.

החזרות:

הבטחה <void>

Promise שנפתרת כאשר האחסון המתמשך מפונה. אחרת, ההבטחה נדחתה בטעות.

אוסף (Firestore, Path, PathSegments)

מקבל מופע CollectionReference המתייחס לאוסף בדרך המוחלטת שצוינה.

חֲתִימָה:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore התייחסות למופע השורש Firestore .
נָתִיב חוּט מסלול מופרד נלאה לאוסף.
PathSegments חוּט[] קטעי נתיב נוספים ליישום יחסית לטיעון הראשון.

החזרות:

CollectionReference < DocumentData , DocumentData >

מופע ה- CollectionReference .

חריגים

אם לנתיב הסופי יש מספר שווה של קטעים ואינו מצביע על אוסף.

CollectionGroup (Firestore, CollectionId)

יוצר ומחזיר מופע Query חדש הכולל את כל המסמכים בבסיס הנתונים הכלולים באוסף או באיסוף משנה עם collectionId .

חֲתִימָה:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore התייחסות למופע השורש Firestore .
אוסף חוּט מזהה את האוספים לשאילתה. כל אוסף או איסוף משנה עם מזהה זה כקטע האחרון בדרכו ייכלל. לא יכול להכיל סלאש.

החזרות:

שאילתא < DocumentData , DocumentData >

Query שנוצרה .

ConnectfirestoreEmulator (Firestore, מארח, יציאה, אפשרויות)

שנה מופע זה כדי לתקשר עם אמולטור הענן Firestore.

חֲתִימָה:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע Firestore להגדרת התצורה להתחבר לאמולטור.
מנחה חוּט מארח האמולטור (למשל: localhost).
נמל מספר יציאת האמולטור (EX: 9000).
אפשרויות {mockusertoken ?: emulatormocktokenoptions | חוּט; }

החזרות:

בָּטֵל

עבודות השביה (Firestore)

מבטל את השימוש ברשת למופע זה. ניתן לאפשר זאת מחדש באמצעות enablenetwork () . בעוד שהרשת מושבתת, כל מאזיני תמונת המצב, getDoc() או שיחות getDocs() יחזירו תוצאות ממטמון, וכל פעולות כתיבה תועבר עד לשחזור הרשת.

חֲתִימָה:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

הבטחה <void>

Promise שנפתרת ברגע שהרשת הושבתו.

דוק (Firestore, Path, PathSegments)

מקבל מופע DocumentReference המתייחס למסמך בדרך המוחלטת שצוינה.

חֲתִימָה:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore התייחסות למופע השורש Firestore .
נָתִיב חוּט נתיב מופרד סלאש למסמך.
PathSegments חוּט[] קטעי נתיב נוספים שייושמו יחסית לטיעון הראשון.

החזרות:

DocumentReference < DocumentData , DocumentData >

מופע DocumentReference .

חריגים

אם לנתיב הסופי יש מספר משונה של קטעים ואינו מצביע על מסמך.

enableIndexedDbperSistence (Firestore, התמדה)

פונקציה זו תוסר במהדורה עיקרית עתידית. במקום זאת, הגדר FirestoreSettings.localCache למופע של PersistentLocalCache כדי להפעיל את המטמון של IndexEddb. קריאה לפונקציה זו כאשר FirestoreSettings.localCache כבר מוגדרת תזרוק חריג.

ניסיונות לאפשר אחסון מתמשך, במידת האפשר.

בכישלון, enableIndexedDbPersistence() ידחה את ההבטחה או יזרוק חריג. ישנן כמה סיבות לכך שזה יכול להיכשל, שניתן לזהות אותו על ידי code בשגיאה.

* תנועה כושלת: האפליקציה כבר פתוחה בכרטיסייה דפדפן אחרת. * לא יישום: הדפדפן אינו תואם את יישום ההתמדה הלא מקוון.

שים לב שגם לאחר כישלון, מופע Firestore יישאר שמיש, עם זאת התמדה לא מקוונת תהיה מושבתת.

לא ניתן להשתמש בהתמדה בסביבת Node.js.

חֲתִימָה:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע FireStore המאפשר התמדה.
התמדה התמדה הגדרות אופציונליות אובייקט להגדרת התמדה.

החזרות:

הבטחה <void>

Promise המייצגת בהצלחה אחסון מתמשך.

enablemultitabindexeddbpersistence (firestore)

פונקציה זו תוסר במהדורה עיקרית עתידית. במקום זאת, הגדר FirestoreSettings.localCache למופע של PersistentLocalCache כדי להפעיל את המטמון של IndexEddb. קריאה לפונקציה זו כאשר FirestoreSettings.localCache כבר מוגדרת תזרוק חריג.

ניסיונות לאפשר אחסון מתמשך רב-טאב, במידת האפשר. אם מופעל בכל הכרטיסיות, כל הפעולות חולקות גישה להתמדה מקומית, כולל ביצוע משותף של שאילתות ועדכוני מסמכים מקומיים המופנים על ידי חביון בכל המקרים המחוברים.

בכישלון, enableMultiTabIndexedDbPersistence() ידחה את ההבטחה או יזרוק חריג. ישנן כמה סיבות לכך שזה יכול להיכשל, שניתן לזהות אותו על ידי code בשגיאה.

* תנועה כושלת: האפליקציה כבר פתוחה בכרטיסייה דפדפן אחרת ו- Multi-Tab אינו מופעל. * לא יישום: הדפדפן אינו תואם את יישום ההתמדה הלא מקוון.

שים לב שגם לאחר כישלון, מופע Firestore יישאר שמיש, עם זאת התמדה לא מקוונת תהיה מושבתת.

חֲתִימָה:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע FireStore המאפשר התמדה.

החזרות:

הבטחה <void>

Promise המייצגת בהצלחה אחסון מתמשך.

enablenetwork (firestore)

לאפשר מחדש את השימוש ברשת למופע זה של Firestore לאחר שיחה קודמת ל- DisableNetwork () .

חֲתִימָה:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

הבטחה <void>

Promise שנפתרת לאחר הפעלת הרשת.

getPersistentCacheIndexManager (Firestore)

מחזיר את מנהל האינדקס PersistentCache המשמש את האובייקט הנתון Firestore .

המופע PersistentCacheIndexManager , או null אם אחסון מתמשך מקומי אינו בשימוש.

חֲתִימָה:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

Persistentcacheindexmanager | ריק

Boadbundle (Firestore, Bundledata)

טוען צרור FireStore למטמון המקומי.

חֲתִימָה:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע FireStore לטעינת צרורות עבור.
Bundledata Readablestream <uint8array> | ArrayBuffer | חוּט אובייקט המייצג את הצרור שיש לטעון. אובייקטים תקפים הם ArrayBuffer , ReadableStream<Uint8Array> או string .

החזרות:

LoadBundletask

אובייקט LoadBundleTask , המודיע למתקשרים עם עדכוני התקדמות, ואירועי השלמה או שגיאה. זה יכול לשמש Promise<LoadBundleTaskProgress> .

בשם Query (Firestore, שם)

קוראת שאילתת Firestore מהמטמון המקומי, המזוהה בשם הנתון.

השאילתות הנקובות נארזות בצרורות בצד השרת (יחד עם מסמכים מתקבלים), ונטענים למטמון מקומי באמצעות loadBundle . פעם אחת במטמון מקומי, השתמש בשיטה זו כדי לחלץ שאילתה בשם.

חֲתִימָה:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע Firestore לקרוא את השאילתה ממנו.
שֵׁם חוּט שם השאילתה.

החזרות:

הבטחה < שאילתה | null>

Promise שנפתרת עם השאילתה או null .

OnsnapshotsInsync (Firestore, Observer)

מצרף מאזין לאירוע תמונות בתצלום. האירוע בתצלום התמונות בסינכרון מציין כי כל המאזינים שנפגעו משינוי נתון פוטרו, גם אם שינוי יחיד שנוצר על ידי שרת משפיע על מאזינים מרובים.

הערה: האירוע בתצלום התמונות בסינכרון רק מציין שהמאזינים מסונכרנים זה עם זה, אך אינו מתייחס לשאלה אם תמונות אלה מסונכרנות עם השרת. השתמש בתמונת SnapshotMetadata אצל המאזינים הבודדים כדי לקבוע אם תמונת מצב היא מהמטמון או מהשרת.

חֲתִימָה:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore המופע של Firestore לסנכרון תמונות תמונות.
מַשׁקִיף {הבא?: (ערך: void) => void; שגיאה?: (שגיאה: firestoreerror ) => בטל; שלם?: () => void; } אובייקט יחיד המכיל התקשרות חוזרת next error .

החזרות:

בטל את הרישום

פונקציית ביטול הרשמה שניתן לקרוא לבטל את המאזין לתמונת המצב.

OnsnapshotsInsync (Firestore, Onsync)

מצרף מאזין לאירוע תמונות בתצלום. האירוע בתצלום התמונות בסינכרון מציין כי כל המאזינים שנפגעו משינוי נתון פוטרו, גם אם שינוי יחיד שנוצר על ידי שרת משפיע על מאזינים מרובים.

הערה: האירוע בתצלום התמונות בסינכרון רק מציין שהמאזינים מסונכרנים זה עם זה, אך אינו מתייחס לשאלה אם תמונות אלה מסונכרנות עם השרת. השתמש SnapshotMetadata אצל המאזינים הבודדים כדי לקבוע אם תמונת מצב היא מהמטמון או מהשרת.

חֲתִימָה:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע Firestore לסנכרון תמונות תמונות.
Onsync () => בטל התקשרות חוזרת להיקרא בכל פעם שכל מאזיני תמונת המצב מסונכרנים זה עם זה.

החזרות:

בטל את הרישום

פונקציית ביטול הרשמה שניתן לקרוא לבטל את המאזין לתמונת המצב.

Runtransaction (Firestore, UpdateFunction, אפשרויות)

מבצע את ה- updateFunction הנתון ואז מנסה לבצע את השינויים המופעלים בעסקה. אם כל מסמך שנקרא בעסקה השתנה, Cloud Firestore נמסר מחדש את ה- updateFunction . אם זה לא מצליח להתחייב לאחר 5 ניסיונות, העסקה נכשלת.

המספר המרבי של הכתיבים המותרים בעסקה יחידה הוא 500.

חֲתִימָה:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore התייחסות למסד הנתונים של FireStore להפעלת עסקה זו נגד.
UpdateFunction (עסקה: עסקה ) => הבטחה <T> הפונקציה לביצוע בהקשר העסקה.
אפשרויות פעולות עסקאות אובייקט אפשרויות לקביעת התצורה של מספר מקסימלי של ניסיונות להתחייב.

החזרות:

הבטחה <T>

אם העסקה הושלמה בהצלחה או שהופלה במפורש ( updateFunction updateFunction מוחזר כאן. אחרת, אם העסקה נכשלה, מוחזרת הבטחה שנדחתה עם שגיאת הכישלון המתאימה.

setIndexConfiguration (Firestore, תצורה)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות על סמך משוב שאנו מקבלים. אל תשתמש בממשק API זה בסביבת ייצור.

במקום ליצור אינדקסים של מטמון באופן ידני, שקול להשתמש ב- enablePersistentCacheIndexAutoCreation() לאפשר ל- SDK להחליט אם ליצור אינדקסים של מטמון לשאילתות הפועלות באופן מקומי.

מגדיר אינדקס לביצוע שאילתה מקומית. כל תצורת אינדקס קודמת מבוצעת. Promise נפתרת לאחר שתתמיד תצורת האינדקס.

ערכי האינדקס עצמם נוצרים באופן אסינכרוני. אתה יכול להמשיך להשתמש בשאילתות הדורשות אינדקס גם אם המדדים עדיין אינם זמינים. ביצוע השאילתה יתחיל אוטומטית להשתמש באינדקס לאחר כתיבת רשומות האינדקס.

אינדקסים נתמכים רק בהתמדה באינדקסדב. אם IndexedDB אינו מופעל, מתעלמים מתצורת אינדקס כלשהי.

חֲתִימָה:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע Firestore להגדרת אינדקסים עבור.
תְצוּרָה IndexConfiguration הגדרת האינדקס.

החזרות:

הבטחה <void>

Promise שפתרה ברגע שכל המדדים מוגדרים בהצלחה.

חריגים

FirestoreError אם פורמט JSON אינו חוקי.

setIndexConfiguration (Firestore, JSON)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות על סמך משוב שאנו מקבלים. אל תשתמש בממשק API זה בסביבת ייצור.

במקום ליצור אינדקסים של מטמון באופן ידני, שקול להשתמש ב- enablePersistentCacheIndexAutoCreation() לאפשר ל- SDK להחליט אם ליצור אינדקסים של מטמון לשאילתות הפועלות באופן מקומי.

מגדיר אינדקס לביצוע שאילתה מקומית. כל תצורת אינדקס קודמת מבוצעת. Promise נפתרת לאחר שתתמיד תצורת האינדקס.

ערכי האינדקס עצמם נוצרים באופן אסינכרוני. אתה יכול להמשיך להשתמש בשאילתות הדורשות אינדקס גם אם המדדים עדיין אינם זמינים. ביצוע השאילתה יתחיל אוטומטית להשתמש באינדקס לאחר כתיבת רשומות האינדקס.

אינדקסים נתמכים רק בהתמדה באינדקסדב. הפעל את enableIndexedDbPersistence() או enableMultiTabIndexedDbPersistence() לפני קביעת תצורת אינדקס. אם IndexedDB אינו מופעל, מתעלמים מתצורת אינדקס כלשהי.

השיטה מקבלת את הפורמט של JSON המיוצא על ידי CLI של Firebase ( firebase firestore:indexes ). אם פורמט JSON אינו חוקי, שיטה זו זורקת שגיאה.

חֲתִימָה:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore מופע Firestore להגדרת אינדקסים עבור.
json חוּט פורמט JSON מיוצא על ידי CLI של Firebase.

החזרות:

הבטחה <void>

Promise שפתרה ברגע שכל המדדים מוגדרים בהצלחה.

חריגים

FirestoreError אם פורמט JSON אינו חוקי.

להפסיק (Firestore)

מסתיים את מופע ה- Firestore המסופק.

לאחר קריאת terminate() ניתן להשתמש רק בפונקציית clearIndexedDbPersistence() . כל פונקציה אחרת תזרוק את ה- FirestoreError .

כדי להפעיל מחדש לאחר סיום, צור מופע חדש של FirebaseFirestore עם getFirestore () .

סיום אינו מבטל שום כותב ממתין, וכל הבטחות הממתינות לתגובה מהשרת לא תיפתר. אם מופעלת התמדה, בפעם הבאה שתתחיל במופע זה, הוא יחזור לשליחת הכתיבים האלה לשרת.

חֲתִימָה:

export declare function terminate(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

הבטחה <void>

Promise שנפתרת כאשר המופע הופסק בהצלחה.

WaitForpendendWrites (Firestore)

ממתין עד שכולו כותב ועומד כעת למשתמש הפעיל יוכר על ידי ה- Backend.

ההבטחה המוחזרת מחליטה מייד אם אין כותבים מצטיינים. אחרת, ההבטחה מחכה לכל הכתיבים שהונפקו בעבר (כולל אלה שנכתבו במפגש אפליקציות קודם), אך היא לא מחכה לכתבים שנוספו לאחר נקרא הפונקציה. אם אתה רוצה לחכות לכתבים נוספים, התקשר שוב ל- waitForPendingWrites() .

כל הבטחות waitForPendingWrites() מצטיינות נדחות במהלך שינויי משתמש.

חֲתִימָה:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

הבטחה <void>

Promise שפתרה כאשר כל הכתיבה שעומדת כעת הוכרה כעת על ידי ה- Backend.

WriteBatch (Firestore)

יוצר אצווה כתיבה, המשמשת לביצוע כתיבים מרובים כפעולה אטומית יחידה. המספר המרבי של הכתיבים המותרים בספר כתיבה יחיד הוא 500.

שלא כמו עסקאות, כתיבת קבוצות נמשכות באופן לא מקוון ולכן עדיפות כאשר אינך צריך להתנות את הכתיבה שלך על נתוני קריאה.

חֲתִימָה:

export declare function writeBatch(firestore: Firestore): WriteBatch;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
firestore Firestore

החזרות:

Writbatch

כתיבת כתיבה שניתן להשתמש בה כדי לבצע אטומית כתיבה מרובה.

פוּנקצִיָה()

לספור()

צור אובייקט אגרגטפילד שניתן להשתמש בו כדי לחשב את ספירת המסמכים במערך התוצאות של שאילתה.

חֲתִימָה:

export declare function count(): AggregateField<number>;

החזרות:

אגרגטפילד <מספר>

DeleteField ()

מחזיר זקיף לשימוש עם advatedococ () או setdoc () עם {merge: true} כדי לסמן שדה למחיקה.

חֲתִימָה:

export declare function deleteField(): FieldValue;

החזרות:

ערך שדה

DocumentId ()

מחזיר FieldPath מיוחד של Sentinel כדי להתייחס לתעודת הזהות של מסמך. ניתן להשתמש בו בשאילתות כדי למיין או לסנן על ידי מזהה המסמך.

חֲתִימָה:

export declare function documentId(): FieldPath;

החזרות:

שביל שדה

getFirestore ()

מחזיר את מופע ה- Firestore הקיים הקיים שקשור לברירת המחדל של FirebaseApp . אם אין מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

export declare function getFirestore(): Firestore;

החזרות:

Firestore

מופע ברירת המחדל של Firestore של אפליקציית ברירת המחדל.

remoreAegargarBageCollector ()

יוצר מופע של MemoryEagerGarbageCollector . זהו גם אספן האשפה המוגדר כברירת מחדל אלא אם כן הוא צוין במפורש אחרת.

חֲתִימָה:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

החזרות:

RemoryeAggrgarBageCollector

PersistentMultipletabManager ()

יוצר מופע של PersistentMultipleTabManager .

חֲתִימָה:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

החזרות:

PersistentMultipletabManager

ServerTimestamp ()

מחזיר זקיף המשמש עם SetDoc () או atchedutedoc () כדי לכלול חותמת זמן שנוצר על ידי שרת בנתונים הכתובים.

חֲתִימָה:

export declare function serverTimestamp(): FieldValue;

החזרות:

ערך שדה

פונקציה (מסגר נתונים, ...)

getFirestore (מסגר נתונים)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות על סמך משוב שאנו מקבלים. אל תשתמש בממשק API זה בסביבת ייצור.

מחזיר את המופע הקיים בשם Firestore שקשור לברירת המחדל של FirebaseApp . אם אין מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

export declare function getFirestore(databaseId: string): Firestore;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
DataBaseID חוּט שם מסד הנתונים.

החזרות:

Firestore

מופע Firestore שנקרא של אפליקציית ברירת המחדל.

פונקציה (אלמנטים, ...)

ArrayRemove (אלמנטים)

מחזיר ערך מיוחד שניתן להשתמש בו עם SetDoc () או שאומר לשרת להסיר את האלמנטים הנתונים מכל ערך מערך שכבר קיים בשרת. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array.

חֲתִימָה:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אלמנטים לא ידוע[] The elements to remove from the array.

החזרות:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

חֲתִימָה:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אלמנטים לא ידוע[] The elements to union into the array.

החזרות:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc() .

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

חֲתִימָה:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שדה string | FieldPath Specifies the field to average across the result set.

החזרות:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

חֲתִימָה:

export declare function sum(field: string | FieldPath): AggregateField<number>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שדה string | FieldPath Specifies the field to sum across the result set.

החזרות:

AggregateField <number>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

חֲתִימָה:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldPath string | FieldPath The field to sort by.
directionStr OrderByDirection Optional direction to sort by ('asc' or 'desc'). If not specified, order will be ascending.

החזרות:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

חֲתִימָה:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldPath string | FieldPath The path to compare
opStr WhereFilterOp The operation string (eg "&lt;", "&lt;=", "==", "&lt;", "&lt;=", "!=").
ערך לא ידוע The value for comparison

החזרות:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

חֲתִימָה:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldValues לא ידוע[] The field values to end this query at, in order of the query's order by.

החזרות:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

חֲתִימָה:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldValues לא ידוע[] The field values to end this query before, in order of the query's order by.

החזרות:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

חֲתִימָה:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldValues לא ידוע[] The field values to start this query after, in order of the query's order by.

החזרות:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

חֲתִימָה:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
fieldValues לא ידוע[] The field values to start this query at, in order of the query's order by.

החזרות:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

חֲתִימָה:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
indexManager PersistentCacheIndexManager

החזרות:

בָּטֵל

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

חֲתִימָה:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
indexManager PersistentCacheIndexManager

החזרות:

בָּטֵל

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

This feature is disabled by default.

חֲתִימָה:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
indexManager PersistentCacheIndexManager

החזרות:

בָּטֵל

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

חֲתִימָה:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שמאלה AggregateField <unknown> Compare this AggregateField to the right .
ימין AggregateField <unknown> Compare this AggregateField to the left .

החזרות:

boolean

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

חֲתִימָה:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שמאלה AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The first AggregateQuerySnapshot to compare.
ימין AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType> The second AggregateQuerySnapshot to compare.

החזרות:

boolean

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

חֲתִימָה:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שמאלה שאילתא <AppModelType, DbModelType> A Query to compare.
ימין שאילתא <AppModelType, DbModelType> A Query to compare.

החזרות:

boolean

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

חֲתִימָה:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שמאלה DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.
ימין DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType> A reference to compare.

החזרות:

boolean

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

חֲתִימָה:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שמאלה DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.
ימין DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType> A snapshot to compare.

החזרות:

boolean

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

חֲתִימָה:

export declare function limit(limit: number): QueryLimitConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
לְהַגבִּיל מספר The maximum number of items to return.

החזרות:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

חֲתִימָה:

export declare function limitToLast(limit: number): QueryLimitConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
לְהַגבִּיל מספר The maximum number of items to return.

החזרות:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

חֲתִימָה:

export declare function setLogLevel(logLevel: LogLevel): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
logLevel LogLevel The verbosity you set for activity and error logging. Can be any of the following values:
  • debug for the most verbose logging level, primarily for debugging.
  • error to log errors only.
  • silent to turn off logging.

החזרות:

בָּטֵל

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

חֲתִימָה:

export declare function increment(n: number): FieldValue;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
נ מספר The value to increment by.

החזרות:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

חֲתִימָה:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query whose result set is aggregated over.
aggregateSpec AggregateSpecType An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

החזרות:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

דוגמא

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

חֲתִימָה:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query whose result set size is calculated.

החזרות:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

חֲתִימָה:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType>

החזרות:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

חֲתִימָה:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType>

החזרות:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

חֲתִימָה:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType>

החזרות:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query to listen to.
מַשׁקִיף { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query to listen to.
אפשרויות SnapshotListenOptions Options controlling the listen behavior.
מַשׁקִיף { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query to listen to.
בהבא (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The query to listen to.
אפשרויות SnapshotListenOptions Options controlling the listen behavior.
בהבא (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

חֲתִימָה:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
compositeFilter QueryCompositeFilterConstraint The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints QueryNonFilterConstraint [] Additional QueryNonFilterConstraint s to apply (eg orderBy() , limit() ).

החזרות:

שאילתא <AppModelType, DbModelType>

Exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

חֲתִימָה:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שאילתא שאילתא <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

החזרות:

שאילתא <AppModelType, DbModelType>

Exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

חֲתִימָה:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
queryConstraints QueryFilterConstraint [] אופציונאלי. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , or() , או ו() .

החזרות:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

חֲתִימָה:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
queryConstraints QueryFilterConstraint [] אופציונאלי. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , or() , או ו() .

החזרות:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

חֲתִימָה:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות CollectionReference <AppModelType, DbModelType> A reference to the collection to add this document to.
נתונים WithFieldValue <AppModelType> An Object containing the data for the new document.

החזרות:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

חֲתִימָה:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות CollectionReference <AppModelType, DbModelType> A reference to a collection.
נָתִיב חוּט A slash-separated path to a collection.
pathSegments חוּט[] Additional path segments to apply relative to the first argument.

החזרות:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

חֲתִימָה:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
נָתִיב חוּט A slash-separated path to a collection.
pathSegments חוּט[] Additional path segments that will be applied relative to the first argument.

החזרות:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

חֲתִימָה:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to delete.

החזרות:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

חֲתִימָה:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות CollectionReference <AppModelType, DbModelType> A reference to a collection.
נָתִיב חוּט A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments חוּט[] Additional path segments that will be applied relative to the first argument.

החזרות:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

Exceptions

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

חֲתִימָה:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to a Firestore document.
נָתִיב חוּט A slash-separated path to a document.
pathSegments חוּט[] Additional path segments that will be applied relative to the first argument.

החזרות:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

Exceptions

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

חֲתִימָה:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> The reference of the document to fetch.

החזרות:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

חֲתִימָה:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType>

החזרות:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

חֲתִימָה:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType>

החזרות:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
מַשׁקִיף { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
אפשרויות SnapshotListenOptions Options controlling the listen behavior.
מַשׁקִיף { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
בהבא (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

חֲתִימָה:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to listen to.
אפשרויות SnapshotListenOptions Options controlling the listen behavior.
בהבא (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
onError (error: FirestoreError ) => void A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion () => void Can be provided, but will not be called since streams are never ending.

החזרות:

בטל את הרישום

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

חֲתִימָה:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to write.
נתונים WithFieldValue <AppModelType> A map of the fields and values for the document.

החזרות:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

חֲתִימָה:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to write.
נתונים PartialWithFieldValue <AppModelType> A map of the fields and values for the document.
אפשרויות SetOptions An object to configure the set behavior.

החזרות:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

חֲתִימָה:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to update.
נתונים עדכן מידע <DbModelType> An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

החזרות:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

חֲתִימָה:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התייחסות DocumentReference <AppModelType, DbModelType> A reference to the document to update.
שדה string | FieldPath The first field to update.
ערך לא ידוע The first value.
moreFieldsAndValues לא ידוע[] Additional key value pairs.

החזרות:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

חֲתִימָה:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הגדרות MemoryCacheSettings

החזרות:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

חֲתִימָה:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הגדרות { cacheSizeBytes?: number; }

החזרות:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

חֲתִימָה:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הגדרות PersistentCacheSettings

החזרות:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

חֲתִימָה:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הגדרות PersistentSingleTabManagerSettings | לא מוגדר Configures the created tab manager.

החזרות:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

חֲתִימָה:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
תמונת מצב DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to end at.

החזרות:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

חֲתִימָה:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
תמונת מצב DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to end before.

החזרות:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

חֲתִימָה:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
תמונת מצב DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to start after.

החזרות:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

חֲתִימָה:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
תמונת מצב DocumentSnapshot <AppModelType, DbModelType> The snapshot of the document to start at.

החזרות:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

חֲתִימָה:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

חֲתִימָה:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

חֲתִימָה:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

חֲתִימָה:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

חֲתִימָה:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

חֲתִימָה:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

חֲתִימָה:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

חֲתִימָה:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

חֲתִימָה:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

חֲתִימָה:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

חֲתִימָה:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

חֲתִימָה:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

חֲתִימָה:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

חֲתִימָה:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

חֲתִימָה:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

פְּרִימִיטִיבִי

Primitive types.

חֲתִימָה:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

חֲתִימָה:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

חֲתִימָה:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , מתחיל ב() , startAfter() , endBefore() , נגמר ב() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

חֲתִימָה:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

חֲתִימָה:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

חֲתִימָה:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -סוּג

חֲתִימָה:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

עדכן מידע

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

חֲתִימָה:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

חֲתִימָה:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

חֲתִימָה:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);