Query class

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

إمضاء:

export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

البنائين

البناء الصفات التعريفية وصف
(البناء)() إنشاء مثيل جديد لفئة Query

ملكيات

ملكية الصفات التعريفية يكتب وصف
محول FirestoreDataConverter <AppModelType، DbModelType> | باطل إذا تم توفيره، فإن FirestoreDataConverter مرتبط بهذا المثيل.
firestore فايرستور مثيل Firestore لقاعدة بيانات Firestore (مفيد لإجراء المعاملات، وما إلى ذلك).
يكتب "الاستعلام" | 'مجموعة' نوع مرجع Firestore هذا.

طُرق

طريقة الصفات التعريفية وصف
مع محول (محول) يزيل المحول الحالي.
مع محول (محول) يتم تطبيق محول بيانات مخصص على هذا الاستعلام، مما يسمح لك باستخدام كائنات النموذج المخصصة الخاصة بك مع Firestore. عند استدعاء getDocs() مع الاستعلام الذي تم إرجاعه، سيقوم المحول المقدم بالتحويل بين بيانات Firestore من النوع NewDbModelType والنوع المخصص NewAppModelType .

استعلام (منشئ)

إنشاء مثيل جديد لفئة Query

إمضاء:

protected constructor();

Query.converter

إذا تم توفيره، فإن FirestoreDataConverter مرتبط بهذا المثيل.

إمضاء:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

Query.firestore

مثيل Firestore لقاعدة بيانات Firestore (مفيد لإجراء المعاملات، وما إلى ذلك).

إمضاء:

readonly firestore: Firestore;

نوع الاستعلام

نوع مرجع Firestore هذا.

إمضاء:

readonly type: 'query' | 'collection';

Query.withConverter()

يزيل المحول الحالي.

إمضاء:

withConverter(converter: null): Query<DocumentData, DocumentData>;

حدود

معامل يكتب وصف
محول باطل null يزيل المحول الحالي.

عائدات:

استفسار < بيانات الوثيقة ، بيانات الوثيقة >

Query<DocumentData, DocumentData> لا يستخدم محولاً.

Query.withConverter()

يتم تطبيق محول بيانات مخصص على هذا الاستعلام، مما يسمح لك باستخدام كائنات النموذج المخصصة الخاصة بك مع Firestore. عند استدعاء getDocs() باستخدام الاستعلام الذي تم إرجاعه، سيقوم المحول المقدم بالتحويل بين بيانات Firestore من النوع NewDbModelType والنوع المخصص NewAppModelType .

إمضاء:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;

حدود

معامل يكتب وصف
محول FirestoreDataConverter <NewAppModelType، NewDbModelType> تحويل الكائنات من وإلى Firestore.

عائدات:

استفسار <NewAppModelType، NewDbModelType>

Query يستخدم المحول المتوفر.