@firebase/firestore/lite

कार्य

कक्षाओं

इंटरफेस

उपनाम टाइप करें

फ़ंक्शन (ऐप, ...)

getFirestore(ऐप)

मौजूदा डिफ़ॉल्ट फ़ायरस्टोर इंस्टेंस लौटाता है जो दिए गए फ़ायरबेसएप से संबद्ध है . यदि कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग्स के साथ एक नया इंस्टेंस आरंभ करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

इस firestore

प्रदत्त ऐप का फायरस्टोर उदाहरण।

getFirestore(ऐप, डेटाबेसआईडी)

यह एपीआई डेवलपर्स के लिए पूर्वावलोकन के रूप में प्रदान की गई है और हमें प्राप्त फीडबैक के आधार पर बदल सकती है। इस API का उपयोग उत्पादन परिवेश में न करें.

मौजूदा फायरस्टोर इंस्टेंस लौटाता है जो दिए गए फायरबेसएप से जुड़ा है . यदि कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग्स के साथ एक नया इंस्टेंस आरंभ करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

इस firestore

प्रदत्त ऐप का फायरस्टोर उदाहरण।

इनिशियलाइज़फ़ायरस्टोर(ऐप, सेटिंग्स)

प्रदान की गई सेटिंग्स के साथ क्लाउड फायरस्टोर का एक नया उदाहरण प्रारंभ करता है। केवल getFirestore() सहित किसी भी अन्य फ़ंक्शन से पहले कॉल किया जा सकता है . यदि कस्टम सेटिंग्स खाली हैं, तो यह फ़ंक्शन getFirestore() को कॉल करने के बराबर है .

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

इस firestore

एक नया आरंभिक Firestore उदाहरण।

इनिशियलाइज़फायरस्टोर (ऐप, सेटिंग्स, डेटाबेसआईडी)

यह एपीआई डेवलपर्स के लिए पूर्वावलोकन के रूप में प्रदान की गई है और हमें प्राप्त फीडबैक के आधार पर बदल सकती है। इस API का उपयोग उत्पादन परिवेश में न करें.

प्रदान की गई सेटिंग्स के साथ क्लाउड फायरस्टोर का एक नया उदाहरण प्रारंभ करता है। केवल getFirestore() सहित किसी भी अन्य फ़ंक्शन से पहले कॉल किया जा सकता है . यदि कस्टम सेटिंग्स खाली हैं, तो यह फ़ंक्शन getFirestore() को कॉल करने के बराबर है .

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

इस firestore

एक नया आरंभिक Firestore उदाहरण।

फ़ंक्शन (फ़ायरस्टोर, ...)

संग्रह (फायरस्टोर, पथ, पथखंड)

एक 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>;

पैरामीटर

रिटर्न:

सवाल < दस्तावेज़डेटा , दस्तावेज़ डेटा >

बनाई गई Query .

कनेक्टफायरस्टोरएमुलेटर (फायरस्टोर, होस्ट, पोर्ट, विकल्प)

क्लाउड फायरस्टोर एमुलेटर के साथ संचार करने के लिए इस उदाहरण को संशोधित करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

खालीपन

दस्तावेज़ (फ़ायरस्टोर, पथ, पथखंड)

एक DocumentReference उदाहरण प्राप्त होता है जो निर्दिष्ट निरपेक्ष पथ पर दस्तावेज़ को संदर्भित करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

दस्तावेज़संदर्भ < दस्तावेज़डेटा , दस्तावेज़ डेटा >

DocumentReference उदाहरण.

अपवाद

यदि अंतिम पथ में विषम संख्या में खंड हैं और यह किसी दस्तावेज़ की ओर इंगित नहीं करता है।

रनट्रांसएक्शन (फायरस्टोर, अपडेटफंक्शन, विकल्प)

दिए गए updateFunction निष्पादित करता है और फिर लेनदेन के भीतर लागू परिवर्तनों को करने का प्रयास करता है। यदि लेन-देन के भीतर पढ़ा गया कोई भी दस्तावेज़ बदल गया है, तो क्लाउड फायरस्टोर updateFunction पुनः प्रयास करता है . यदि यह 5 प्रयासों के बाद प्रतिबद्ध होने में विफल रहता है, तो लेनदेन विफल हो जाता है।

एक लेन-देन में लिखने की अधिकतम संख्या 500 है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<T>

यदि लेनदेन सफलतापूर्वक पूरा हो गया है या स्पष्ट रूप से निरस्त कर दिया गया है ( updateFunction एक असफल वादा लौटाया है), तो updateFunction द्वारा वादा वापस कर दिया गया है यहाँ लौटा दिया गया है. अन्यथा, यदि लेनदेन विफल हो जाता है, तो संबंधित विफलता त्रुटि के साथ एक अस्वीकृत वादा वापस कर दिया जाता है।

समाप्त(फायरस्टोर)

प्रदत्त Firestore उदाहरण को समाप्त करता है।

