@firebase/firestore

الدوال

صفوف

واجهات

المتغيرات

كتابة العناوين البديلة للبريد الإلكتروني

function(app, ...)

getFirestore(app)

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

Signature:

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

المَعلمات

المرتجعات:

متجر إطفاء

يشير هذا المصطلح إلى المثيل التلقائي من Firestore للتطبيق المقدَّم.

getFirestore(app, DatabaseId)

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

تعرِض هذه السمة مثيل Firestore الحالي المرتبط بتطبيق FirebaseApp المقدَّم. في حال عدم توفّر مثيل، يتم بدء مثيل جديد بالإعدادات التلقائية.

Signature:

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

المَعلمات

المرتجعات:

متجر إطفاء

المثيل المُسمّى Firestore للتطبيق المقدَّم.

تهيئةFirestore(تطبيق، إعدادات، قاعدة بيانات معرفية)

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

Signature:

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

المَعلمات

المرتجعات:

متجر إطفاء

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

function(firestore, ...)

clearIndexedDbPersistence(firestore)

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

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

group(firestore, path, pathSegments)

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

Signature:

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

المَعلمات

المرتجعات:

CollectionReference<DocumentData، وDocumentData>

المثيل CollectionReference

الاستثناءات

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

groupGroup(firestore, collectionId)

تنشئ هذه الدالة مثيل Query جديدًا ويعرضها، ويتضمّن جميع المستندات في قاعدة البيانات المضمّنة في مجموعة أو مجموعة فرعية تتضمّن collectionId المحدّد.

Signature:

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

المَعلمات

المرتجعات:

طلب البحث<DocumentData، DocumentData>

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

ConnectFirestoreEmulator(مخزن النار، المضيف، المنفذ، الخيارات)

يمكنك تعديل هذا المثيل للاتصال بمحاكي Cloud Firestore.

Signature:

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

المَعلمات

المرتجعات:

فراغ

DisableNetwork(firestore)

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

رسالة Promise يتم حلّها بعد إيقاف الشبكة.

doc(firestore, path, pathSegments)

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

Signature:

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

المَعلمات

المرتجعات:

DocumentReference<DocumentData، وDocumentData>

المثيل DocumentReference

الاستثناءات

إذا كان المسار النهائي يحتوي على عدد فردي من المقاطع ولا يشير إلى مستند.

EnableIndexedDbPersistence(firestore, ContinueenceSettings)

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

محاولات تفعيل مساحة التخزين الدائمة، إن أمكن

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

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

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

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تمثّل هذه السمة Promise تمثِّل تفعيل مساحة التخزين الدائمة بنجاح.

Enable MultiTabIndexedDbPersistence(firestore)

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

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

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

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

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تمثّل هذه السمة Promise تمثِّل تفعيل مساحة التخزين الدائمة بنجاح.

EnableNetwork(firestore)

لإعادة تفعيل استخدام الشبكة لمثيل Firestore هذا بعد استدعاء سابق لـ disableNetwork().

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

رسالة Promise يتم حلّها بعد تفعيل الشبكة.

getPersistentCacheIndexManager(firestore)

عرض إدارة فهرسة PersistentCache التي يستخدمها الكائن Firestore المحدّد.

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

Signature:

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

المَعلمات

المرتجعات:

PersistentcacheIndexManager | فارغ

uploadBundle(firestore, packageData)

لتحميل حزمة Firestore في ذاكرة التخزين المؤقت على الجهاز

Signature:

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

المَعلمات

المرتجعات:

LoadBundleTask

عنصر LoadBundleTask، يُعلِم المتصِلين بالتعديلات المتعلّقة بمستوى التقدّم وأحداث الإكمال أو الأخطاء. ويمكن استخدامها باعتبارها Promise<LoadBundleTaskProgress>.

nameQuery(firestore, name)

لقراءة طلب بحث في Firestore من ذاكرة التخزين المؤقت على الجهاز، والذي يتم تحديده حسب الاسم المحدّد.

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

Signature:

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

المَعلمات

المرتجعات:

التعهد<Query | null>

تمثّل هذه السمة Promise تم حلّه باستخدام طلب البحث أو null.

onSnapshotsInSync(firestore, Monitoringr)

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

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

Signature:

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

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

onSnapshotsInSync(firestore, onSync)

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

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

Signature:

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

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

runtransaction(firestore, updateFunction, options)

يتم تنفيذ updateFunction المحدَّد ثم محاولة تنفيذ التغييرات المُطبَّقة ضمن المعاملة. في حال تغيير أي مستند تمت قراءته ضمن المعاملة، يعيد Cloud Firestore محاولة updateFunction. يتعذّر إتمام المعاملة بعد 5 محاولات.

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

Signature:

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

المَعلمات

المرتجعات:

وعود<T>

