@firebase/firestore

المهام

الطبقات

واجهات

المتغيرات

اكتب الأسماء المستعارة

وظيفة (التطبيق ، ...)

getFirestore (التطبيق)

إرجاع مثيل Firestore الافتراضي الموجود المرتبط بـ FireBaseApp المقدم . في حالة عدم وجود مثيل ، قم بتهيئة مثيل جديد بإعدادات افتراضية.

إمضاء:

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

حدود

عائدات:

فايرستور

مثيل Firestore الافتراضي للتطبيق المقدم.

getFirestore (التطبيق ، databaseid)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطورين وقد تتغير بناءً على التعليقات التي نتلقاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة الإنتاج.

إرجاع مثيل Firestore الموجود المرتبط بـ FireBaseApp المقدم . في حالة عدم وجود مثيل ، قم بتهيئة مثيل جديد بإعدادات افتراضية.

إمضاء:

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

حدود

عائدات:

فايرستور

مثيل Firestore المسماة للتطبيق المقدم.

initializeFirestore (التطبيق ، الإعدادات ، databaseid)

تهيئة مثيل جديد لـ Firestore مع الإعدادات المقدمة. لا يمكن استدعاؤها إلا قبل أي وظيفة أخرى ، بما في ذلك getFirestore () . إذا كانت الإعدادات المخصصة فارغة ، فإن هذه الوظيفة تعادل استدعاء GetFirestore () .

إمضاء:

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

حدود

عائدات:

فايرستور

مثيل Firestore تهيئته حديثًا.

وظيفة (Firestore ، ...)

ClearIndexedDBPersistence (Firestore)

يمسح التخزين المستمر. ويشمل ذلك المعلق في الكتابة والوثائق المخزنة مؤقتًا.

يجب أن يتم استدعاؤها أثناء عدم بدء مثيل Firestore (بعد إنهاء التطبيق أو عند تهيئة التطبيق لأول مرة). عند بدء التشغيل ، يجب استدعاء هذه الوظيفة قبل وظائف أخرى (بخلاف initializeFirestore () أو getFirestore () )). إذا كان مثيل Firestore لا يزال قيد التشغيل ، فسيتم رفض الوعد برمز الخطأ failed-precondition .

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise الذي يتم حله عند مسح التخزين المستمر. خلاف ذلك ، يتم رفض الوعد بخطأ.

مجموعة (Firestore ، المسار ، المسار)

يحصل على مثيل CollectionReference يشير إلى المجموعة في المسار المطلق المحدد.

إمضاء:

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

حدود

عائدات:

جمع < documentData ، documentData >

مثيل CollectionReference .

الاستثناءات

إذا كان المسار النهائي لديه عدد زوجي من الأجزاء ولم يشير إلى مجموعة.

CollectionGroup (Firestore ، CollectionId)

يقوم بإنشاء وإرجاع مثيل Query جديد يتضمن جميع المستندات في قاعدة البيانات الواردة في مجموعة أو تجميع فرعي مع collectionId معينة .

إمضاء:

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

حدود

عائدات:

استفسار < documentData ، documentData >

Query الذي تم إنشاؤه .

ConnectFirestoreemulator (Firestore ، مضيف ، منفذ ، خيارات)

قم بتعديل هذه الحالة للتواصل مع محاكي Firestore Cloud.

إمضاء:

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

حدود

عائدات:

فارغ

عطل (Firestore)

يعطل استخدام الشبكة لهذه الحالة. يمكن إعادة تمكينه عبر Enablenetwork () . بينما يتم تعطيل الشبكة ، فإن أي مستمعين لقطات ، سيعيد مكالمات getDoc() أو getDocs() نتائج ذاكرة التخزين المؤقت ، وسيتم وضع أي عمليات كتابة حتى يتم استعادة الشبكة.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise يتم حله بمجرد تعطيل الشبكة.

DOC (Firestore ، Path ، PathSegments)

يحصل على مثيل DocumentReference الذي يشير إلى المستند في المسار المطلق المحدد.

إمضاء:

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

حدود

عائدات:

وثيقة مرجعية < documentData ، documentData >

مثيل DocumentReference .

الاستثناءات

إذا كان المسار النهائي يحتوي على عدد فردي من الأجزاء ولم يشير إلى وثيقة.

EnableIndexedDbersistence (Firestore ، Prosistencestings)