terminate() कॉल करने के बाद केवल clearIndexedDbPersistence() फ़ंक्शन का उपयोग किया जा सकता है। कोई अन्य फ़ंक्शन FirestoreError फेंक देगा . समाप्ति किसी भी लंबित लेखन को रद्द नहीं करती है, और सर्वर से प्रतिक्रिया की प्रतीक्षा कर रहे किसी भी वादे का समाधान नहीं किया जाएगा।

समाप्ति के बाद पुनः आरंभ करने के लिए, getFirestore() के साथ Firestore का एक नया उदाहरण बनाएं .

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

एक Promise जो तब हल हो जाता है जब उदाहरण सफलतापूर्वक समाप्त हो गया हो।

राइटबैच(फ़ायरस्टोर)

एक लेखन बैच बनाता है, जिसका उपयोग एकल परमाणु ऑपरेशन के रूप में एकाधिक लेखन करने के लिए किया जाता है। एक राइटबैच में लिखने की अधिकतम संख्या 500 है।

इन लेखनों का परिणाम केवल दस्तावेज़ रीड्स में प्रतिबिंबित होगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो लेखन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

राइटबैच

एक WriteBatch जिसका उपयोग परमाणु रूप से एकाधिक लेखन निष्पादित करने के लिए किया जा सकता है।

समारोह()

गिनती करना()

एक AggregateField ऑब्जेक्ट बनाएं जिसका उपयोग किसी क्वेरी के परिणाम सेट में दस्तावेज़ों की गिनती की गणना करने के लिए किया जा सकता है।

हस्ताक्षर:

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

रिटर्न:

समग्र फ़ील्ड <संख्या>

डिलीटफ़ील्ड()

किसी फ़ील्ड को हटाने के लिए चिह्नित करने के लिए updateDoc() या setDoc() के साथ {merge: true} के उपयोग के लिए एक प्रहरी लौटाता है।

हस्ताक्षर:

export declare function deleteField(): FieldValue;

रिटर्न:

फ़ील्डवैल्यू

दस्तावेज़ आईडी()

किसी दस्तावेज़ की आईडी को संदर्भित करने के लिए एक विशेष प्रहरी FieldPath लौटाता है। इसका उपयोग प्रश्नों में दस्तावेज़ आईडी के आधार पर सॉर्ट या फ़िल्टर करने के लिए किया जा सकता है।

हस्ताक्षर:

export declare function documentId(): FieldPath;

रिटर्न:

फ़ील्डपथ

getFirestore()

मौजूदा डिफ़ॉल्ट फ़ायरस्टोर इंस्टेंस लौटाता है जो डिफ़ॉल्ट फ़ायरबेसऐप से संबद्ध है . यदि कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग्स के साथ एक नया इंस्टेंस आरंभ करता है।

हस्ताक्षर:

export declare function getFirestore(): Firestore;

रिटर्न:

इस firestore

प्रदत्त ऐप का फायरस्टोर उदाहरण।

सर्वरटाइमस्टैम्प()

लिखित डेटा में सर्वर-जनरेटेड टाइमस्टैम्प को शामिल करने के लिए setDoc() या updateDoc() के साथ उपयोग किया गया एक सेंटिनल लौटाता है।

हस्ताक्षर:

export declare function serverTimestamp(): FieldValue;

रिटर्न:

फ़ील्डवैल्यू

फ़ंक्शन (डेटाबेस आईडी, ...)

getFirestore(डेटाबेसआईडी)

यह एपीआई डेवलपर्स के लिए पूर्वावलोकन के रूप में प्रदान की गई है और हमें प्राप्त फीडबैक के आधार पर बदल सकती है। इस API का उपयोग उत्पादन परिवेश में न करें.

मौजूदा फ़ायरस्टोर इंस्टेंस लौटाता है जो डिफ़ॉल्ट फ़ायरबेसऐप से संबद्ध है . यदि कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग्स के साथ एक नया इंस्टेंस आरंभ करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

इस firestore

प्रदत्त ऐप का फायरस्टोर उदाहरण।

फ़ंक्शन(तत्व, ...)

सारणीनिकालें(तत्व)

एक विशेष मान लौटाता है जिसका उपयोग setDoc() के साथ किया जा सकता है या जो सर्वर को सर्वर पर पहले से मौजूद किसी भी सरणी मान से दिए गए तत्वों को हटाने के लिए कहता है। निर्दिष्ट प्रत्येक तत्व के सभी उदाहरण सरणी से हटा दिए जाएंगे। यदि संशोधित किया जा रहा फ़ील्ड पहले से ही एक सरणी नहीं है तो इसे एक खाली सरणी के साथ अधिलेखित कर दिया जाएगा।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

फ़ील्डवैल्यू

setDoc() या updateDoc() पर कॉल में उपयोग के लिए FieldValue प्रहरी

ऐरेयूनियन(तत्व)