في حال إكمال المعاملة بنجاح أو إلغائها بشكل صريح (تعذّرت معالجة updateFunction، يتم إرجاع الوعد الذي أرجعته updateFunction إلى هنا. وبخلاف ذلك، إذا تعذّر إكمال المعاملة، سيتم إرجاع وعود مرفوضة مع ظهور خطأ تعذُّر إكمال المعاملة.

setIndexConfiguration(firestore, Configuration)

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

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

لضبط الفهرسة لتنفيذ طلب البحث المحلي يتم تجاهل أي إعدادات فهرس سابقة. يتم حل Promise بعد الاحتفاظ بإعدادات الفهرس.

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

لا تتوافق الفهارس إلا مع قاعدة IndexedDb. في حال عدم تفعيل IndexedDb، يتم تجاهل أي إعداد للفهرس.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

Promise التي يتم حلها بعد إعداد جميع الفهارس بنجاح.

الاستثناءات

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

setIndexConfiguration(firestore, json)

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

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

لضبط الفهرسة لتنفيذ طلب البحث المحلي يتم تجاهل أي إعدادات فهرس سابقة. يتم حل Promise بعد الاحتفاظ بإعدادات الفهرس.

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

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

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

Promise التي يتم حلها بعد إعداد جميع الفهارس بنجاح.

الاستثناءات

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

End(firestore)

لإنهاء مثيل Firestore المقدَّم.

بعد استدعاء الدالة terminate()، قد يتم استخدام الدالة clearIndexedDbPersistence() فقط. ستعرض أي دالة أخرى الخطأ FirestoreError.

لإعادة تشغيل الخدمة بعد إنهاء الاتفاقية، أنشِئ مثيلاً جديدًا من FirebaseFirestore باستخدام getFirestore().

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

longForPendingWrites(firestore)

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

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

يتم رفض أي وعود معلّقة بشأن waitForPendingWrites() أثناء إجراء تغييرات على المستخدمين.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

writeBatch(firestore)

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

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

Signature:

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

المَعلمات

المرتجعات:

WriteBatch

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

الدالة()

()count

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

Signature:

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

المرتجعات:

AggregateField<number>

DeleteField()

تعرض رسالة مُرسلة للاستخدام مع updateDoc() أو setDoc() مع {merge: true} لتمييز حقل للحذف.

Signature:

export declare function deleteField(): FieldValue;

المرتجعات:

FieldValue

DocumentId()

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

Signature:

export declare function documentId(): FieldPath;

المرتجعات:

FieldPath

getFirestore()

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

Signature:

export declare function getFirestore(): Firestore;

المرتجعات:

متجر إطفاء

يشير هذا المصطلح إلى مثيل Firestore التلقائي للتطبيق التلقائي.

الذاكرةEagerGarbageCollector()

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

Signature:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

المرتجعات:

MemoryEagerGarbageCollector

SustainMultipleTabManager()

تنشئ مثيلاً لـ PersistentMultipleTabManager.

Signature:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

المرتجعات:

PersistentMultipleTabManager

serverTimestamp()

تعرض رسالة مُرسلة يتم استخدامها مع setDoc() أو updateDoc() لتضمين طابع زمني ينشئه الخادم في البيانات المكتوبة.

Signature:

export declare function serverTimestamp(): FieldValue;

المرتجعات:

FieldValue

function(databaseId, ...)

getFirestore(databaseId)

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

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

Signature:

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

المَعلمات

المرتجعات:

متجر إطفاء

المثيل المُسمّى Firestore للتطبيق التلقائي.

function(items, ...)

صفيفإزالة(عناصر)

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

Signature:

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

المَعلمات

المرتجعات:

FieldValue

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

صفيف.(عناصر)

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

Signature:

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

المَعلمات

المرتجعات:

FieldValue

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

function(field, ...)

المتوسط(الحقل)

يمكنك إنشاء كائن AggregateField يمكن استخدامه لحساب متوسط حقل محدَّد على نطاق من المستندات في مجموعة نتائج طلب البحث.

Signature:

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

المَعلمات

المرتجعات:

AggregateField <number | null>

sum(حقل)

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

Signature:

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

المَعلمات

المرتجعات:

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, DirectionStr)

إنشاء QueryOrderByConstraint الذي يرتب نتيجة طلب البحث حسب الحقل المحدد، اختياريًا بترتيب تنازلي بدلاً من تصاعدي.

Signature:

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

المَعلمات

المرتجعات:

QueryOrderByConstraint

دالة QueryOrderByConstraint التي تم إنشاؤها.

where(fieldPath, opStr, value)

تنشئ هذه السياسة QueryFieldFilterConstraint التي تفرض ضرورة أن تحتوي المستندات على الحقل المحدّد وأن القيمة يجب أن تستوفي قيد العلاقة المتوفّر.

Signature:

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

المَعلمات

المرتجعات:

QueryFieldFilterConstraint

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

function(fieldValues, ...)

endAt(fieldValues)

