@firebase/firestore/lite

المهام

الطبقات

واجهات

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

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

احصل على فايرستور (التطبيق)

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

إمضاء:

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

حدود

عائدات:

فايرستور

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

getFirestore (التطبيق، معرف قاعدة البيانات)

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

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

إمضاء:

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

حدود

عائدات:

فايرستور

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

تهيئةFirestore (التطبيق، الإعدادات)

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

إمضاء:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

حدود

عائدات:

فايرستور

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

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

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

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

إمضاء:

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

حدود

عائدات:

فايرستور

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

وظيفة (فيرستور، ...)

المجموعة (firestore، path، pathSegments)

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

إمضاء:

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

حدود

عائدات:

مرجع المجموعة < بيانات الوثيقة ، بيانات الوثيقة >

مثيل CollectionReference .

الاستثناءات

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

مجموعة المجموعة (متجر النار، معرف المجموعة)

إنشاء وإرجاع مثيل 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;

حدود

عائدات:

فارغ

DOC (Firestore ، Path ، PathSegments)

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

إمضاء:

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

حدود

عائدات:

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

مثيل DocumentReference .

الاستثناءات

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

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 عاد هنا. خلاف ذلك ، إذا فشلت المعاملة ، يتم إرجاع الوعد المرفوض مع خطأ الفشل المقابل.

إنهاء (Firestore)

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

بعد استدعاء terminate() فقط يمكن استخدام وظائف clearIndexedDbPersistence() . أي وظيفة أخرى سوف ترمي FirestoreError . لا يلغي الإنهاء أي كتابة معلقة ، ولن يتم حل أي وعود تنتظر استجابة من الخادم.

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

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

WriteBatch (Firestore)

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

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

إمضاء:

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

حدود

عائدات:

WriteBatch

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

وظيفة()

عدد()

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

إمضاء:

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

عائدات:

إطعام <رقم>

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 للتطبيق المقدم.

servertimestamp ()

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

إمضاء:

export declare function serverTimestamp(): FieldValue;

عائدات:

قيمة الحقل

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

getFirestore (databaseid)

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

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

إمضاء:

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

حدود

عائدات:

فايرستور

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

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

arrayremove (عناصر)

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

إمضاء:

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

حدود

عائدات:

قيمة الحقل

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

Arrayunion (عناصر)

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

إمضاء:

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

حدود

عائدات:

قيمة الحقل

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

وظيفة (الحقل ، ...)

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

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

إمضاء:

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

حدود

عائدات:

إطعام <العدد | فارغ>

مجموع (حقل)

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

إمضاء:

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

حدود

عائدات:

إطعام <رقم>

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

ترتيب حسب (fieldPath، DirectionsStr)

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

إمضاء:

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

حدود

عائدات:

QueryOrderByConstraint

تم إنشاء QueryOrderByConstraint .

حيث (FieldPath ، Opstr ، Value)

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

إمضاء:

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

حدود

عائدات:

QueryfieldFilterConstraint

تم إنشاء QueryFieldFilterConstraint .

وظيفة (القيم الحقل ، ...)

endat (القيم الميدانية)

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

إمضاء:

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

حدود

عائدات:

Queryendatconstraint

queryendatconstraint لتمرير query()

endbefore (القيم الميدانية)

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

إمضاء:

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

حدود

عائدات:

Queryendatconstraint

queryendatconstraint لتمرير query()

ابدأ بعد (قيم الحقل)

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

إمضاء:

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

حدود

عائدات:

QueryStartAtconstraint

querystartatconstraint لتمرير query()

Startat (القيم الميدانية)

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

إمضاء:

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

حدود

عائدات:

QueryStartAtconstraint

querystartatconstraint لتمرير query() .

الدالة (يسار،...)

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

يقارن اثنين ' حالات للمساواة.

إمضاء:

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

حدود

عائدات:

منطقية

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

يقارن اثنين من حالات AggregateQuerySnapshot للمساواة.

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

إمضاء:

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 (يسار ، يمين)

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

إمضاء:

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

حدود

عائدات:

منطقية

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

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

إرجاع صحيح إذا كانت المراجع المقدمة متساوية.

إمضاء:

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

حدود

عائدات:

منطقية

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

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

إرجاع صحيح إذا كانت اللقطات المقدمة متساوية.