एक विशेष मान लौटाता है जिसका उपयोग setDoc() या updateDoc() के साथ किया जा सकता है जो सर्वर को दिए गए तत्वों को सर्वर पर पहले से मौजूद किसी भी सरणी मान के साथ जोड़ने के लिए कहता है। प्रत्येक निर्दिष्ट तत्व जो पहले से ही सरणी में मौजूद नहीं है, उसे अंत में जोड़ा जाएगा। यदि संशोधित किया जा रहा फ़ील्ड पहले से ही एक सरणी नहीं है, तो इसे बिल्कुल निर्दिष्ट तत्वों वाली एक सरणी के साथ अधिलेखित कर दिया जाएगा।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

फ़ील्डवैल्यू

setDoc() या updateDoc() पर कॉल में उपयोग के लिए FieldValue प्रहरी .

फ़ंक्शन(फ़ील्ड,...)

औसत(फ़ील्ड)

एक AggregateField ऑब्जेक्ट बनाएं जिसका उपयोग क्वेरी के परिणाम सेट में दस्तावेज़ों की एक श्रृंखला पर निर्दिष्ट फ़ील्ड के औसत की गणना करने के लिए किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

समग्र फ़ील्ड <संख्या | शून्य>

योग(फ़ील्ड)

एक AggregateField ऑब्जेक्ट बनाएं जिसका उपयोग किसी क्वेरी के परिणाम सेट में दस्तावेज़ों की एक श्रृंखला पर निर्दिष्ट फ़ील्ड के योग की गणना करने के लिए किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

समग्र फ़ील्ड <संख्या>

फ़ंक्शन (फ़ील्डपाथ, ...)

orderBy(फ़ील्डपाथ, दिशाStr)

एक QueryOrderByConstraint बनाता है जो क्वेरी परिणाम को निर्दिष्ट फ़ील्ड के अनुसार वैकल्पिक रूप से आरोही के बजाय अवरोही क्रम में क्रमबद्ध करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryOrderByConstraint

बनाया गया QueryOrderByConstraint .

कहाँ (फ़ील्डपाथ, opStr, मान)

एक QueryFieldFilterConstraint बनाता है जो यह लागू करता है कि दस्तावेज़ों में निर्दिष्ट फ़ील्ड होनी चाहिए और मान को प्रदान की गई संबंध बाधा को पूरा करना चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryFieldFilterConstraint

बनाया गया QueryFieldFilterConstraint .

फ़ंक्शन (फ़ील्ड वैल्यूज़, ...)

अंत(फ़ील्डवैल्यूज़)

एक QueryEndAtConstraint बनाता है जो क्वेरी के क्रम के सापेक्ष प्रदान किए गए फ़ील्ड पर समाप्त होने वाले परिणाम सेट को संशोधित करता है। फ़ील्ड मानों का क्रम क्वेरी के खंडों के क्रम से मेल खाना चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryEndAtConstraint

क्वेरी को पास करने के लिए एक QueryEndAtConstraint query()

अंत से पहले (फ़ील्ड वैल्यूज़)

एक QueryEndAtConstraint बनाता है जो क्वेरी के क्रम के सापेक्ष प्रदान किए गए फ़ील्ड से पहले परिणाम सेट को संशोधित करता है। फ़ील्ड मानों का क्रम क्वेरी के खंडों के क्रम से मेल खाना चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryEndAtConstraint

क्वेरी को पास करने के लिए एक QueryEndAtConstraint query()

प्रारंभ के बाद (फ़ील्ड वैल्यूज़)

एक QueryStartAtConstraint बनाता है जो क्वेरी के क्रम के सापेक्ष प्रदान किए गए फ़ील्ड के बाद प्रारंभ करने के लिए परिणाम सेट को संशोधित करता है। फ़ील्ड मानों का क्रम क्वेरी के खंडों के क्रम से मेल खाना चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryStartAtConstraint

क्वेरी को पास करने के लिए एक QueryStartAtConstraint query()

प्रारंभ(फ़ील्डवैल्यू)

एक QueryStartAtConstraint बनाता है जो क्वेरी के क्रम के सापेक्ष प्रदान किए गए फ़ील्ड पर प्रारंभ करने के लिए परिणाम सेट को संशोधित करता है। फ़ील्ड मानों का क्रम क्वेरी के खंडों के क्रम से मेल खाना चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryStartAtConstraint

क्वेरी को पास करने के लिए एक QueryStartAtConstraint query() .

फ़ंक्शन(बाएं,...)

एग्रीगेटफ़ील्डइक्वल(बाएँ, दाएँ)

दो 'एग्रीगेटफ़ील्ड' की तुलना करता है 'समानता के उदाहरण।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

बूलियन

एग्रीगेटक्वेरीस्नैपशॉटएक्वाल(बाएँ, दाएँ)

समानता के लिए दो 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;

पैरामीटर

रिटर्न:

बूलियन

यदि संदर्भ समान फायरस्टोर डेटाबेस में समान स्थान की ओर इशारा करते हैं तो यह सत्य है।