ستتم إزالة هذه الوظيفة في إصدار رئيسي في المستقبل. بدلاً من ذلك ، قم بتعيين FirestoreSettings.localCache على مثيل من PersistentLocalCache لتشغيل ذاكرة التخزين المؤقت INSTINGEDDB. استدعاء هذه الوظيفة عند تحديد FirestoreSettings.localCache بالفعل ، سوف يلقي استثناء.

محاولات لتمكين التخزين المستمر ، إن أمكن.

عند الفشل ، سوف يرفض enableIndexedDbPersistence() الوعد أو رمي استثناء. هناك العديد من الأسباب التي تجعل ذلك قد يفشل ، والتي يمكن تحديدها بواسطة code على الخطأ.

* الفشل الفاشل: التطبيق مفتوح بالفعل في علامة تبويب متصفح أخرى. * غير مفيدة: المستعرض لا يتوافق مع تنفيذ الثبات في وضع عدم الاتصال.

لاحظ أنه حتى بعد الفشل ، ستبقى مثيل Firestore قابلاً للاستخدام ، ولكن سيتم تعطيل الثبات غير المتصلة بالإنترنت.

لا يمكن استخدام الثبات في بيئة node.js.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise الذي يمثل بنجاح تمكين التخزين المستمر.

enablemultitaBindexedDbersistence (Firestore)

ستتم إزالة هذه الوظيفة في إصدار رئيسي في المستقبل. بدلاً من ذلك ، قم بتعيين FirestoreSettings.localCache على مثيل من PersistentLocalCache لتشغيل ذاكرة التخزين المؤقت INSTINGEDDB. استدعاء هذه الوظيفة عند تحديد FirestoreSettings.localCache بالفعل ، سوف يلقي استثناء.

محاولات لتمكين التخزين المستمر متعددة الطابقين ، إن أمكن. إذا تم تمكينها في جميع علامات التبويب ، فإن جميع العمليات تشترك في الوصول إلى الثبات المحلي ، بما في ذلك التنفيذ المشترك للاستعلامات وتحديثات المستندات المحلية المعدلة في جميع الحالات المتصلة.

عند الفشل ، سوف يرفض enableMultiTabIndexedDbPersistence() الوعد أو يرمي استثناء. هناك العديد من الأسباب التي تجعل ذلك قد يفشل ، والتي يمكن تحديدها بواسطة code على الخطأ.

* الفشل في الإجراء: التطبيق مفتوح بالفعل في علامة تبويب متصفح أخرى ولا يتم تمكين TAB المتعدد. * غير مفيدة: المستعرض لا يتوافق مع تنفيذ الثبات في وضع عدم الاتصال.

لاحظ أنه حتى بعد الفشل ، ستبقى مثيل Firestore قابلاً للاستخدام ، ولكن سيتم تعطيل الثبات غير المتصلة بالإنترنت.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise الذي يمثل بنجاح تمكين التخزين المستمر.

enablenetwork (Firestore)

إعادة تخصيص استخدام الشبكة لمثيل Firestore هذا بعد مكالمة سابقة لتعطيل العمل () .

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise يتم حله بمجرد تمكين الشبكة.

getPersistraftCacheIndexManager (Firestore)

إرجاع مدير فهرس PersistentCache المستخدم من قبل كائن Firestore المعطى.

مثيل PersistentCacheIndexManager ، أو null إذا لم يكن التخزين المستمر المحلي قيد الاستخدام.

إمضاء:

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

حدود

عائدات:

perfectCacheIndexManager | باطل

LoadBundle (Firestore ، Bundledata)

يحمل حزمة Firestore في ذاكرة التخزين المؤقت المحلية.

إمضاء:

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

حدود

عائدات:

loadBundletask

كائن LoadBundleTask ، الذي يخطر المتصلين مع تحديثات التقدم ، وأحداث الإكمال أو الخطأ. يمكن استخدامه Promise<LoadBundleTaskProgress> .

اسمه اسمه (فايرستور ، الاسم)

يقرأ استعلام Firestore من ذاكرة التخزين المؤقت المحلية ، التي تم تحديدها بالاسم المحدد.

يتم تعبئة الاستعلامات المسماة في حزم على جانب الخادم (جنبا إلى جنب مع المستندات الناتجة) ، وتحميلها إلى ذاكرة التخزين المؤقت المحلية باستخدام loadBundle . مرة واحدة في ذاكرة التخزين المؤقت المحلية ، استخدم هذه الطريقة لاستخراج استعلام بالاسم.

إمضاء:

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

حدود

عائدات:

وعد < Query | فارغ>

Promise يتم حله مع الاستعلام أو null .

onsnapshotsinsync (Firestore ، Observer)

يرفع مستمع لحدث لقطات في المزامنة. يشير حدث Snapshots-in-Sync إلى أن جميع المستمعين المتأثرين بتغيير معين قد أطلقوا النار ، حتى لو كان تغييرًا واحدًا تم إنشاؤه بواسطة الخادم يؤثر على مستمعين متعددين.

ملاحظة: يشير حدث Snapshots-in-Sync فقط إلى أن المستمعين متزامنين مع بعضهم البعض ، ولكن لا يرتبط بما إذا كانت هذه اللقطات متزامنة مع الخادم. استخدم Snapshotmetadata في المستمعين الفرديين لتحديد ما إذا كانت لقطة من ذاكرة التخزين المؤقت أو الخادم.

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء مستمع اللقطة.

onsnapshotsinsync (Firestore ، onsync)

يرفع مستمع لحدث لقطات في المزامنة. يشير حدث Snapshots-in-Sync إلى أن جميع المستمعين المتأثرين بتغيير معين قد أطلقوا النار ، حتى لو كان تغييرًا واحدًا تم إنشاؤه بواسطة الخادم يؤثر على مستمعين متعددين.

ملاحظة: يشير حدث Snapshots-in-Sync فقط إلى أن المستمعين متزامنين مع بعضهم البعض ، ولكن لا يرتبط بما إذا كانت هذه اللقطات متزامنة مع الخادم. استخدم SnapshotMetadata في المستمعين الفرديين لتحديد ما إذا كانت لقطة من ذاكرة التخزين المؤقت أو الخادم.

إمضاء:

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

حدود

عائدات:

إلغاء الاشتراك

وظيفة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء مستمع اللقطة.

RunTransaction (Firestore ، UpdateFunction ، Options)

ينفذ updateFunction المحدد ثم يحاول ارتكاب التغييرات المطبقة في المعاملة. إذا تغيرت أي مستند في المعاملة ، فإن Cloud updateFunction . إذا فشلت في الالتزام بعد 5 محاولات ، فإن المعاملة تفشل.

الحد الأقصى لعدد الكتابة المسموح به في معاملة واحدة هو 500.

إمضاء:

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

حدود

عائدات:

الوعد <T>

إذا أكملت المعاملة بنجاح أو تم إحباطها بشكل صريح (أعاد updateFunction وعدًا فاشلاً) ، فإن الوعد الذي تم إرجاعه بواسطة updateFunction عاد هنا. خلاف ذلك ، إذا فشلت المعاملة ، يتم إرجاع الوعد المرفوض مع خطأ الفشل المقابل.

setIndexConfiguration (Firestore ، التكوين)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطورين وقد تتغير بناءً على التعليقات التي نتلقاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة الإنتاج.

بدلاً من إنشاء فهارس ذاكرة التخزين المؤقت يدويًا ، فكر في استخدام enablePersistentCacheIndexAutoCreation() للسماح لـ SDK بتحديد ما إذا كان سيتم إنشاء فهارس ذاكرة التخزين المؤقت للاستعلامات التي تعمل محليًا.

تكوين الفهرسة لتنفيذ الاستعلام المحلي. يتم تجاوز أي تكوين فهرس سابق. يحل Promise بمجرد استمرار تكوين الفهرس.

يتم إنشاء إدخالات الفهرس نفسها بشكل غير متزامن. يمكنك متابعة استخدام الاستعلامات التي تتطلب الفهرسة حتى لو لم تكن المؤشرات متوفرة بعد. سيبدأ تنفيذ الاستعلام تلقائيًا باستخدام الفهرس بمجرد كتابة إدخالات الفهرس.

يتم دعم الفهارس فقط مع ثبات الفهرسة. إذا لم يتم تمكين الفهرسة ، يتم تجاهل أي تكوين فهرس.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise يحل بمجرد تكوين جميع المؤشرات بنجاح.

الاستثناءات

FirestoreError إذا كان تنسيق JSON غير صالح.

setIndexConfiguration (Firestore ، JSON)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطورين وقد تتغير بناءً على التعليقات التي نتلقاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة الإنتاج.

بدلاً من إنشاء فهارس ذاكرة التخزين المؤقت يدويًا ، فكر في استخدام enablePersistentCacheIndexAutoCreation() للسماح لـ SDK بتحديد ما إذا كان سيتم إنشاء فهارس ذاكرة التخزين المؤقت للاستعلامات التي تعمل محليًا.

تكوين الفهرسة لتنفيذ الاستعلام المحلي. يتم تجاوز أي تكوين فهرس سابق. يحل Promise بمجرد استمرار تكوين الفهرس.

يتم إنشاء إدخالات الفهرس نفسها بشكل غير متزامن. يمكنك متابعة استخدام الاستعلامات التي تتطلب الفهرسة حتى لو لم تكن المؤشرات متوفرة بعد. سيبدأ تنفيذ الاستعلام تلقائيًا باستخدام الفهرس بمجرد كتابة إدخالات الفهرس.

يتم دعم الفهارس فقط مع ثبات الفهرسة. استدعاء إما enableIndexedDbPersistence() أو enableMultiTabIndexedDbPersistence() قبل تعيين تكوين فهرس. إذا لم يتم تمكين الفهرسة ، يتم تجاهل أي تكوين فهرس.

تقبل الطريقة تنسيق JSON الذي تم تصديره بواسطة Firebase CLI ( firebase firestore:indexes ). إذا كان تنسيق JSON غير صالح ، فإن هذه الطريقة ترمي خطأ.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise يحل بمجرد تكوين جميع المؤشرات بنجاح.

الاستثناءات

FirestoreError إذا كان تنسيق JSON غير صالح.

إنهاء (Firestore)

ينتهي مثيل Firestore المقدم.

بعد استدعاء terminate() فقط يمكن استخدام وظيفة clearIndexedDbPersistence() . أي وظيفة أخرى سوف ترمي FirestoreError .

لإعادة التشغيل بعد الإنهاء ، قم بإنشاء مثيل جديد لـ FirebaseFirestore مع getFirestore () .

لا يلغي الإنهاء أي كتابة معلقة ، ولن يتم حل أي وعود تنتظر استجابة من الخادم. إذا تم تمكين الثبات ، في المرة القادمة التي تبدأ فيها هذه الحالة ، ستستأنف إرسال هذه الكتابة إلى الخادم.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise يتم حله عند إنهاء المثيل بنجاح.

WaitforpendingWrites (Firestore)

يتم الاعتراف بالانتظار حتى يتم الاعتراف بالجميع المعلقة حاليًا للمستخدم النشط من قبل الواجهة الخلفية.

الوعد الذي تم إرجاعه يحل على الفور إذا لم تكن هناك كتابة معلقة. بخلاف ذلك ، ينتظر الوعد لجميع عمليات الكتابة التي تم إصدارها مسبقًا (بما في ذلك تلك المكتوبة في جلسة تطبيق سابقة) ، لكنها لا تنتظر الكتابة التي تمت إضافتها بعد استدعاء الوظيفة. إذا كنت تريد الانتظار حتى يتم كتابة كتاب إضافي ، فاتصل بـ waitForPendingWrites() مرة أخرى.

يتم رفض أي وعود متميزة waitForPendingWrites() أثناء تغييرات المستخدم.

إمضاء:

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

حدود

عائدات:

وعد <doud>

Promise الذي يحل عندما تم الاعتراف بجميع عمليات الكتابة المعلقة حاليًا من قبل الواجهة الخلفية.

WriteBatch (Firestore)

ينشئ مجموعة الكتابة ، تستخدم لأداء عمليات كتابة متعددة كعملية ذرية واحدة. الحد الأقصى لعدد الكتابة المسموح بها في كتاب واحد هو 500.

على عكس المعاملات ، تستمر دفعات الكتابة في وضع عدم الاتصال ، وبالتالي فهي أفضل عندما لا تحتاج إلى شرط كتاباتك على بيانات القراءة.

إمضاء:

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

حدود

عائدات:

WriteBatch

مجموعة الكتابة التي يمكن استخدامها لتنفيذ العديد من الكتابة.

وظيفة()

عدد()

قم بإنشاء كائن AgegregateField يمكن استخدامه لحساب عدد المستندات في مجموعة النتائج من الاستعلام.

إمضاء:

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

عائدات:

إطعام <bumber>

Deletefield ()

إرجاع Sentinel للاستخدام مع updatedoc () أو setDOC () مع {merge: true} لوضع علامة على حقل للحذف.

إمضاء:

export declare function deleteField(): FieldValue;

عائدات:

قيمة الحقل

documentId ()

إرجاع FieldPath حارس خاص للإشارة إلى معرف المستند. يمكن استخدامه في الاستعلامات لفرز أو تصفية بواسطة معرف المستند.

إمضاء:

export declare function documentId(): FieldPath;

عائدات:

ميدان

getFirestore ()

إرجاع مثيل Firestore الافتراضي الموجود المرتبط بـ FirebaseApp الافتراضي . في حالة عدم وجود مثيل ، قم بتهيئة مثيل جديد بإعدادات افتراضية.

إمضاء:

export declare function getFirestore(): Firestore;

عائدات:

فايرستور

مثيل Firestore الافتراضي للتطبيق الافتراضي.

MemoryeAgerGarbageCollector ()

ينشئ مثيلًا MemoryEagerGarbageCollector . هذا هو أيضًا جامع القمامة الافتراضي ما لم يتم تحديده بشكل صريح على خلاف ذلك.

إمضاء:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

عائدات:

MemoryeAgerGarbageCollector

perfectmultipletabmanager ()

يخلق مثيلًا لـ PersistentMultipleTabManager .

إمضاء:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

عائدات:

perfectmultipletabmanager

servertimestamp ()

إرجاع Sentinel المستخدمة مع setDoc () أو updatedOC () لتضمين طابع زمني تم إنشاؤه بواسطة الخادم في البيانات المكتوبة.

إمضاء:

export declare function serverTimestamp(): FieldValue;

عائدات:

قيمة الحقل

وظيفة (databaseid ، ...)

getFirestore (databaseid)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطورين وقد تتغير بناءً على التعليقات التي نتلقاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة الإنتاج.

إرجاع مثيل Firestore الموجود المرتبط بـ FireBaseApp الافتراضي . في حالة عدم وجود مثيل ، قم بتهيئة مثيل جديد بإعدادات افتراضية.

إمضاء:

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

حدود

عائدات:

فايرستور

مثيل Firestore المسماة للتطبيق الافتراضي.

وظيفة (عناصر ، ...)

arrayremove (عناصر)

إرجاع قيمة خاصة يمكن استخدامها مع setDoc () أو تخبر الخادم بإزالة العناصر المعطاة من أي قيمة صفيف موجودة بالفعل على الخادم. ستتم إزالة جميع حالات كل عنصر محدد من الصفيف. إذا لم يكن الحقل الذي يتم تعديله بالفعل صفيفًا ، فسيتم كتابة صفيف فارغ.

إمضاء:

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

حدود

عائدات:

قيمة الحقل

حارس FieldValue للاستخدام في مكالمة إلى setDoc() أو updateDoc()

Arrayunion (عناصر)

إرجاع قيمة خاصة يمكن استخدامها مع setDoc () أو updatedOC () التي تخبر الخادم باتحاد العناصر المعطاة مع أي قيمة صفيف موجودة بالفعل على الخادم. سيتم إضافة كل عنصر محدد غير موجود بالفعل في الصفيف إلى النهاية. 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 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>;

حدود

عائدات:

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

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

فارغ

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;

حدود

عائدات:

فارغ

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.

يتم تعطيل هذه الميزة بشكل افتراضي.

إمضاء:

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

حدود

عائدات:

فارغ

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

إمضاء:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): 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;

حدود

عائدات:

منطقية

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;

حدود

عائدات:

منطقية

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;

حدود

عائدات:

منطقية

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;

حدود

عائدات:

منطقية

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

فارغ

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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>

الاستثناءات

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>

الاستثناءات

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;

حدود

عائدات:

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;

حدود

عائدات:

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

حدود

عائدات:

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 < DocumentData , DocumentData >

The CollectionReference instance.

الاستثناءات

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

حدود

عائدات:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

الاستثناءات

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

حدود

عائدات:

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

حدود

عائدات:

وثيقة مرجعية <AppModelType, DbModelType>

The DocumentReference instance.

الاستثناءات

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

حدود

عائدات:

وثيقة مرجعية < DocumentData , DocumentData >

The DocumentReference instance.

الاستثناءات

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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;

حدود

عائدات:

إلغاء الاشتراك

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

إمضاء:

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

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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;

حدود

عائدات:

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