إمضاء:

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

حدود

عائدات:

منطقية

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

وظيفة (الحد، ...)

الحد (الحد)

يخلق querylimitconstraint الذي يعيد فقط المستندات المطابقة الأولى.

إمضاء:

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

حدود

عائدات:

QueryLimitConstraint

تم إنشاء QueryLimitConstraint .

ليميتتولاست(الحد)

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

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

إمضاء:

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

حدود

عائدات:

QueryLimitConstraint

تم إنشاء QueryLimitConstraint .

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

setLoglevel (loglevel)

يحدد فعل سجلات السحابة Firestore (تصحيح أو خطأ أو صامت).

إمضاء:

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

حدود

عائدات:

فارغ

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

الزيادة (ن)

إرجاع قيمة خاصة يمكن استخدامها مع setDoc () أو updatedOC () التي تخبر الخادم بزيادة القيمة الحالية للحقل بالقيمة المحددة.

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

إذا كانت قيمة الحقل الحالية ليست من number النوع ، أو إذا لم يكن الحقل موجودًا بعد ، فإن التحول يضع الحقل على القيمة المحددة.

إمضاء:

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

حدود

عائدات:

قيمة الحقل

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

وظيفة (استعلام ، ...)

getAggregate(استعلام، تجميعالمواصفات)

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

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

إمضاء:

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

حدود

عائدات:

وعد < acmgregequerysnapshot <comphectpectype ، appmodeltype ، dbmodeltype >>

مثال

const aggregateSnapshot = await getAggregate(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;

getCount (استعلام)

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

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

إمضاء:

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

حدود

عائدات:

وعد < acmgregequerysnapshot < <number> ؛ } ، appmodeltype ، dbmodeltype >>

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

الحصول على المستندات (الاستعلام)

ينفذ الاستعلام ويعيد النتائج باعتباره Querysnapshot .

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

إمضاء:

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

حدود

عائدات:

وعد < querysnapshot <appmodeltype ، dbmodeltype >>

الوعد الذي سيتم حله مع نتائج الاستعلام.

استعلام (استعلام ، مركب ، queryconstraints)

ينشئ مثيلًا جديدًا للاستعلام يتم تمديده ليشمل أيضًا قيودًا إضافية على الاستعلام.

إمضاء:

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

حدود

عائدات:

استفسار <appmodeltype ، dbmodeltype>

الاستثناءات

إذا كان لا يمكن دمج أي من قيود الاستعلام المقدمة مع القيود الحالية أو الجديدة.

استعلام (استعلام ، QueryConstraints)

ينشئ مثيلًا جديدًا للاستعلام يتم تمديده ليشمل أيضًا قيودًا إضافية على الاستعلام.

إمضاء:

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

حدود

عائدات:

استفسار <appmodeltype ، dbmodeltype>

الاستثناءات

إذا كان لا يمكن دمج أي من قيود الاستعلام المقدمة مع القيود الحالية أو الجديدة.

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

و (QueryConstraints)

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

إمضاء:

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

حدود

عائدات:

QueryCompositeFilterConstraint

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

أو (QueryConstraints)

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

إمضاء:

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

حدود

عائدات:

QueryCompositeFilterConstraint

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

وظيفة (مرجع ، ...)

adddoc (مرجع ، بيانات)

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

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

إمضاء:

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

حدود

عائدات:

وعد < documentReference <appmodeltype ، dbmodeltype >>

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

الاستثناءات

خطأ - إذا لم يكن الإدخال المقدم وثيقة Firestore صالحة.

المجموعة (المرجع، المسار، شرائح المسار)

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

إمضاء:

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

حدود

عائدات:

جمع < documentData ، documentData >

مثيل CollectionReference .

الاستثناءات

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

المجموعة (المرجع، المسار، شرائح المسار)

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

إمضاء:

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

حدود

عائدات:

جمع < documentData ، documentData >

مثيل CollectionReference .

الاستثناءات

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

Deletedoc (مرجع)

يحذف المستند المشار إليه من خلال DocumentReference المحددة .

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

تم حل Promise بمجرد حذف المستند بنجاح من الواجهة الخلفية.

DOC (المرجع ، المسار ، المسار)

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

إمضاء:

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

حدود

عائدات:

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

مثيل DocumentReference .

الاستثناءات

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