RefEqual(बाएँ, दाएँ)

यदि दिए गए संदर्भ समान हैं तो सत्य लौटाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

बूलियन

यदि संदर्भ समान फायरस्टोर डेटाबेस में समान स्थान की ओर इशारा करते हैं तो यह सत्य है।

स्नैपशॉटबराबर(बाएँ, दाएँ)

यदि दिए गए स्नैपशॉट बराबर हैं तो सत्य लौटाता है।

हस्ताक्षर:

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 बनाता है जो केवल अंतिम मिलान वाले दस्तावेज़ लौटाता है।

आपको limitToLast क्वेरीज़ के लिए कम से कम एक orderBy क्लॉज निर्दिष्ट करना होगा, अन्यथा निष्पादन के दौरान एक अपवाद फेंक दिया जाएगा।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryLimitConstraint

निर्मित QueryLimitConstraint .

फ़ंक्शन (लॉगलेवल, ...)

सेटलॉगलेवल(लॉगलेवल)

क्लाउड फायरस्टोर लॉग (डीबग, त्रुटि, या साइलेंट) की वर्बोसिटी सेट करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

खालीपन

फ़ंक्शन(एन, ...)

वेतन वृद्धि(एन)

एक विशेष मान लौटाता है जिसका उपयोग setDoc() या updateDoc() के साथ किया जा सकता है जो सर्वर को फ़ील्ड के वर्तमान मान को दिए गए मान से बढ़ाने के लिए कहता है।

यदि ऑपरेंड या वर्तमान फ़ील्ड मान फ़्लोटिंग पॉइंट परिशुद्धता का उपयोग करता है, तो सभी अंकगणित आईईईई 754 शब्दार्थ का पालन करते हैं। यदि दोनों मान पूर्णांक हैं, तो मान जावास्क्रिप्ट की सुरक्षित संख्या सीमा से बाहर हैं ( Number.MIN_SAFE_INTEGER से Number.MAX_SAFE_INTEGER ) भी परिशुद्धता हानि के अधीन हैं। इसके अलावा, एक बार फायरस्टोर बैकएंड द्वारा संसाधित होने के बाद, सभी पूर्णांक संचालन -2^63 और 2^63-1 के बीच सीमित हो जाते हैं।

यदि वर्तमान फ़ील्ड मान प्रकार number का नहीं है , या यदि फ़ील्ड अभी तक मौजूद नहीं है, तो परिवर्तन फ़ील्ड को दिए गए मान पर सेट करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

फ़ील्डवैल्यू

setDoc() या updateDoc() पर कॉल में उपयोग के लिए FieldValue प्रहरी

फ़ंक्शन (क्वेरी, ...)

getएग्रीगेट(क्वेरी, एग्रीगेटस्पेक)

दस्तावेज़ों को वास्तव में डाउनलोड किए बिना दिए गए क्वेरी के परिणाम सेट में दस्तावेज़ों पर निर्दिष्ट एकत्रीकरण की गणना करता है।

एकत्रीकरण करने के लिए इस फ़ंक्शन का उपयोग करना कुशल है क्योंकि केवल अंतिम एकत्रीकरण मान डाउनलोड किए जाते हैं, दस्तावेज़ों का डेटा नहीं। यह फ़ंक्शन उन मामलों में दस्तावेज़ों का एकत्रीकरण कर सकता है जहां परिणाम सेट पूरी तरह से डाउनलोड करने के लिए निषेधात्मक रूप से बड़ा है (हजारों दस्तावेज़)।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< AggregateQuerySnapshot <एग्रीगेटस्पेकटाइप, ऐपमॉडलटाइप, डीबीमॉडलटाइप>>

उदाहरण

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;

गिनती प्राप्त करें(क्वेरी)

दस्तावेज़ों को वास्तव में डाउनलोड किए बिना दी गई क्वेरी के परिणाम सेट में दस्तावेज़ों की संख्या की गणना करता है।

दस्तावेज़ों को गिनने के लिए इस फ़ंक्शन का उपयोग करना कुशल है क्योंकि केवल अंतिम गिनती डाउनलोड की जाती है, दस्तावेज़ों का डेटा नहीं। यह फ़ंक्शन उन मामलों में दस्तावेज़ों की गिनती कर सकता है जहां परिणाम सेट पूरी तरह से डाउनलोड करने के लिए निषेधात्मक रूप से बड़ा है (हजारों दस्तावेज़)।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< AggregateQuerySnapshot <{गिनती: समग्र फ़ील्ड <संख्या>; }, ऐपमॉडलटाइप, डीबीमॉडलटाइप>>

एक वादा जो गिनती के साथ हल हो जाएगा; गिनती snapshot.data().count से प्राप्त की जा सकती है , जहां snapshot AggregateQuerySnapshot है जिस पर लौटाया गया वादा हल हो जाता है।

getDocs(क्वेरी)

क्वेरी निष्पादित करता है और परिणाम QuerySnapshot के रूप में लौटाता है .

सभी क्वेरीज़ सीधे सर्वर द्वारा निष्पादित की जाती हैं, भले ही क्वेरी पहले निष्पादित की गई हो। हाल के संशोधन केवल पुनर्प्राप्त परिणामों में दिखाई देते हैं यदि वे पहले से ही बैकएंड द्वारा लागू किए गए हैं। यदि क्लाइंट ऑफ़लाइन है, तो ऑपरेशन विफल हो जाता है। पहले से कैश किए गए परिणाम और स्थानीय संशोधनों को देखने के लिए, पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< क्वेरीस्नैपशॉट <AppModelType, DbModelType>>

एक वादा जिसका समाधान क्वेरी के परिणामों के साथ किया जाएगा।

क्वेरी(क्वेरी, कंपोजिटफ़िल्टर, क्वेरीकॉन्स्ट्रेन्ट्स)

क्वेरी का एक नया अपरिवर्तनीय उदाहरण बनाता है जिसे अतिरिक्त क्वेरी बाधाओं को भी शामिल करने के लिए विस्तारित किया जाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

सवाल <AppModelType, DbModelType>

अपवाद

यदि प्रदान की गई किसी भी क्वेरी बाधा को मौजूदा या नई बाधाओं के साथ नहीं जोड़ा जा सकता है।

क्वेरी(क्वेरी, क्वेरी बाधाएं)

क्वेरी का एक नया अपरिवर्तनीय उदाहरण बनाता है जिसे अतिरिक्त क्वेरी बाधाओं को भी शामिल करने के लिए विस्तारित किया जाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

सवाल <AppModelType, DbModelType>

अपवाद

यदि प्रदान की गई किसी भी क्वेरी बाधा को मौजूदा या नई बाधाओं के साथ नहीं जोड़ा जा सकता है।

फ़ंक्शन (क्वेरी बाधाएं, ...)

और(क्वेरी बाधाएं)

एक नया QueryCompositeFilterConstraint बनाता है जो दिए गए फ़िल्टर बाधाओं का एक संयोजन है। एक संयोजन फ़िल्टर में एक दस्तावेज़ शामिल होता है यदि यह दिए गए सभी फ़िल्टर को संतुष्ट करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryCompositeFilterConstraint

नव निर्मित QueryCompositeFilterConstraint .

या (क्वेरी बाधाएं)

एक नया QueryCompositeFilterConstraint बनाता है जो दिए गए फ़िल्टर बाधाओं का एक संयोजन है। एक विच्छेदन फ़िल्टर में एक दस्तावेज़ शामिल होता है यदि यह दिए गए किसी भी फ़िल्टर को संतुष्ट करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryCompositeFilterConstraint

नव निर्मित QueryCompositeFilterConstraint .

फ़ंक्शन(संदर्भ, ...)

addDoc(संदर्भ, डेटा)

दिए गए डेटा के साथ निर्दिष्ट CollectionReference में एक नया दस्तावेज़ जोड़ें, इसे स्वचालित रूप से एक दस्तावेज़ आईडी निर्दिष्ट करें।

इस लेखन का परिणाम केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो लेखन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा < दस्तावेज़ संदर्भ <AppModelType, DbModelType>>

बैकएंड पर लिखे जाने के बाद नए बनाए गए दस्तावेज़ की ओर इशारा करते हुए DocumentReference के साथ एक Promise हल हो गया।

अपवाद

त्रुटि - यदि प्रदान किया गया इनपुट वैध फायरस्टोर दस्तावेज़ नहीं है।

संग्रह (संदर्भ, पथ, पथखंड)

एक CollectionReference उदाहरण प्राप्त होता है जो निर्दिष्ट सापेक्ष पथ पर reference के उपसंग्रह को संदर्भित करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

संग्रह संदर्भ < दस्तावेज़डेटा , दस्तावेज़ डेटा >

CollectionReference उदाहरण.

अपवाद

यदि अंतिम पथ में खंडों की संख्या सम है और यह संग्रह की ओर इंगित नहीं करता है।

संग्रह (संदर्भ, पथ, पथखंड)

एक CollectionReference उदाहरण प्राप्त होता है जो निर्दिष्ट सापेक्ष पथ पर reference के उपसंग्रह को संदर्भित करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

संग्रह संदर्भ < दस्तावेज़डेटा , दस्तावेज़ डेटा >

CollectionReference उदाहरण.

अपवाद

यदि अंतिम पथ में खंडों की संख्या सम है और यह संग्रह की ओर इंगित नहीं करता है।

डिलीटडॉक(संदर्भ)

निर्दिष्ट DocumentReference द्वारा संदर्भित दस्तावेज़ को हटा देता है .

विलोपन केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो डिलीट विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

दस्तावेज़ को बैकएंड से सफलतापूर्वक हटा दिए जाने के बाद एक Promise हल हो गया।

दस्तावेज़ (संदर्भ, पथ, पथखंड)

एक 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 उदाहरण.

अपवाद

यदि अंतिम पथ में विषम संख्या में खंड हैं और यह किसी दस्तावेज़ की ओर इंगित नहीं करता है।

दस्तावेज़ (संदर्भ, पथ, पथखंड)

एक DocumentReference उदाहरण प्राप्त होता है जो निर्दिष्ट सापेक्ष पथ पर reference के भीतर एक दस्तावेज़ को संदर्भित करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

दस्तावेज़संदर्भ < दस्तावेज़डेटा , दस्तावेज़ डेटा >

DocumentReference उदाहरण.

अपवाद

यदि अंतिम पथ में विषम संख्या में खंड हैं और यह किसी दस्तावेज़ की ओर इंगित नहीं करता है।

getDoc(संदर्भ)

निर्दिष्ट दस्तावेज़ संदर्भ द्वारा संदर्भित दस्तावेज़ को पढ़ता है।

सभी दस्तावेज़ सीधे सर्वर से प्राप्त किए जाते हैं, भले ही दस्तावेज़ पहले पढ़ा गया हो या संशोधित किया गया हो। हाल के संशोधन केवल पुनर्प्राप्त DocumentSnapshot में दिखाई देते हैं यदि वे पहले से ही बैकएंड द्वारा लागू किए गए हैं। यदि क्लाइंट ऑफ़लाइन है, तो रीड विफल हो जाता है। यदि आप कैशिंग का उपयोग करना या स्थानीय संशोधन देखना पसंद करते हैं, तो कृपया पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा < दस्तावेज़ स्नैपशॉट <AppModelType, DbModelType>>

वर्तमान दस्तावेज़ सामग्री वाले DocumentSnapshot के साथ एक वादा हल हो गया।

सेटडॉक (संदर्भ, डेटा)

निर्दिष्ट DocumentReference द्वारा संदर्भित दस्तावेज़ को लिखता है . यदि दस्तावेज़ अभी तक मौजूद नहीं है, तो इसे बनाया जाएगा।

इस लेखन का परिणाम केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो लेखन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

बैकएंड पर डेटा सफलतापूर्वक लिखे जाने के बाद एक Promise हल हो गया।

अपवाद

त्रुटि - यदि प्रदान किया गया इनपुट वैध फायरस्टोर दस्तावेज़ नहीं है।

सेटडॉक (संदर्भ, डेटा, विकल्प)

निर्दिष्ट DocumentReference द्वारा संदर्भित दस्तावेज़ को लिखता है . यदि दस्तावेज़ अभी तक मौजूद नहीं है, तो इसे बनाया जाएगा। यदि आप merge या mergeFields प्रदान करते हैं , प्रदान किए गए डेटा को मौजूदा दस्तावेज़ में मर्ज किया जा सकता है।

इस लेखन का परिणाम केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो लेखन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

बैकएंड पर डेटा सफलतापूर्वक लिखे जाने के बाद एक Promise हल हो गया।

अपवाद

त्रुटि - यदि प्रदान किया गया इनपुट वैध फायरस्टोर दस्तावेज़ नहीं है।

updateDoc(संदर्भ, डेटा)

निर्दिष्ट DocumentReference द्वारा संदर्भित दस्तावेज़ में फ़ील्ड को अद्यतन करता है . यदि किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है तो अद्यतन विफल हो जाएगा।

इस अद्यतन का परिणाम केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो अद्यतन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

बैकएंड पर डेटा सफलतापूर्वक लिखे जाने के बाद एक Promise हल हो गया।

अपवाद

त्रुटि - यदि प्रदान किया गया इनपुट मान्य फायरस्टोर डेटा नहीं है।

updateDoc(संदर्भ, फ़ील्ड, मान, अधिक फ़ील्ड्सएंडवैल्यूज़)

निर्दिष्ट DocumentReference द्वारा संदर्भित दस्तावेज़ में अद्यतन फ़ील्ड यदि किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है तो अद्यतन विफल हो जाएगा।

नेस्टेड फ़ील्ड को डॉट-पृथक फ़ील्ड पथ स्ट्रिंग प्रदान करके या FieldPath ऑब्जेक्ट प्रदान करके अद्यतन किया जा सकता है।

इस अद्यतन का परिणाम केवल दस्तावेज़ रीड में दिखाई देगा जो लौटाए गए वादे के समाधान के बाद होता है। यदि क्लाइंट ऑफ़लाइन है, तो अद्यतन विफल हो जाता है। यदि आप क्लाइंट के ऑनलाइन होने तक स्थानीय संशोधन या बफर राइट्स देखना चाहते हैं, तो पूर्ण फायरस्टोर एसडीके का उपयोग करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

बैकएंड पर डेटा सफलतापूर्वक लिखे जाने के बाद एक Promise हल हो गया।

अपवाद

त्रुटि - यदि प्रदान किया गया इनपुट मान्य फायरस्टोर डेटा नहीं है।

फ़ंक्शन (स्नैपशॉट, ...)

अंत(स्नैपशॉट)

एक QueryEndAtConstraint बनाता है जो दिए गए दस्तावेज़ (समावेशी) पर परिणाम सेट को संशोधित करता है। अंतिम स्थिति क्वेरी के क्रम से संबंधित है। दस्तावेज़ में क्वेरी के क्रम में दिए गए सभी फ़ील्ड शामिल होने चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryEndAtConstraint

क्वेरी को पास करने के लिए एक QueryEndAtConstraint query()

अंतपहले(स्नैपशॉट)

एक QueryEndAtConstraint बनाता है जो प्रदान किए गए दस्तावेज़ (अनन्य) से पहले परिणाम सेट को संशोधित करता है। अंतिम स्थिति क्वेरी के क्रम से संबंधित है। दस्तावेज़ में क्वेरी के क्रम में दिए गए सभी फ़ील्ड शामिल होने चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryEndAtConstraint

क्वेरी को पास करने के लिए एक QueryEndAtConstraint query()

प्रारंभ के बाद (स्नैपशॉट)

एक QueryStartAtConstraint बनाता है जो प्रदान किए गए दस्तावेज़ (अनन्य) के बाद प्रारंभ करने के लिए परिणाम सेट को संशोधित करता है। प्रारंभिक स्थिति क्वेरी के क्रम से संबंधित है। दस्तावेज़ में क्वेरी के क्रम में दिए गए सभी फ़ील्ड शामिल होने चाहिए।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

QueryStartAtConstraint

क्वेरी को पास करने के लिए एक QueryStartAtConstraint query()

प्रारंभ(स्नैपशॉट)

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

समग्र फ़ील्ड प्रकार

सभी AggregateField प्रकारों का संघ जो Firestore द्वारा समर्थित है।

हस्ताक्षर:

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

एग्रीगेटस्पेकडेटा

एक प्रकार जिसकी कुंजियाँ AggregateSpec से ली गई हैं , और जिनके मान इनपुट AggregateSpec से संबंधित AggregateField द्वारा किए गए एकत्रीकरण का परिणाम हैं .

हस्ताक्षर:

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

समुच्चय प्रकार

यूनियन प्रकार निष्पादित किए जाने वाले समग्र प्रकार का प्रतिनिधित्व करता है।

हस्ताक्षर:

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

चाइल्डअपडेटफ़ील्ड्स

किसी दिए गए प्रकार T1 के लिए नेस्टेड फ़ील्ड की गणना के लिए सहायक। undefined | {...} जैसे यूनियन प्रकारों को वितरित करने के लिए इसकी आवश्यकता है undefined | {...} (वैकल्पिक प्रॉप्स के लिए होता है) या {a: A} | {b: B} .

इस उपयोग के मामले में, V उपयोग 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;

फायरस्टोर एररकोड

फायरस्टोर स्थिति कोड का सेट। यहां जीआरपीसी द्वारा उजागर किए गए कोड समान हैं: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

संभावित मान: - 'रद्द': ऑपरेशन रद्द कर दिया गया था (आमतौर पर कॉल करने वाले द्वारा)। - 'अज्ञात': अज्ञात त्रुटि या किसी भिन्न त्रुटि डोमेन से त्रुटि। - 'अमान्य-तर्क': क्लाइंट ने एक अमान्य तर्क निर्दिष्ट किया। ध्यान दें कि यह 'असफल-पूर्व शर्त' से भिन्न है। 'अमान्य-तर्क' उन तर्कों को इंगित करता है जो सिस्टम की स्थिति की परवाह किए बिना समस्याग्रस्त हैं (उदाहरण के लिए एक अमान्य फ़ील्ड नाम)। - 'समय सीमा समाप्त': ऑपरेशन पूरा होने से पहले ही समय सीमा समाप्त हो गई। सिस्टम की स्थिति को बदलने वाले ऑपरेशनों के लिए, यह त्रुटि वापस आ सकती है, भले ही ऑपरेशन सफलतापूर्वक पूरा हो गया हो। उदाहरण के लिए, सर्वर से एक सफल प्रतिक्रिया में समय सीमा समाप्त होने में काफी देरी हो सकती है। - 'नहीं मिला': कुछ अनुरोधित दस्तावेज़ नहीं मिला। - 'पहले से मौजूद है': कुछ दस्तावेज़ जिन्हें हमने बनाने का प्रयास किया था वे पहले से मौजूद हैं। - 'अनुमति-अस्वीकृत': कॉल करने वाले के पास निर्दिष्ट ऑपरेशन निष्पादित करने की अनुमति नहीं है। - 'संसाधन समाप्त': कुछ संसाधन समाप्त हो गए हैं, शायद प्रति-उपयोगकर्ता कोटा, या शायद संपूर्ण फ़ाइल सिस्टम स्थान से बाहर है। - 'विफल-पूर्व शर्त': ऑपरेशन को अस्वीकार कर दिया गया क्योंकि सिस्टम ऑपरेशन के निष्पादन के लिए आवश्यक स्थिति में नहीं है। - 'निरस्त': ऑपरेशन निरस्त कर दिया गया था, आमतौर पर लेन-देन निरस्त होने आदि जैसी समवर्ती समस्या के कारण। - 'आउट-ऑफ-रेंज': ऑपरेशन को वैध सीमा से परे करने का प्रयास किया गया था। - 'कार्यान्वित': ऑपरेशन क्रियान्वित नहीं है या समर्थित/सक्षम नहीं है। - 'आंतरिक': आंतरिक त्रुटियाँ। इसका मतलब है कि अंतर्निहित प्रणाली द्वारा अपेक्षित कुछ अपरिवर्तनीयताएँ टूट गई हैं। यदि आप इनमें से एक त्रुटि देखते हैं, तो कुछ बहुत टूटा हुआ है। - 'अनुपलब्ध': सेवा वर्तमान में अनुपलब्ध है। यह संभवतः एक क्षणिक स्थिति है और इसे बैकऑफ़ के साथ पुनः प्रयास करके ठीक किया जा सकता है। - 'डेटा-हानि': अप्राप्य डेटा हानि या भ्रष्टाचार। - 'अप्रमाणित': अनुरोध में ऑपरेशन के लिए वैध प्रमाणीकरण क्रेडेंशियल नहीं हैं।

