Query
به پرسشی اشاره دارد که می توانید آن را بخوانید یا گوش دهید. همچنین می توانید با افزودن فیلترها و سفارش دادن، اشیاء Query
تصفیه شده را بسازید.
امضا:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
سازندگان
سازنده | اصلاح کننده ها | شرح |
---|---|---|
(سازنده)() | یک نمونه جدید از کلاس Query می سازد |
خواص
ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
---|---|---|---|
مبدل | FirestoreDataConverter <AppModelType، DbModelType> | خالی | در صورت ارائه، FirestoreDataConverter مرتبط با این نمونه است. | |
آتش نشانی | آتش نشانی | نمونه Firestore برای پایگاه داده Firestore (مفید برای انجام تراکنش ها و غیره). | |
نوع | 'پرس و جو' | 'مجموعه' | نوع این مرجع Firestore. |
مواد و روش ها
روش | اصلاح کننده ها | شرح |
---|---|---|
withConverter (مبدل) | مبدل جریان را حذف می کند. | |
withConverter (مبدل) | یک مبدل داده سفارشی را برای این پرس و جو اعمال می کند و به شما امکان می دهد از اشیاء مدل سفارشی خود با Firestore استفاده کنید. هنگامی که با پرس و جوی برگشتی ، getDocs را فرا میخوانید، مبدل ارائه شده بین دادههای Firestore از نوع NewDbModelType و نوع سفارشی شما NewAppModelType تبدیل میکند. |
پرس و جو. (سازنده)
یک نمونه جدید از کلاس Query
می سازد
امضا:
protected constructor();
Query.converter
در صورت ارائه، FirestoreDataConverter
مرتبط با این نمونه است.
امضا:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Query.firestore
نمونه Firestore
برای پایگاه داده Firestore (مفید برای انجام تراکنش ها و غیره).
امضا:
readonly firestore: Firestore;
Query.type
نوع این مرجع Firestore.
امضا:
readonly type: 'query' | 'collection';
Query.withConverter()
مبدل جریان را حذف می کند.
امضا:
withConverter(converter: null): Query<DocumentData, DocumentData>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
مبدل | خالی | null مبدل فعلی را حذف می کند. |
برمی گرداند:
پرس و جو < DocumentData , DocumentData >
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
که از مبدل ارائه شده استفاده می کند.