DOC (المرجع ، المسار ، المسار)

يحصل على مثيل DocumentReference يشير إلى مستند ضمن reference في المسار النسبي المحدد.

إمضاء:

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

حدود

عائدات:

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

مثيل DocumentReference .

الاستثناءات

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

getDoc (مرجع)

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

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

إمضاء:

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

حدود

عائدات:

وعد < documentsnapshot <appmodeltype ، dbmodeltype >>

وعد تم حله باستخدام DocumentSnapshot التي تحتوي على محتويات المستند الحالية.

setDOC (مرجع ، بيانات)

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

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

تم حل Promise بمجرد كتابة البيانات بنجاح إلى الواجهة الخلفية.

الاستثناءات

خطأ - إذا لم يكن الإدخال المقدم وثيقة Firestore صالحة.

setDOC (المرجع ، البيانات ، الخيارات)

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

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

تم حل Promise بمجرد كتابة البيانات بنجاح إلى الواجهة الخلفية.

الاستثناءات

خطأ - إذا لم يكن الإدخال المقدم وثيقة Firestore صالحة.

updatedoc (المرجع ، البيانات)

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

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

تم حل Promise بمجرد كتابة البيانات بنجاح إلى الواجهة الخلفية.

الاستثناءات

خطأ - إذا كان الإدخال غير المقدم غير صالح لبيانات Firestore.

UpdateDoc(مرجع، حقل، قيمة، moreFieldsAndValues)

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

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

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

إمضاء:

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

حدود

عائدات:

وعد<باطل>

تم حل Promise بمجرد كتابة البيانات بنجاح إلى الواجهة الخلفية.

الاستثناءات

خطأ - إذا كان الإدخال غير المقدم غير صالح لبيانات Firestore.

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

endat (لقطة)

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

إمضاء:

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

حدود

عائدات:

Queryendatconstraint

queryendatconstraint لتمرير query()

endbefore (لقطة)

ينشئ queryendatconstraint الذي يعدل النتيجة التي تم تعيينها قبل الانتهاء قبل المستند المقدم (الحصري). الموقف النهائي يتعلق بترتيب الاستعلام. يجب أن تحتوي المستند على جميع الحقول المقدمة بترتيب الاستعلام.

إمضاء:

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

حدود

عائدات:

Queryendatconstraint

queryendatconstraint لتمرير query()

startafter (لقطة)

ينشئ QueryStartAtconstraint يعدل النتيجة التي تم تعيينها للبدء بعد المستند المقدم (حصريًا). موقف البداية بالنسبة إلى ترتيب الاستعلام. يجب أن تحتوي المستند على جميع الحقول المقدمة بترتيب الاستعلام.

إمضاء:

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

حدود

عائدات:

QueryStartAtconstraint

querystartatconstraint لتمرير query()

Startat (لقطة)

ينشئ QueryStartAtconstraint يعدل النتيجة التي تم تعيينها للبدء في المستند المقدم (شامل). موقف البداية بالنسبة إلى ترتيب الاستعلام. يجب أن تحتوي المستند على جميع الحقول المقدمة في orderBy هذا الاستعلام.

إمضاء:

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

حدود

عائدات:

QueryStartAtconstraint

querystartatconstraint لتمرير query() .

addprefixtokeys

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

إمضاء:

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

ascregatefieldtype

اتحاد جميع أنواع AggregateField التي تدعمها Firestore.

إمضاء:

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

الركام

نوع مأخوذ مفاتيحه من AggregateSpec والتي هي قيمها هي نتيجة التجميع التي يؤديها AggregateField المقابل من إدخال AggregateSpec .

إمضاء:

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

aggregateType

نوع الاتحاد الذي يمثل النوع الكلي المراد تنفيذه.

إمضاء:

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

childupdatefields

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

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

انظر 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;

FirestoreerRorCode

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