हस्ताक्षर:

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

नेस्टेडअपडेटफ़ील्ड्स

प्रत्येक फ़ील्ड (उदाहरण के लिए 'बार') के लिए, सभी नेस्टेड कुंजियाँ ढूंढें (उदाहरण के लिए { 'बार.बाज़': टी1, 'बार.क्यूएक्स': टी2 } ). उन्हें एक साथ जोड़कर एक एकल मानचित्र बनाएं जिसमें सभी संभावित कुंजियाँ हों जिन्हें वैकल्पिक के रूप में चिह्नित किया गया हो

हस्ताक्षर:

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

ऑर्डरबायडायरेक्शन

ऑर्डरबाय() क्लॉज की दिशा 'desc' या 'asc' (अवरोही या आरोही) के रूप में निर्दिष्ट है।

हस्ताक्षर:

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

आंशिकविथफ़ील्डवैल्यू

टाइपस्क्रिप्ट के Partial<T> के समान , लेकिन नेस्टेड फ़ील्ड को छोड़ने और फ़ील्ड वैल्यू को संपत्ति मान के रूप में पारित करने की अनुमति देता है।

हस्ताक्षर:

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 एक सहायक संघ प्रकार है जो QueryFieldFilterConstraint और QueryCompositeFilterConstraint का प्रतिनिधित्व करता है .

हस्ताक्षर:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint एक सहायक संघ प्रकार है जो QueryConstraints का प्रतिनिधित्व करता है जिसका उपयोग दस्तावेज़ों के सेट को संकीर्ण या व्यवस्थित करने के लिए किया जाता है, लेकिन यह दस्तावेज़ फ़ील्ड पर स्पष्ट रूप से फ़िल्टर नहीं करता है। QueryNonFilterConstraint s orderBy() को लागू करके बनाए जाते हैं , पर शुरू करें() , प्रारंभ के बाद() , अंतपहले() , पर समाप्त() , लिमिट() या लिमिटटूलास्ट() और फिर एक नया क्वेरी इंस्टेंस बनाने के लिए इसे क्वेरी() में पास किया जा सकता है जिसमें QueryConstraint भी शामिल है .

हस्ताक्षर:

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

विकल्प सेट करें

एक विकल्प ऑब्जेक्ट जो setDoc() के व्यवहार को कॉन्फ़िगर करता है , और कॉल। इन कॉलों को मर्ज के साथ SetOptions प्रदान करके लक्ष्य दस्तावेज़ों को उनकी संपूर्णता में ओवरराइट करने के बजाय ग्रैन्युलर मर्ज करने के लिए कॉन्फ़िगर किया जा सकता है merge: true .

हस्ताक्षर:

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

यूनियनटूइंटरसेक्शन

एक संघ प्रकार U = T1 | T2 | ... दिया गया है 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 -प्रकार

हस्ताक्षर:

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

व्हेयरफ़िल्टरऑप

व्हेयर() क्लॉज में फ़िल्टर की स्थितियाँ '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains' स्ट्रिंग्स का उपयोग करके निर्दिष्ट की जाती हैं। , 'अंदर', 'सरणी-समाहित-कोई', और 'अंदर'।

हस्ताक्षर:

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

फ़ील्डवैल्यू के साथ

प्रकार की सुरक्षा बनाए रखते हुए फ़ील्डवैल्यू को प्रॉपर्टी मान के रूप में पारित करने की अनुमति देता है।

हस्ताक्षर:

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