تنشئ دالة QueryEndAtConstraint تعديل مجموعة النتائج لتنتهي عند الحقول المقدّمة بالنسبة إلى ترتيب طلب البحث. يجب أن يتطابق ترتيب قيم الحقول مع ترتيب الترتيب حسب عبارات الاستعلام.

Signature:

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

المَعلمات

المرتجعات:

QueryEndAtConstraint

A QueryEndAtConstraint للانتقال إلى query()

endBefore(fieldValues)

تنشئ هذه الدالة QueryEndAtConstraint تعديلاً لمجموعة النتائج بحيث تنتهي قبل الحقول المقدّمة بالنسبة إلى ترتيب طلب البحث. يجب أن يتطابق ترتيب قيم الحقول مع ترتيب الترتيب حسب عبارات الاستعلام.

Signature:

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

المَعلمات

المرتجعات:

QueryEndAtConstraint

A QueryEndAtConstraint للانتقال إلى query()

startafter(fieldValues)

تنشئ هذه الدالة QueryStartAtConstraint لتعديل مجموعة النتائج للبدء بعد الحقول المقدّمة بالنسبة إلى ترتيب طلب البحث. يجب أن يتطابق ترتيب قيم الحقول مع ترتيب الترتيب حسب عبارات الاستعلام.

Signature:

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

المَعلمات

المرتجعات:

QueryStartAtConstraint

QueryStartAtConstraint للانتقال إلى query()

startAt(fieldValues)

تنشئ هذه الدالة QueryStartAtConstraint لتعديل مجموعة النتائج للبدء من الحقول المقدّمة بالنسبة إلى ترتيب طلب البحث. يجب أن يتطابق ترتيب قيم الحقول مع ترتيب الترتيب حسب عبارات الاستعلام.

Signature:

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

المَعلمات

المرتجعات:

QueryStartAtConstraint

A QueryStartAtConstraint للانتقال إلى query().

function(indexManager, ...)

deleteAllPersistentcacheIndexes(indexManager)

إزالة جميع فهارس ذاكرة التخزين المؤقت الدائمة

يُرجى العِلم أنّ هذه الدالة ستحذف أيضًا الفهارس التي تم إنشاؤها من خلال setIndexConfiguration()، والتي تم إيقافها نهائيًا.

Signature:

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

المَعلمات

المرتجعات:

فراغ

إيقاف PersistentcacheIndexAutoCreation(indexManager)

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

Signature:

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

المَعلمات

المرتجعات:

فراغ

EnablePersistentCacheIndexAutoCreation(indexManager)

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

تكون هذه الميزة معطلة بشكل تلقائي.

Signature:

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

المَعلمات

المرتجعات:

فراغ

function(left, ...)

groupFieldEqual(left, right)

لمقارنة حالتين من "AggregateField" للمساواة.

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

groupQuerySnapshotEqual(يسار، يمين)

تتم المقارنة بين حالتين AggregateQuerySnapshot من أجل المساواة.

يتم اعتبار حالتَين AggregateQuerySnapshot على أنّهما "متساويتان". إذا كانت تضم استعلامات أساسية تقارن بينها، ونفس البيانات.

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

true إذا كانت العناصر "متساوية" كما هو موضَّح أعلاه، أو false غير ذلك.

queryEqual(left, right)

تعرض القيمة "صحيح" إذا كانت طلبات البحث المقدّمة تشير إلى المجموعة نفسها وتطبّق القيود نفسها.

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

true إذا كانت المراجع تشير إلى الموقع نفسه في قاعدة بيانات Firestore نفسها.

refEqual(left, right)

يتم عرض true إذا كانت المراجع المقدّمة متساوية.

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

true إذا كانت المراجع تشير إلى الموقع نفسه في قاعدة بيانات Firestore نفسها.

PixelbookEqual(left, right)

يتم عرض true إذا كانت اللقطات التي تم تقديمها متساوية.

Signature:

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

المَعلمات

المرتجعات:

قيمة منطقية

true إذا كانت اللقطات متساوية.

function(limit, ...)

الحد(الحد الأقصى)

تنشئ هذه الدالة QuerylimitedConstraint التي تعرض فقط المستندات الأولى المطابقة.

Signature:

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

المَعلمات

المرتجعات:

QuerylimitedConstraint

دالة QueryLimitConstraint التي تم إنشاؤها.

limitToLast(limit)

تنشئ هذه الدالة QuerylimitedConstraint التي تعرض آخر المستندات المطابقة فقط.

يجب تحديد عبارة orderBy واحدة على الأقل لطلبات بحث limitToLast، وإلّا فسيتم تطبيق استثناء أثناء التنفيذ.

Signature:

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

المَعلمات

المرتجعات:

QuerylimitedConstraint

دالة QueryLimitConstraint التي تم إنشاؤها.

function(logLevel, ...)

setLogLevel(logLevel)

تضبط هذه السياسة مستوى الإسهاب في سجلّات Cloud Firestore (تصحيح الأخطاء أو الأخطاء أو الصامت).

Signature:

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

المَعلمات

المرتجعات:

فراغ

function(n, ...)

الزيادة(n)

تعرض قيمة خاصة يمكن استخدامها مع setDoc() أو updateDoc() تطلب من الخادم زيادة القيمة الحالية للحقل من خلال القيمة المحدّدة.

إذا كان المعامل أو قيمة الحقل الحالي يستخدم دقة النقطة العائمة، تتّبع كل العمليات الحسابية دلالات IEEE 754. في حال كانت كلتا القيمتان أعداد صحيحة، تكون القيم خارج نطاق الأرقام الآمنة في JavaScript (من Number.MIN_SAFE_INTEGER إلى Number.MAX_SAFE_INTEGER) عرضة لفقدان الدقة أيضًا. علاوة على ذلك، بمجرد معالجتها بواسطة الواجهة الخلفية Firestore، يتم وضع حد أقصى لجميع عمليات الأعداد الصحيحة بين -2^63 و 2^63-1.

إذا لم تكن قيمة الحقل الحالي من النوع number، أو إذا لم يتوفّر الحقل بعد، تضبط عملية التحويل الحقل على القيمة المحدّدة.

Signature:

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

المَعلمات

المرتجعات:

FieldValue

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

function(query, ...)

getAggregateFromServer(query, AggregateSpec)

لحساب التجميعات المحددة على المستندات في مجموعة نتائج طلب البحث المحدد بدون تنزيل المستندات فعليًا.

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

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

Signature:

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

المَعلمات

المرتجعات:

وعود<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)

لحساب عدد المستندات في مجموعة نتائج الاستعلام المحدد بدون تنزيل المستندات فعليًا.

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

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

Signature:

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

المَعلمات

المرتجعات:

الوعد<AggregateQuerySnapshot<{ count: AggregateField<number>؛ }, AppModelType, DbModelType>>

وعد سيتمّ حلّه مع العد يمكن استرداد العدد من snapshot.data().count، حيث يشير snapshot إلى AggregateQuerySnapshot الذي يحلّه الوعد الذي تم إرجاعه.

getdocs(query)

تُنفِّذ طلب البحث وتعرض النتائج في صورة QuerySnapshot.

Signature:

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

المَعلمات

المرتجعات:

وعود<QuerySnapshot<AppModelType, DbModelType>>

سمة Promise سيتم حلّها بنتائج طلب البحث.

getdocsFromCache(query)

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

Signature:

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

المَعلمات

المرتجعات:

وعود<QuerySnapshot<AppModelType, DbModelType>>

سمة Promise سيتم حلّها بنتائج طلب البحث.

getdocsFromServer(query)

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

Signature:

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

المَعلمات

المرتجعات:

وعود<QuerySnapshot<AppModelType, DbModelType>>

سمة Promise سيتم حلّها بنتائج طلب البحث.

onSnapshot(query, Monitoringr)

ترفق أداة معالجة الأحداث لـ QuerySnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror. يمكن إلغاء المستمع من خلال استدعاء الدالة التي يتم عرضها عند استدعاء onSnapshot.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

onSnapshot(query, options, Monitoringr)

ترفق أداة معالجة الأحداث لـ QuerySnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror. يمكن إلغاء المستمع من خلال استدعاء الدالة التي يتم عرضها عند استدعاء onSnapshot.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

onSnapshot(query, onNext, onError, onComplete)

ترفق أداة معالجة الأحداث لـ QuerySnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror. يمكن إلغاء المستمع من خلال استدعاء الدالة التي يتم عرضها عند استدعاء onSnapshot.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

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

ترفق أداة معالجة الأحداث لـ QuerySnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror. يمكن إلغاء المستمع من خلال استدعاء الدالة التي يتم عرضها عند استدعاء onSnapshot.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

query(query, compositeFilter, queryConstraints)

تنشئ مثيلاً جديدًا غير قابل للتغيير من طلب البحث والذي تم توسيعه ليشمل أيضًا قيود طلبات البحث الإضافية.

Signature:

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

المَعلمات

المرتجعات:

طلب البحث<AppModelType, DbModelType>

الاستثناءات

إذا تعذر دمج أي من قيود طلبات البحث المقدمة مع القيود الحالية أو الجديدة.

query(query, queryConstraints)

تنشئ مثيلاً جديدًا غير قابل للتغيير من طلب البحث والذي تم توسيعه ليشمل أيضًا قيود طلبات البحث الإضافية.

Signature:

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

المَعلمات

المرتجعات:

طلب البحث<AppModelType, DbModelType>

الاستثناءات

إذا تعذر دمج أي من قيود طلبات البحث المقدمة مع القيود الحالية أو الجديدة.

function(queryConstraints, ...)

