@firebase/firestore

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

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

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

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

חֲתִימָה:

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

פרמטרים

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

החזרות:

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

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

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

חֲתִימָה:

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

פרמטרים

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

החזרות:

מופע של 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, התמדה)

אזהרה: ממשק API זה מיושן כעת.
פונקציה זו תוסר במהדורה עיקרית עתידית. במקום זאת, הגדר 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)

אזהרה: ממשק API זה מיושן כעת.
פונקציה זו תוסר במהדורה עיקרית עתידית. במקום זאת, הגדר 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 זה בסביבת ייצור.

אזהרה: ממשק 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 זה בסביבת ייצור.

אזהרה: ממשק 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;

החזרות:

RemoryeAggrgarBageCollector

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

remoreAegargarBageCollector ()

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

חֲתִימָה:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

החזרות:

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	חוּט	שם מסד הנתונים.

החזרות:

QueryFieldFilterConstraint

מופע 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 "<", "<=", "==", "<", "<=", "!=").
ערך	לא ידוע	The value for comparison

החזרות:

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.

החזרות:

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.

החזרות:

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.

החזרות:

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.

החזרות:

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).

חֲתִימָה:

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)

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)

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)

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.

החזרות:

QueryCompositeFilterConstraint

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() , או ו() .

החזרות:

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.

החזרות:

MemoryLruGarbageCollector

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; }

החזרות:

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.

החזרות:

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.

החזרות:

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.

החזרות:

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.

החזרות: