{"_id":"@adplorg/capacitor-firebase-firestore","_rev":"3-ce1f1498a1e59fb096d597272f6ce10a","name":"@adplorg/capacitor-firebase-firestore","dist-tags":{"latest":"0.0.11"},"versions":{"0.0.8":{"name":"@adplorg/capacitor-firebase-firestore","version":"0.0.8","keywords":["capacitor","plugin","native"],"author":{"name":"kbala@adaptivedev.in"},"license":"MIT","_id":"@adplorg/capacitor-firebase-firestore@0.0.8","maintainers":[{"name":"kbala-adpl","email":"kbala@adaptivedev.in"}],"homepage":"https://github.com/adpl-repos/capacitor-firebase-firestore#readme","bugs":{"url":"https://github.com/adpl-repos/capacitor-firebase-firestore/issues"},"dist":{"shasum":"f14336cbd09e53498c0213f7edae805d3b3f28bd","tarball":"https://registry.npmjs.org/@adplorg/capacitor-firebase-firestore/-/capacitor-firebase-firestore-0.0.8.tgz","fileCount":26,"integrity":"sha512-xNjjw7grAyLqjfrfnSpPuuv4RK6dy1Pv+z+vk2sWfU8PXG4g3ENOTvAC5W1enCQ++T9pmTEHXkC5Hm/fQJJjgg==","signatures":[{"sig":"MEUCIQDYOkwUP8mqsGaibbw1j2T9jGyi9EMn8pHrvbps4oc9vAIgUPaKZd/yvhfFaTX+qA3tBGck3kltFgU7Lv8FJe0HPkA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":158626},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"1f70690da47b0b76c49224c1b564f13fa8bdf992","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"tsc && npm run docgen && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api CapacitorFirebaseFirestorePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"rm -rf dist && standard-version","prebuild":"npm run release && git push --follow-tags","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","publish-ff":"npm run build && npm publish","verify:ios":"xcodebuild -scheme AdplorgCapacitorFirebaseFirestore -destination generic/platform=iOS","verify:web":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"kbala-adpl","email":"kbala@adaptivedev.in"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/adpl-repos/capacitor-firebase-firestore.git","type":"git"},"_npmVersion":"10.9.2","description":"Capacitor plugin for firebase firestore.","directories":{},"_nodeVersion":"22.14.0","dependencies":{"rxjs":"^7.8.2","firebase":"^11.6.0"},"eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^6.0.1","rollup":"^4.30.1","prettier":"^3.4.2","swiftlint":"^2.0.0","typescript":"^5.3.3","@types/node":"^22.14.0","@capacitor/ios":"^7.0.0","@capacitor/core":"^7.2.0","standard-version":"^9.5.0","@capacitor/docgen":"^0.3.0","@capacitor/android":"^7.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.6.6","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-firestore_0.0.8_1744817432394_0.24540135291031495","host":"s3://npm-registry-packages-npm-production"}},"0.0.9":{"name":"@adplorg/capacitor-firebase-firestore","version":"0.0.9","keywords":["capacitor","plugin","native"],"author":{"name":"kbala@adaptivedev.in"},"license":"MIT","_id":"@adplorg/capacitor-firebase-firestore@0.0.9","maintainers":[{"name":"kbala-adpl","email":"kbala@adaptivedev.in"}],"homepage":"https://github.com/adpl-repos/capacitor-firebase-firestore#readme","bugs":{"url":"https://github.com/adpl-repos/capacitor-firebase-firestore/issues"},"dist":{"shasum":"de633687f02e8ab899894e1eaac5388fcbed50b7","tarball":"https://registry.npmjs.org/@adplorg/capacitor-firebase-firestore/-/capacitor-firebase-firestore-0.0.9.tgz","fileCount":26,"integrity":"sha512-fW+izDUFIJm2yhQby2ccAGLGToWK6Z6i5dIpSMCikjr2L4dgSLMWTOlfITYHZ2lOoMo+l4ZKggBwnXVxsLlEkg==","signatures":[{"sig":"MEQCIFgZ70h/KUNLAXoWTVBGSPPAEcetqwlqtVa/p+dK6h6xAiBU1DkwO1Kub5gc3xejqCzTJWMZnXsI2h3y1Vcv+OBNqA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":161257},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"72cda476917d35c6cc16356bc55c20abeb7fe603","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"tsc && npm run docgen && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api CapacitorFirebaseFirestorePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"rm -rf dist && standard-version","prebuild":"npm run release && git push --follow-tags","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","publish-ff":"npm run build && npm publish","verify:ios":"xcodebuild -scheme AdplorgCapacitorFirebaseFirestore -destination generic/platform=iOS","verify:web":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"kbala-adpl","email":"kbala@adaptivedev.in"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/adpl-repos/capacitor-firebase-firestore.git","type":"git"},"_npmVersion":"10.9.2","description":"Capacitor plugin for firebase firestore.","directories":{},"_nodeVersion":"22.14.0","dependencies":{"rxjs":"^7.8.2","firebase":"^11.6.0"},"eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^6.0.1","rollup":"^4.30.1","prettier":"^3.4.2","swiftlint":"^2.0.0","typescript":"^5.3.3","@types/node":"^22.14.0","@capacitor/ios":"^7.0.0","@capacitor/core":"^7.2.0","standard-version":"^9.5.0","@capacitor/docgen":"^0.3.0","@capacitor/android":"^7.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.6.6","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-firestore_0.0.9_1744904400627_0.20106936776643658","host":"s3://npm-registry-packages-npm-production"}},"0.0.11":{"name":"@adplorg/capacitor-firebase-firestore","version":"0.0.11","description":"Capacitor plugin for firebase firestore.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"kbala@adaptivedev.in"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adpl-repos/capacitor-firebase-firestore.git"},"bugs":{"url":"https://github.com/adpl-repos/capacitor-firebase-firestore/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"xcodebuild -scheme AdplorgCapacitorFirebaseFirestore -destination generic/platform=iOS","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","docgen":"docgen --api CapacitorFirebaseFirestorePlugin --output-readme README.md --output-json dist/docs.json","clean":"rimraf ./dist","watch":"tsc --watch","release":"rm -rf dist && standard-version","prebuild":"npm run release && git push --follow-tags","build":"tsc && npm run docgen && rollup -c rollup.config.mjs","publish-ff":"npm run build && npm publish"},"devDependencies":{"@capacitor/android":"^7.0.0","@capacitor/core":"^7.2.0","@capacitor/docgen":"^0.3.0","@capacitor/ios":"^7.0.0","@ionic/eslint-config":"^0.4.0","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0","@types/node":"^22.14.0","eslint":"^8.57.0","prettier":"^3.4.2","prettier-plugin-java":"^2.6.6","rimraf":"^6.0.1","rollup":"^4.30.1","standard-version":"^9.5.0","swiftlint":"^2.0.0","typescript":"^5.3.3"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"dependencies":{"firebase":"^11.6.0","rxjs":"^7.8.2"},"_id":"@adplorg/capacitor-firebase-firestore@0.0.11","gitHead":"c3a9d398669ed68a6b590a5c746e2112e21f4689","homepage":"https://github.com/adpl-repos/capacitor-firebase-firestore#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-lZv/ULDj8qHyf0bfGaYHkJ4tIODWfXxgkkQzY5InCybLB0XY5l8le/GDu7j5eGVgb7sCDGfS7f4cZK0m5HPKHA==","shasum":"42f74b4ba40a35549f84a54a7032943aeaff45b7","tarball":"https://registry.npmjs.org/@adplorg/capacitor-firebase-firestore/-/capacitor-firebase-firestore-0.0.11.tgz","fileCount":26,"unpackedSize":184372,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDO1VvPJd2FbCuFSn0pQHHcN1nDr3B3+ygIbFKA0/BH0QIhAO+sbkwFIeWp5lniFOVwTaKgawLNR/DHy0n807hXLVMn"}]},"_npmUser":{"name":"kbala-adpl","email":"kbala@adaptivedev.in"},"directories":{},"maintainers":[{"name":"kbala-adpl","email":"kbala@adaptivedev.in"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-firebase-firestore_0.0.11_1745047881763_0.1335907046919469"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-16T15:30:32.284Z","modified":"2025-04-19T07:31:22.111Z","0.0.8":"2025-04-16T15:30:32.595Z","0.0.9":"2025-04-17T15:40:00.843Z","0.0.11":"2025-04-19T07:31:21.940Z"},"bugs":{"url":"https://github.com/adpl-repos/capacitor-firebase-firestore/issues"},"author":{"name":"kbala@adaptivedev.in"},"license":"MIT","homepage":"https://github.com/adpl-repos/capacitor-firebase-firestore#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/adpl-repos/capacitor-firebase-firestore.git"},"description":"Capacitor plugin for firebase firestore.","maintainers":[{"name":"kbala-adpl","email":"kbala@adaptivedev.in"}],"readme":"# @adplorg/capacitor-firebase-firestore\n\nCapacitor plugin for firebase firestore.\n\n## Install\n\n```bash\nnpm install @adplorg/capacitor-firebase-firestore\nnpx cap sync\n```\n\n## API\n\n<docgen-index>\n\n* [`collection(...)`](#collection)\n* [`collectionGroup(...)`](#collectiongroup)\n* [`query(...)`](#query)\n* [`where(...)`](#where)\n* [`orderBy(...)`](#orderby)\n* [`limit(...)`](#limit)\n* [`startAt(...)`](#startat)\n* [`endAt(...)`](#endat)\n* [`startAfter(...)`](#startafter)\n* [`endBefore(...)`](#endbefore)\n* [`doc(...)`](#doc)\n* [`add(...)`](#add)\n* [`set(...)`](#set)\n* [`update(...)`](#update)\n* [`delete(...)`](#delete)\n* [`getDocs(...)`](#getdocs)\n* [`getDoc(...)`](#getdoc)\n* [`valueChanges(...)`](#valuechanges)\n* [`snapshotChanges(...)`](#snapshotchanges)\n* [`docData(...)`](#docdata)\n* [`collectionData(...)`](#collectiondata)\n* [`batch()`](#batch)\n* [`batchSet(...)`](#batchset)\n* [`batchUpdate(...)`](#batchupdate)\n* [`batchDelete(...)`](#batchdelete)\n* [`batchCommit()`](#batchcommit)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### collection(...)\n\n```typescript\ncollection<T = DocumentData>(path: string) => Promise<CollectionReference<T>>\n```\n\n| Param      | Type                |\n| ---------- | ------------------- |\n| **`path`** | <code>string</code> |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### collectionGroup(...)\n\n```typescript\ncollectionGroup<T = DocumentData>(collectionId: string) => Promise<CollectionReference<T>>\n```\n\n| Param              | Type                |\n| ------------------ | ------------------- |\n| **`collectionId`** | <code>string</code> |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### query(...)\n\n```typescript\nquery<T = DocumentData>(ref: CollectionReference<T>, constraints: QueryConstraints) => Promise<CollectionReference<T>>\n```\n\n| Param             | Type                                                                                |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**         | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`constraints`** | <code><a href=\"#queryconstraints\">QueryConstraints</a></code>                       |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### where(...)\n\n```typescript\nwhere<T = DocumentData>(ref: CollectionReference<T>, field: string, opStr: WhereFilterOp, value: any) => Promise<CollectionReference<T>>\n```\n\n| Param       | Type                                                                                |\n| ----------- | ----------------------------------------------------------------------------------- |\n| **`ref`**   | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`field`** | <code>string</code>                                                                 |\n| **`opStr`** | <code><a href=\"#wherefilterop\">WhereFilterOp</a></code>                             |\n| **`value`** | <code>any</code>                                                                    |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### orderBy(...)\n\n```typescript\norderBy<T = DocumentData>(ref: CollectionReference<T>, field: string, direction?: \"asc\" | \"desc\" | undefined) => Promise<CollectionReference<T>>\n```\n\n| Param           | Type                                                                                |\n| --------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**       | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`field`**     | <code>string</code>                                                                 |\n| **`direction`** | <code>'asc' \\| 'desc'</code>                                                        |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### limit(...)\n\n```typescript\nlimit<T = DocumentData>(ref: CollectionReference<T>, limit: number) => Promise<CollectionReference<T>>\n```\n\n| Param       | Type                                                                                |\n| ----------- | ----------------------------------------------------------------------------------- |\n| **`ref`**   | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`limit`** | <code>number</code>                                                                 |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### startAt(...)\n\n```typescript\nstartAt<T = DocumentData>(ref: CollectionReference<T>, ...fieldValues: any[]) => Promise<CollectionReference<T>>\n```\n\n| Param             | Type                                                                                |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**         | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`fieldValues`** | <code>any[]</code>                                                                  |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### endAt(...)\n\n```typescript\nendAt<T = DocumentData>(ref: CollectionReference<T>, ...fieldValues: any[]) => Promise<CollectionReference<T>>\n```\n\n| Param             | Type                                                                                |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**         | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`fieldValues`** | <code>any[]</code>                                                                  |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### startAfter(...)\n\n```typescript\nstartAfter<T = DocumentData>(ref: CollectionReference<T>, ...fieldValues: any[]) => Promise<CollectionReference<T>>\n```\n\n| Param             | Type                                                                                |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**         | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`fieldValues`** | <code>any[]</code>                                                                  |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### endBefore(...)\n\n```typescript\nendBefore<T = DocumentData>(ref: CollectionReference<T>, ...fieldValues: any[]) => Promise<CollectionReference<T>>\n```\n\n| Param             | Type                                                                                |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`ref`**         | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`fieldValues`** | <code>any[]</code>                                                                  |\n\n**Returns:** <code>Promise&lt;CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### doc(...)\n\n```typescript\ndoc<T = DocumentData>(path: string) => Promise<FirebaseDocumentReference<T>>\n```\n\n| Param      | Type                |\n| ---------- | ------------------- |\n| **`path`** | <code>string</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;&gt;</code>\n\n--------------------\n\n\n### add(...)\n\n```typescript\nadd<T = DocumentData>(ref: CollectionReference<T>, data: T) => Promise<DocumentReference>\n```\n\n| Param      | Type                                                                                |\n| ---------- | ----------------------------------------------------------------------------------- |\n| **`ref`**  | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`data`** | <code>T</code>                                                                      |\n\n**Returns:** <code>Promise&lt;<a href=\"#documentreference\">DocumentReference</a>&gt;</code>\n\n--------------------\n\n\n### set(...)\n\n```typescript\nset<T = DocumentData>(ref: FirebaseDocumentReference<T>, data: T, options?: SetOptions | undefined) => Promise<void>\n```\n\n| Param         | Type                                                                                                               |\n| ------------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`**     | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`data`**    | <code>T</code>                                                                                                     |\n| **`options`** | <code><a href=\"#setoptions\">SetOptions</a></code>                                                                  |\n\n--------------------\n\n\n### update(...)\n\n```typescript\nupdate<T = DocumentData>(ref: FirebaseDocumentReference<T>, data: UpdateData<T>) => Promise<void>\n```\n\n| Param      | Type                                                                                                               |\n| ---------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`**  | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`data`** | <code><a href=\"#updatedata\">UpdateData</a>&lt;T&gt;</code>                                                         |\n\n--------------------\n\n\n### delete(...)\n\n```typescript\ndelete(ref: FirebaseDocumentReference) => Promise<void>\n```\n\n| Param     | Type                                                                                                                                                      |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`ref`** | <code><a href=\"#documentreference\">DocumentReference</a>&lt;<a href=\"#documentdata\">DocumentData</a>, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n--------------------\n\n\n### getDocs(...)\n\n```typescript\ngetDocs<T = DocumentData>(ref: CollectionReference<T>) => Promise<QuerySnapshot<T>>\n```\n\n| Param     | Type                                                                                |\n| --------- | ----------------------------------------------------------------------------------- |\n| **`ref`** | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#querysnapshot\">QuerySnapshot</a>&lt;T&gt;&gt;</code>\n\n--------------------\n\n\n### getDoc(...)\n\n```typescript\ngetDoc<T = DocumentData>(ref: FirebaseDocumentReference<T>) => Promise<DocumentSnapshot<T>>\n```\n\n| Param     | Type                                                                                                               |\n| --------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`** | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#documentsnapshot\">DocumentSnapshot</a>&lt;T&gt;&gt;</code>\n\n--------------------\n\n\n### valueChanges(...)\n\n```typescript\nvalueChanges<T = DocumentData>(ref: CollectionReference<T>) => Observable<T[]>\n```\n\n| Param     | Type                                                                                |\n| --------- | ----------------------------------------------------------------------------------- |\n| **`ref`** | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code><a href=\"#observable\">Observable</a>&lt;T[]&gt;</code>\n\n--------------------\n\n\n### snapshotChanges(...)\n\n```typescript\nsnapshotChanges<T = DocumentData>(ref: CollectionReference<T>) => Observable<QuerySnapshot<T>>\n```\n\n| Param     | Type                                                                                |\n| --------- | ----------------------------------------------------------------------------------- |\n| **`ref`** | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code><a href=\"#observable\">Observable</a>&lt;<a href=\"#querysnapshot\">QuerySnapshot</a>&lt;T&gt;&gt;</code>\n\n--------------------\n\n\n### docData(...)\n\n```typescript\ndocData<T = DocumentData>(ref: FirebaseDocumentReference<T>) => Observable<T | undefined>\n```\n\n| Param     | Type                                                                                                               |\n| --------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`** | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code><a href=\"#observable\">Observable</a>&lt;T&gt;</code>\n\n--------------------\n\n\n### collectionData(...)\n\n```typescript\ncollectionData<T = DocumentData>(ref: CollectionReference<T>) => Observable<T[]>\n```\n\n| Param     | Type                                                                                |\n| --------- | ----------------------------------------------------------------------------------- |\n| **`ref`** | <code>CollectionReference&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n**Returns:** <code><a href=\"#observable\">Observable</a>&lt;T[]&gt;</code>\n\n--------------------\n\n\n### batch()\n\n```typescript\nbatch() => Promise<void>\n```\n\n--------------------\n\n\n### batchSet(...)\n\n```typescript\nbatchSet<T = DocumentData>(ref: FirebaseDocumentReference<T>, data: T) => Promise<void>\n```\n\n| Param      | Type                                                                                                               |\n| ---------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`**  | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`data`** | <code>T</code>                                                                                                     |\n\n--------------------\n\n\n### batchUpdate(...)\n\n```typescript\nbatchUpdate<T = DocumentData>(ref: FirebaseDocumentReference<T>, data: UpdateData<T>) => Promise<void>\n```\n\n| Param      | Type                                                                                                               |\n| ---------- | ------------------------------------------------------------------------------------------------------------------ |\n| **`ref`**  | <code><a href=\"#documentreference\">DocumentReference</a>&lt;T, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n| **`data`** | <code><a href=\"#updatedata\">UpdateData</a>&lt;T&gt;</code>                                                         |\n\n--------------------\n\n\n### batchDelete(...)\n\n```typescript\nbatchDelete(ref: FirebaseDocumentReference) => Promise<void>\n```\n\n| Param     | Type                                                                                                                                                      |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`ref`** | <code><a href=\"#documentreference\">DocumentReference</a>&lt;<a href=\"#documentdata\">DocumentData</a>, <a href=\"#documentdata\">DocumentData</a>&gt;</code> |\n\n--------------------\n\n\n### batchCommit()\n\n```typescript\nbatchCommit() => Promise<void>\n```\n\n--------------------\n\n\n### Interfaces\n\n\n#### DocumentData\n\nDocument data (for use with {@link @firebase/firestore/lite#(setDoc:1)}) consists of fields mapped to\nvalues.\n\n\n#### QueryConstraints\n\n| Prop             | Type                                                                   |\n| ---------------- | ---------------------------------------------------------------------- |\n| **`where`**      | <code>[string, <a href=\"#wherefilterop\">WhereFilterOp</a>, any]</code> |\n| **`orderBy`**    | <code>[string, string]</code>                                          |\n| **`limit`**      | <code>number</code>                                                    |\n| **`startAt`**    | <code>any</code>                                                       |\n| **`endAt`**      | <code>any</code>                                                       |\n| **`startAfter`** | <code>any</code>                                                       |\n| **`endBefore`**  | <code>any</code>                                                       |\n\n\n#### DocumentReference\n\n| Prop       | Type                |\n| ---------- | ------------------- |\n| **`id`**   | <code>string</code> |\n| **`path`** | <code>string</code> |\n\n\n#### Array\n\n| Prop         | Type                | Description                                                                                            |\n| ------------ | ------------------- | ------------------------------------------------------------------------------------------------------ |\n| **`length`** | <code>number</code> | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |\n\n| Method             | Signature                                                                                                                     | Description                                                                                                                                                                                                                                 |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **toString**       | () =&gt; string                                                                                                               | Returns a string representation of an array.                                                                                                                                                                                                |\n| **toLocaleString** | () =&gt; string                                                                                                               | Returns a string representation of an array. The elements are converted to string using their toLocalString methods.                                                                                                                        |\n| **pop**            | () =&gt; T \\| undefined                                                                                                       | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.                                                                                                          |\n| **push**           | (...items: T[]) =&gt; number                                                                                                  | Appends new elements to the end of an array, and returns the new length of the array.                                                                                                                                                       |\n| **concat**         | (...items: <a href=\"#concatarray\">ConcatArray</a>&lt;T&gt;[]) =&gt; T[]                                                       | Combines two or more arrays. This method returns a new array without modifying any existing arrays.                                                                                                                                         |\n| **concat**         | (...items: (T \\| <a href=\"#concatarray\">ConcatArray</a>&lt;T&gt;)[]) =&gt; T[]                                                | Combines two or more arrays. This method returns a new array without modifying any existing arrays.                                                                                                                                         |\n| **join**           | (separator?: string \\| undefined) =&gt; string                                                                                | Adds all the elements of an array into a string, separated by the specified separator string.                                                                                                                                               |\n| **reverse**        | () =&gt; T[]                                                                                                                  | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.                                                                                                                        |\n| **shift**          | () =&gt; T \\| undefined                                                                                                       | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.                                                                                                         |\n| **slice**          | (start?: number \\| undefined, end?: number \\| undefined) =&gt; T[]                                                            | Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.                           |\n| **sort**           | (compareFn?: ((a: T, b: T) =&gt; number) \\| undefined) =&gt; this                                                             | Sorts an array in place. This method mutates the array and returns a reference to the same array.                                                                                                                                           |\n| **splice**         | (start: number, deleteCount?: number \\| undefined) =&gt; T[]                                                                  | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.                                                                                                                      |\n| **splice**         | (start: number, deleteCount: number, ...items: T[]) =&gt; T[]                                                                 | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.                                                                                                                      |\n| **unshift**        | (...items: T[]) =&gt; number                                                                                                  | Inserts new elements at the start of an array, and returns the new length of the array.                                                                                                                                                     |\n| **indexOf**        | (searchElement: T, fromIndex?: number \\| undefined) =&gt; number                                                              | Returns the index of the first occurrence of a value in an array, or -1 if it is not present.                                                                                                                                               |\n| **lastIndexOf**    | (searchElement: T, fromIndex?: number \\| undefined) =&gt; number                                                              | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.                                                                                                                                      |\n| **every**          | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; this is S[]       | Determines whether all the members of an array satisfy the specified test.                                                                                                                                                                  |\n| **every**          | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean                                 | Determines whether all the members of an array satisfy the specified test.                                                                                                                                                                  |\n| **some**           | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean                                 | Determines whether the specified callback function returns true for any element of an array.                                                                                                                                                |\n| **forEach**        | (callbackfn: (value: T, index: number, array: T[]) =&gt; void, thisArg?: any) =&gt; void                                      | Performs the specified action for each element in an array.                                                                                                                                                                                 |\n| **map**            | &lt;U&gt;(callbackfn: (value: T, index: number, array: T[]) =&gt; U, thisArg?: any) =&gt; U[]                                 | Calls a defined callback function on each element of an array, and returns an array that contains the results.                                                                                                                              |\n| **filter**         | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; S[]               | Returns the elements of an array that meet the condition specified in a callback function.                                                                                                                                                  |\n| **filter**         | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; T[]                                     | Returns the elements of an array that meet the condition specified in a callback function.                                                                                                                                                  |\n| **reduce**         | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T                           | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.                      |\n| **reduce**         | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T          |                                                                                                                                                                                                                                             |\n| **reduce**         | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.                      |\n| **reduceRight**    | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T                           | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |\n| **reduceRight**    | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T          |                                                                                                                                                                                                                                             |\n| **reduceRight**    | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |\n\n\n#### ConcatArray\n\n| Prop         | Type                |\n| ------------ | ------------------- |\n| **`length`** | <code>number</code> |\n\n| Method    | Signature                                                          |\n| --------- | ------------------------------------------------------------------ |\n| **join**  | (separator?: string \\| undefined) =&gt; string                     |\n| **slice** | (start?: number \\| undefined, end?: number \\| undefined) =&gt; T[] |\n\n\n#### QuerySnapshot\n\n| Prop        | Type                                                                                                                                                       |\n| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`docs`**  | <code><a href=\"#array\">Array</a>&lt;{ id: string; data: () =&gt; T; exists: boolean; ref: <a href=\"#documentreference\">DocumentReference</a>; }&gt;</code> |\n| **`empty`** | <code>boolean</code>                                                                                                                                       |\n| **`size`**  | <code>number</code>                                                                                                                                        |\n\n\n#### DocumentSnapshot\n\n| Prop         | Type                                                            |\n| ------------ | --------------------------------------------------------------- |\n| **`id`**     | <code>string</code>                                             |\n| **`data`**   | <code>() =&gt; T</code>                                         |\n| **`exists`** | <code>boolean</code>                                            |\n| **`ref`**    | <code><a href=\"#documentreference\">DocumentReference</a></code> |\n\n\n#### Observable\n\n| Prop            | Type                                                     |\n| --------------- | -------------------------------------------------------- |\n| **`subscribe`** | <code><a href=\"#subscribe\">Subscribe</a>&lt;T&gt;</code> |\n\n\n#### Subscribe\n\nThe <a href=\"#subscribe\">Subscribe</a> interface has two forms - passing the inline function\ncallbacks, or a object interface with callback properties.\n\n\n### Type Aliases\n\n\n#### WhereFilterOp\n\nFilter conditions in a {@link where} clause are specified using the\nstrings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in',\n'array-contains-any', and 'not-in'.\n\n<code>'&lt;' | '&lt;=' | '==' | '!=' | '&gt;=' | '&gt;' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in'</code>\n\n\n#### SetOptions\n\nAn options object that configures the behavior of {@link @firebase/firestore/lite#(setDoc:1)}, {@link\n\n<code>{ readonly merge?: boolean; } | { readonly mergeFields?: <a href=\"#array\">Array</a>&lt;string | FieldPath&gt;; }</code>\n\n\n#### UpdateData\n\nUpdate data (for use with {@link (updateDoc:1)}) that consists of field paths\n(e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots\nreference nested fields within the document. FieldValues can be passed in\nas property values.\n\n<code>T extends <a href=\"#primitive\">Primitive</a> ? T : T extends {} ? { [K in keyof T]?: <a href=\"#updatedata\">UpdateData</a>&lt;T[K]&gt; | FieldValue; } & <a href=\"#nestedupdatefields\">NestedUpdateFields</a>&lt;T&gt; : <a href=\"#partial\">Partial</a>&lt;T&gt;</code>\n\n\n#### Primitive\n\n<a href=\"#primitive\">Primitive</a> types.\n\n<code>string | number | boolean</code> |  | <code>null</code>\n\n\n#### NestedUpdateFields\n\nFor each field (e.g. 'bar'), find all nested keys (e.g. {'bar.baz': T1,\n'bar.qux': T2}). Intersect them together to make a single map containing\nall possible keys that are all marked as optional\n\n<code><a href=\"#uniontointersection\">UnionToIntersection</a>&lt;{ [K in keyof T & string]: <a href=\"#childupdatefields\">ChildUpdateFields</a>&lt;K, T[K]&gt;; }[keyof T & string]&gt;</code>\n\n\n#### UnionToIntersection\n\nGiven a union type `U = T1 | T2 | ...`, returns an intersected type\n`(T1 & T2 & ...)`.\n\nUses distributive conditional types and inference from conditional types.\nThis works because multiple candidates for the same type variable in\ncontra-variant positions causes an intersection type to be inferred.\nhttps://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types\nhttps://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type\n\n<code>(U extends unknown ? (k: U) =&gt; void : never) extends (k: infer I) =&gt; void ? I : never</code>\n\n\n#### ChildUpdateFields\n\nHelper for calculating the nested fields for a given type T1. This is needed\nto distribute union types such as `undefined | {...}` (happens for optional\nprops) or `{a: A} | {b: B}`.\n\nIn this use case, `V` is used to distribute the union types of `T[K]` on\n`Record`, since `T[K]` is evaluated as an expression and not distributed.\n\nSee https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types\n\n<code>V extends <a href=\"#record\">Record</a>&lt;string, unknown&gt; ? <a href=\"#addprefixtokeys\">AddPrefixToKeys</a>&lt;K, <a href=\"#updatedata\">UpdateData</a>&lt;V&gt;&gt; : never</code>\n\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n<code>{\r [P in K]: T;\r }</code>\n\n\n#### AddPrefixToKeys\n\nReturns a new map where every key is prefixed with the outer key appended\nto a dot.\n\n<code>{ [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K]; }</code>\n\n\n#### Partial\n\nMake all properties in T optional\n\n<code>{\r [P in keyof T]?: T[P];\r }</code>\n\n</docgen-api>\n","readmeFilename":"README.md"}