و(queryConstraints)

تنشئ هذه الدالة QueryCompositeFilterConstraint الجديدة جنبًا إلى جنب مع قيود الفلاتر المحددة. يشمل فلتر عوامل الجمع مستندًا إذا كان يتوافق مع جميع الفلاتر المحددة.

Signature:

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

المَعلمات

المرتجعات:

QueryCompositeFilterConstraint

QueryCompositeFilterConstraint الذي تم إنشاؤه حديثًا.

or(queryConstraints)

تنشئ هذه الدالة QueryCompositeFilterConstraint الجديدة التي تفصل بين قيود الفلاتر المحددة. يتضمن فلتر الفصل مستندًا مستندًا إذا كان يتوافق مع أي من الفلاتر المحددة.

Signature:

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

المَعلمات

المرتجعات:

QueryCompositeFilterConstraint

QueryCompositeFilterConstraint الذي تم إنشاؤه حديثًا.

function(reference, ...)

addDoc(reference, data)

يمكنك إضافة مستند جديد إلى CollectionReference المحدّد باستخدام البيانات المحدّدة، مع تعيين معرّف المستند تلقائيًا له.

Signature:

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

المَعلمات

المرتجعات:

Promise<DocumentReference<AppModelType, DbModelType>>

تم حلّ مشكلة Promise مع وجود DocumentReference يشير إلى المستند الذي تم إنشاؤه حديثًا بعد كتابته في الخلفية (يُرجى العلم أنّه لن يتم حل المشكلة أثناء عدم الاتصال بالإنترنت).

group(reference, path, pathSegments)

يتم الحصول على مثال CollectionReference يشير إلى مجموعة فرعية من reference في المسار النسبي المحدّد.

Signature:

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

المَعلمات

المرتجعات:

CollectionReference<DocumentData، وDocumentData>

المثيل CollectionReference

الاستثناءات

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

group(reference, path, pathSegments)

يتم الحصول على مثال CollectionReference يشير إلى مجموعة فرعية من reference في المسار النسبي المحدّد.

Signature:

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

المَعلمات

المرتجعات:

CollectionReference<DocumentData، وDocumentData>

المثيل CollectionReference

الاستثناءات

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

deleteDoc(reference)

يؤدي هذا الإجراء إلى حذف المستند المُشار إليه من خلال DocumentReference المحدَّد.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تم التعامل بشكل نهائي مع وعد بعد حذف المستند بنجاح من الخلفية (يُرجى العِلم أنّه لن يتم حلّ المشكلة أثناء عدم الاتصال بالإنترنت).

doc(reference, path, pathSegments)

يتم الحصول على نسخة افتراضية من DocumentReference تشير إلى مستند داخل reference في المسار النسبي المحدَّد. إذا لم يتم تحديد أي مسار، سيتم استخدام معرّف فريد يتم إنشاؤه تلقائيًا للسمة DocumentReference المعروضة.

Signature:

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

المَعلمات

المرتجعات:

DocumentReference <AppModelType, DbModelType>

المثيل DocumentReference

الاستثناءات

إذا كان المسار النهائي يحتوي على عدد فردي من المقاطع ولا يشير إلى مستند.

doc(reference, path, pathSegments)

يتم الحصول على نسخة افتراضية من DocumentReference تشير إلى مستند داخل reference في المسار النسبي المحدَّد.

Signature:

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

المَعلمات

المرتجعات:

DocumentReference<DocumentData، وDocumentData>

المثيل DocumentReference

الاستثناءات

إذا كان المسار النهائي يحتوي على عدد فردي من المقاطع ولا يشير إلى مستند.

getDoc(reference)

يقرأ المستند المشار إليه في DocumentReference هذا.

Signature:

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

المَعلمات

المرتجعات:

وعود<DocumentSnapshot<AppModelType, DbModelType>>

تم التعامل مع وعد مع DocumentSnapshot يتضمّن محتوى المستند الحالي.

getDocFromcache(reference)

تتم قراءة المستند المُشار إليه من خلال DocumentReference من ذاكرة التخزين المؤقت. تعرض رسالة خطأ إذا لم يكن المستند مخزَّنًا مؤقتًا في الوقت الحالي.

Signature:

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

المَعلمات

المرتجعات:

وعود<DocumentSnapshot<AppModelType, DbModelType>>

تمت معالجة Promise مع DocumentSnapshot يتضمّن محتوى المستند الحالي.

getDocFromServer(reference)

يقرأ المستند المُشار إليه من خلال DocumentReference هذا من الخادم. تعرض رسالة خطأ إذا كانت الشبكة غير متاحة.

Signature:

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

المَعلمات

المرتجعات:

وعود<DocumentSnapshot<AppModelType, DbModelType>>

تمت معالجة Promise مع DocumentSnapshot يتضمّن محتوى المستند الحالي.

onSnapshot(reference, noticer)

ترفق أداة معالجة الأحداث لـ DocumentSnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

onSnapshot(reference, options, Monitoringr)

ترفق أداة معالجة الأحداث لـ DocumentSnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

onSnapshot(reference, onNext, onError, onComplete)

ترفق أداة معالجة الأحداث لـ DocumentSnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

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

ترفق أداة معالجة الأحداث لـ DocumentSnapshot. يمكنك إما تمرير استدعاءات فردية من onNext وonError أو تمرير كائن مراقب واحد مع استدعاءَي next وerror.

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

Signature:

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;

المَعلمات

المرتجعات:

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

يشير ذلك المصطلح إلى دالة إلغاء الاشتراك التي يمكن استدعاؤها لإلغاء أداة معالجة اللقطات.

setDoc(reference, data)

تتم الكتابة على المستند المُشار إليه في DocumentReference. إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تم حلّ Promise بعد كتابة البيانات بنجاح في الخلفية (يُرجى العلم أنّه لن يتم حلّ المشكلة أثناء عدم الاتصال بالإنترنت).

setDoc(reference, data, options)

تتم الكتابة على المستند المُشار إليه من خلال DocumentReference المحدَّد. إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. في حال تقديم merge أو mergeFields، يمكن دمج البيانات المقدَّمة في مستند حالي.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تم التعامل بشكل نهائي مع وعد بعد كتابة البيانات بنجاح في الخلفية (يُرجى العِلم أنّه لن يتم حلّ المشكلة أثناء عدم الاتصال بالإنترنت).

UpdateDoc(reference, data)

لتعديل الحقول في المستند المُشار إليه من خلال DocumentReference المحدَّد. سيتعذر التعديل في حال تطبيقه على مستند غير موجود.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تم حلّ Promise بعد كتابة البيانات بنجاح في الخلفية (يُرجى العلم أنّه لن يتم حلّ المشكلة أثناء عدم الاتصال بالإنترنت).

UpdateDoc(reference, field, value, moreFieldsAndValues)

لتعديل الحقول في المستند الذي تمت الإشارة إليه من قِبل DocumentReference المحدَّد، سيتعذر التعديل إذا تم تطبيقه على مستند غير موجود.

يمكن تعديل الحقول المتداخلة من خلال توفير سلاسل مسارات حقول مفصولة بالنقاط أو من خلال توفير عناصر FieldPath.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

تم حلّ Promise بعد كتابة البيانات بنجاح في الخلفية (يُرجى العلم أنّه لن يتم حلّ المشكلة أثناء عدم الاتصال بالإنترنت).

function(settings, ...)

MemoryLocalcache(settings)

تنشئ مثيلاً لـ MemoryLocalCache. يمكن ضبط المثيل على FirestoreSettings.cache لإعلام حزمة تطوير البرامج (SDK) بطبقة ذاكرة التخزين المؤقت المطلوب استخدامها.

Signature:

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

المَعلمات

المرتجعات:

ذاكرة التخزين المؤقت للذاكرة

cacheLruGarbageCollector(الإعدادات)

تنشئ مثيلاً لـ MemoryLruGarbageCollector.

يمكن تحديد حجم مستهدف كجزء من مَعلمة الإعداد. ستبدأ أداة التجميع في حذف المستندات بعد تجاوز حجم ذاكرة التخزين المؤقت للحجم المحدّد. حجم ذاكرة التخزين المؤقت الافتراضي هو 40 ميغابايت (40 * 1024 * 1024 بايت).

Signature:

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

المَعلمات

المرتجعات:

MemoryLruGarbageCollector

SustainLocalcache(settings)

تنشئ مثيلاً لـ PersistentLocalCache. يمكن ضبط المثيل على FirestoreSettings.cache لإعلام حزمة تطوير البرامج (SDK) بطبقة ذاكرة التخزين المؤقت المطلوب استخدامها.

لا يمكن استخدام ذاكرة التخزين المؤقت الثابتة في بيئة Node.js.

Signature:

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

المَعلمات

المرتجعات:

PersistentLocalcache

SustainsingleTabManager(settings)

تنشئ مثيلاً لـ PersistentSingleTabManager.

Signature:

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

المَعلمات

المرتجعات:

PersistentsingleTabManager

الدالة(لقطة، ...)

endAt(snapshot)

تنشئ دالة QueryEndAtConstraint تعديل مجموعة النتائج لتنتهي في المستند المقدَّم (شامل). يرتبط موضع النهاية بترتيب الاستعلام. يجب أن يحتوي المستند على جميع الحقول المقدّمة بترتيب orderBy في طلب البحث.

Signature:

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

المَعلمات

المرتجعات:

QueryEndAtConstraint

A QueryEndAtConstraint للانتقال إلى query()

endBefore(snapshot)