القيم المحتملة: - "إلغاء": تم إلغاء العملية (عادةً بواسطة المتصل). - "غير معروف": خطأ غير معروف أو خطأ من مجال خطأ مختلف. - 'argument invalid': حدد العميل وسيطة غير صالحة. لاحظ أن هذا يختلف عن "الشرط الفاشل". يشير "argument غير صالح" إلى الحجج التي تكون مشكلة بغض النظر عن حالة النظام (على سبيل المثال اسم حقل غير صالح). - "الموعد النهائي الموعد النهائي": انتهت الموعد النهائي قبل انتهاء العملية. بالنسبة للعمليات التي تغير حالة النظام ، قد يتم إرجاع هذا الخطأ حتى إذا كانت العملية قد اكتملت بنجاح. على سبيل المثال ، كان من الممكن تأخير استجابة ناجحة من الخادم لفترة طويلة بما يكفي لإنهاء الموعد النهائي. - "غير مؤسس": لم يتم العثور على بعض المستند المطلوب. - "موجود بالفعل": بعض المستندات التي حاولنا إنشاءها موجودة بالفعل. - "الإذن المنقولة": لا يحتوي المتصل على إذن لتنفيذ العملية المحددة. -"الموارد التي يتم تنقيتها": تم استنفاد بعض الموارد ، وربما حصة لكل مستخدم ، أو ربما نظام الملفات بأكمله خارج الفضاء. - "الإثارة الفاشلة": تم رفض العملية لأن النظام ليس في حالة مطلوبة لتنفيذ العملية. - "تم إحباط": تم إحباط العملية ، وعادةً ما تكون بسبب مسألة التزامن مثل إحباط المعاملات ، وما إلى ذلك- "خارج المدى": تمت محاولة العملية تجاوز النطاق الصحيح. - 'Unecteded': لم يتم تنفيذ العملية أو عدم دعمها/تمكينها. - "داخلي": الأخطاء الداخلية. تعني أن بعض الثوابات المتوقعة من قبل النظام الأساسي قد تم كسرها. إذا رأيت أحد هذه الأخطاء ، فسيكون هناك شيء مكسور للغاية. - "غير متوفر": الخدمة غير متوفرة حاليًا. هذا على الأرجح حالة عابرة ويمكن تصحيحها من خلال إعادة المحاولة باستخدام التراجع. - "فقدان البيانات": فقدان البيانات أو الفساد غير قابل للاسترداد. - "غير مصادقة": لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

إمضاء:

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

NETTERUPDATEFIELDS

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

إمضاء:

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

Orderbydirection

يتم تحديد اتجاه شرط orderby () على أنه "desc" أو "ASC" (تنازلي أو تصاعدي).

إمضاء:

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

partialwithfieldvalue

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

إمضاء:

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

بدائية

الأنواع البدائية.

إمضاء:

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

QueryConstrainttype

يصف قيود الاستعلام المختلفة المتاحة في هذا SDK.

إمضاء:

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

QueryFilterConstraint

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

إمضاء:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QuerynonfilterConstraint

QueryNonFilterConstraint هو نوع من الاتحاد المساعد الذي يمثل QueryConstraints المستخدمة لتضييق أو طلب مجموعة المستندات ، ولكن لا يتم تصفية بشكل صريح على حقل المستند. QueryNonFilterConstraint يتم إنشاء S عن طريق استدعاء Orderby () ، تبدأ في() ، startafter () ، endbefore () ، يغلق عند مستوى() ، limit () أو limittolast () ويمكن بعد ذلك تمريرها إلى الاستعلام () لإنشاء مثيل استعلام جديد يحتوي أيضًا على QueryConstraint .

إمضاء:

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

setOptions

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

إمضاء:

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

UnionToEntersection

إعطاء نوع الاتحاد 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-inters -يكتب

إمضاء:

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

تحديث البيانات

تحديث البيانات (للاستخدام مع updatedoc () ) تتكون من مسارات الحقل (على سبيل المثال "foo" أو "foo.baz") تم تعيينها للقيم. الحقول التي تحتوي على نقاط مرجعية الحقول المتداخلة داخل المستند. يمكن تمرير القيم الميدانية في قيم الممتلكات.

إمضاء:

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

WhateFilterop

شروط التصفية في A Where () يتم تحديد جملة باستخدام الأوتار '& lt ؛' ، '& lt ؛ =' ، '==' ، '! =' ، '& gt ؛ =' ، '& gt ؛' ، 'array-contains' ، "في" ، "صفيفات الصفيف-أي" ، و "غير في".

إمضاء:

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

WithfieldValue

يتيح أن يتم تمرير القيم الحقل كقيمة خاصية مع الحفاظ على سلامة النوع.

إمضاء:

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