QuerySnapshot
में किसी क्वेरी के परिणामों का प्रतिनिधित्व करने वाले शून्य या अधिक DocumentSnapshot
ऑब्जेक्ट होते हैं। दस्तावेज़ों को docs
प्रॉपर्टी के माध्यम से एक सरणी के रूप में एक्सेस किया जा सकता है या forEach
विधि का उपयोग करके गणना की जा सकती है। दस्तावेज़ों की संख्या empty
और size
गुणों के माध्यम से निर्धारित की जा सकती है।
हस्ताक्षर:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
डॉक्स | सारणी< क्वेरीडॉक्यूमेंटस्नैपशॉट <AppModelType, DbModelType>> | QuerySnapshot में सभी दस्तावेज़ों की एक सरणी। | |
खाली | बूलियन | यदि QuerySnapshot में कोई दस्तावेज़ नहीं हैं तो यह सत्य है। | |
मेटाडाटा | स्नैपशॉटमेटाडेटा | इस स्नैपशॉट के बारे में मेटाडेटा, इसके स्रोत से संबंधित और यदि इसमें स्थानीय संशोधन हैं। | |
सवाल | सवाल <AppModelType, DbModelType> | इस QuerySnapshot प्राप्त करने के लिए जिस क्वेरी पर आपने get या onSnapshot कॉल किया था। | |
आकार | संख्या | QuerySnapshot में दस्तावेज़ों की संख्या। |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
दस्तावेज़परिवर्तन(विकल्प) | अंतिम स्नैपशॉट के बाद से दस्तावेज़ों में हुए परिवर्तनों की एक श्रृंखला लौटाता है। यदि यह पहला स्नैपशॉट है, तो सभी दस्तावेज़ 'जोड़े गए' परिवर्तनों के रूप में सूची में होंगे। | |
प्रत्येक के लिए (कॉलबैक, thisArg) | QuerySnapshot में सभी दस्तावेज़ों की गणना करता है। |
QuerySnapshot.docs
QuerySnapshot
में सभी दस्तावेज़ों की एक सरणी .
हस्ताक्षर:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.खाली
यदि QuerySnapshot
में कोई दस्तावेज़ नहीं हैं तो यह सत्य है .
हस्ताक्षर:
get empty(): boolean;
QuerySnapshot.metadata
इस स्नैपशॉट के बारे में मेटाडेटा, इसके स्रोत से संबंधित और यदि इसमें स्थानीय संशोधन हैं।
हस्ताक्षर:
readonly metadata: SnapshotMetadata;
QuerySnapshot.query
इस QuerySnapshot
प्राप्त करने के लिए जिस क्वेरी पर आपने get
या onSnapshot
कॉल किया था .
हस्ताक्षर:
readonly query: Query<AppModelType, DbModelType>;
क्वेरीस्नैपशॉट.आकार
QuerySnapshot
में दस्तावेज़ों की संख्या .
हस्ताक्षर:
get size(): number;
QuerySnapshot.docChanges()
अंतिम स्नैपशॉट के बाद से दस्तावेज़ों में हुए परिवर्तनों की एक श्रृंखला लौटाता है। यदि यह पहला स्नैपशॉट है, तो सभी दस्तावेज़ 'जोड़े गए' परिवर्तनों के रूप में सूची में होंगे।
हस्ताक्षर:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
विकल्प | स्नैपशॉटसुनेंविकल्प | SnapshotListenOptions जो नियंत्रित करते हैं कि केवल मेटाडेटा बदलता है (यानी केवल DocumentSnapshot.metadata बदला गया है) स्नैपशॉट ईवेंट को ट्रिगर करना चाहिए। |
रिटर्न:
सारणी < दस्तावेज़ परिवर्तन <AppModelType, DbModelType>>
QuerySnapshot.forEach()
QuerySnapshot
में सभी दस्तावेज़ों की गणना करता है .
हस्ताक्षर:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
वापस बुलाओ | (परिणाम: QueryDocumentSnapshot <AppModelType, DbModelType>) => शून्य | स्नैपशॉट में प्रत्येक दस्तावेज़ के लिए QueryDocumentSnapshot के साथ कॉलबैक किया जाना है। |
यह Arg | अज्ञात | कॉलबैक के लिए this बाइंडिंग है। |
रिटर्न:
खालीपन