تنشئ دالة QueryEndAtConstraint تعديل مجموعة النتائج لتنتهي قبل المستند المقدَّم (بشكل حصري). يرتبط موضع النهاية بترتيب الاستعلام. يجب أن يحتوي المستند على جميع الحقول المقدّمة بترتيب orderBy في طلب البحث.

Signature:

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

المَعلمات

المرتجعات:

QueryEndAtConstraint

A QueryEndAtConstraint للانتقال إلى query()

startafter(snapshot)

تنشئ هذه السياسة QueryStartAtConstraint لتعديل مجموعة النتائج للبدء بعد المستند المتوفّر (حصريًا). يرتبط موضع البداية بترتيب الاستعلام. يجب أن يحتوي المستند على جميع الحقول المقدّمة بترتيب orderBy في طلب البحث.

Signature:

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

المَعلمات

المرتجعات:

QueryStartAtConstraint

QueryStartAtConstraint للانتقال إلى query()

startAt(snapshot)

تنشئ هذه الدالة QueryStartAtConstraint لتعديل مجموعة النتائج للبدء في المستند المقدَّم (شامل). يرتبط موضع البداية بترتيب الاستعلام. يجب أن يحتوي المستند على جميع الحقول المقدَّمة في orderBy الخاص بطلب البحث هذا.

Signature:

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

المَعلمات

المرتجعات:

QueryStartAtConstraint

A QueryStartAtConstraint للانتقال إلى query().

function(values, ...)

متجه(قيم)

تنشئ قيمة VectorValue جديدة تم إنشاؤها باستخدام نسخة من مصفوفة الأرقام المحدّدة.

Signature:

export declare function vector(values?: number[]): VectorValue;

المَعلمات

المرتجعات:

VectorValue

تم إنشاء VectorValue جديد باستخدام نسخة من مصفوفة الأرقام المحدّدة.

ذاكرة التخزين المؤقت بلا حدود

يجب إيقاف العنصر الثابت المستخدم للإشارة إلى جمع البيانات غير المرغوب فيها ضمن "التطبيقات القابلة لإعادة الاستخدام" (LRU). عيِّن هذه القيمة باعتبارها cacheSizeBytes في الإعدادات التي تم تمريرها إلى مثيل Firestore.

Signature:

CACHE_SIZE_UNLIMITED = -1

إضافة بادئة إلى مفاتيح

لعرض خريطة جديدة يسبق كل مفتاح فيها إلحاق المفتاح الخارجي بنقطة.

Signature:

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

نوع الحقل المجمّع

تمثّل هذه السمة الاتحاد بين جميع أنواع AggregateField المتوافقة مع Firestore.

Signature:

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

البيانات المجمّعة

يشير ذلك المصطلح إلى نوع يتم الحصول على مفاتيحه من AggregateSpec وتكون قيمه نتيجة التجميع الذي يتم إجراؤه من خلال السمة AggregateField المقابلة له من الإدخال AggregateSpec.

Signature:

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

نوع التجميع

نوع الاتحاد الذي يمثل النوع المجمّع المطلوب تنفيذه.

Signature:

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

ChildUpdateFields

مساعد لحساب الحقول المتداخلة لنوع معيّن من T1. وهذا الإجراء مطلوب لتوزيع أنواع الاتحاد، مثل undefined | {...} (يحدث ذلك للمستلزمات الاختيارية) أو {a: A} | {b: B}.

في حالة الاستخدام هذه، يتم استخدام V لتوزيع أنواع الاتحاد T[K] على Record، لأنّ T[K] يتم تقييمه كتعبير وليس موزَّعًا.

يمكنك الاطّلاع على https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types.

Signature:

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

نوع تغيير المستند

يمكن "إضافة" أو "إزالة" أو "تعديل" نوع DocumentChange.

Signature:

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

رمز FirestoreErrorCode

مجموعة رموز الحالة Firestore. تكون الرموز هي نفسها للرموز التي يعرضها gRPC هنا: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

القيم المحتملة: - "تم الإلغاء": تم إلغاء العملية (عادةً بواسطة المتصل). - "غير معروف": خطأ غير معروف أو خطأ من نطاق خطأ مختلف. - 'spam-argument': حدّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ هذا الشرط يختلف عن الحالة "تعذّر إكمال العملية". "وسيطة غير صالحة" تشير إلى الوسيطات التي تمثل مشاكل بغض النظر عن حالة النظام (مثل اسم حقل غير صالح). - "تم تجاوز الموعد النهائي": انتهت صلاحية الموعد النهائي قبل اكتمال العملية. بالنسبة للعمليات التي تغير حالة النظام، قد يتم عرض هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد تتأخر الاستجابة الناجحة من الخادم لفترة كافية لتنتهي صلاحية الموعد النهائي. - "لم يتم العثور على الصفحة": لم يتم العثور على بعض المستندات المطلوبة. - "موجود من قبل": بعض المستندات التي حاولنا إنشائها موجودة من قبل. - "تم رفض الإذن": لا يملك المتصل إذنًا لتنفيذ العملية المحددة. - "تم استنفاد الموارد": ربما تم استنفاد بعض الموارد، أو ربما الحصة لكل مستخدم، أو نفاد المساحة في نظام الملفات بالكامل. - 'failed-precondition': تم رفض العملية لأنّ النظام ليس في حالة مطلوبة لتنفيذ العملية. - "إلغاء": تم إلغاء العملية، وذلك عادةً بسبب مشكلة تتعلق بالتزامن مثل عمليات إلغاء المعاملة أو ما إلى ذلك - "خارج النطاق": تمت محاولة العملية خارج النطاق الصالح. - "غير مُنفذة": لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعَّلة - "داخلي": أخطاء داخلية يعني ذلك أنّ بعض القيم الثابتة التي يتوقعها النظام الأساسي قد تعطّلت. إذا رأيت أحد هذه الأخطاء، فهذا يعني أن شيئًا معطّلاً للغاية. - "غير متاحة": الخدمة غير متاحة حاليًا. هذه حالة عابرة على الأرجح عابرة ويمكن تصحيحها عن طريق إعادة المحاولة بالتراجع. - "data-loss" (فقدان البيانات): تلف أو فقدان بيانات غير قابل للإصلاح. - "لم تتم المصادقة": لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

Signature:

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

نوع الاتحاد من طبقة ذاكرة التخزين المؤقت لحزمة SDK المتوافقة.

Signature:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

مصدر الاستماع

صِف المصدر الذي يستمع إليه الاستعلام.

اضبط القيمة على default للاستماع إلى التغييرات في ذاكرة التخزين المؤقت والخادم. يمكنك ضبط القيمة على cache للاستماع إلى التغييرات في ذاكرة التخزين المؤقت فقط.

Signature:

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

منصّة جامع القمامة

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

Signature:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

حقول التحديث المتداخلة

بالنسبة إلى كل حقل (مثل "bar")، ابحث عن كل المفاتيح المضمّنة (مثل {'bar.baz': T1, 'bar.qux': T2}). اتقاطع بينها لإنشاء خريطة واحدة تحتوي على جميع المفاتيح الممكنة التي تم تصنيفها جميعًا على أنها اختيارية

Signature:

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

الطلب حسب الاتجاه

يتم تحديد اتجاه عبارة orderBy() بالصيغة "desc" أو "asc" (ترتيب تنازلي أو تصاعدي)

Signature:

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

جزء من قيمة الحقل

على غرار Partial<T> في TypeScript، ولكنها تسمح بحذف الحقول المتداخلة وتمرير قيمة FieldValues كقيم سمات.

Signature:

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

أداة PersistentTabManager

اتحاد جميع مديري علامات التبويب المتاحة

Signature:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

أساسي

الأنواع الأولية.

Signature:

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

نوع QueryConstraintType

يصِف هذا القسم قيود طلبات البحث المختلفة المتاحة في حزمة تطوير البرامج (SDK) هذه.

Signature:

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

فلتر QueryFilterConstraint

QueryFilterConstraint هو نوع اتحاد مساعد يمثل QueryFieldFilterConstraint وQueryCompositeFilterConstraint.

Signature:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint هو نوع اتحاد مساعد يمثّل QueryConstraints التي تُستخدم لتضييق مجموعة المستندات أو ترتيبها، ولكنها لا تعمل على الفلترة بشكل صريح في حقل المستند. QueryNonFilterConstraintيتم إنشاء من خلال استدعاء orderBy() أو startAt() أو startafter() أو endBefore() أو endAt() أو limit() أو limitToLast() ويمكن تمريرها إلى query() لإنشاء مثيل جديد يحتوي أيضًا على مثيل جديد.QueryConstraint

Signature:

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

خيارات الإعداد

كائن خيارات يضبط سلوك setDoc() وعمليات الاستدعاء. يمكن ضبط هذه الطلبات لإجراء عمليات دمج دقيقة بدلاً من استبدال المستندات المستهدفة بالكامل من خلال توفير SetOptions مع merge: true.

Signature:

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

حالة المهمة

ويمثِّل ذلك حالة مهام تحميل الحزمة.

كل من "خطأ" و"Success" حالة غرق: سيتم إلغاء المهمة أو اكتمالها ولن يكون هناك المزيد من التحديثات بعد الإبلاغ عنها.

Signature:

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

تقاطع طرق الاتحاد

وفقًا لنوع الاتحاد U = T1 | T2 | ...، يتم عرض نوع متقاطع (T1 & T2 & ...).

تستخدم الأنواع الشرطية التوزيعية والاستنتاج من الأنواع الشرطية. يعمل هذا لأن تعدد العناصر المرشحة لمتغير النوع نفسه في مواضع التباين المتباين تؤدي إلى استنتاج نوع التقاطع. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type

Signature:

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