Skip to content

Commit ad40ea2

Browse files
dhennekemikehardy
authored andcommitted
feat(firestore): export and test types for the modular API
1 parent 5d62408 commit ad40ea2

File tree

3 files changed

+95
-1
lines changed

3 files changed

+95
-1
lines changed

packages/firestore/lib/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2340,6 +2340,8 @@ export const firebase: ReactNativeFirebase.Module & {
23402340
): ReactNativeFirebase.FirebaseApp & { firestore(): FirebaseFirestoreTypes.Module };
23412341
};
23422342

2343+
export * from './modular';
2344+
23432345
export const Filter: FilterFunction;
23442346

23452347
export default defaultExport;

packages/firestore/lib/modular/index.d.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,3 +532,11 @@ export function namedQuery(firestore: Firestore, name: string): Query<DocumentDa
532532
* writes.
533533
*/
534534
export function writeBatch(firestore: Firestore): FirebaseFirestoreTypes.WriteBatch;
535+
536+
export * from './query';
537+
export * from './snapshot';
538+
export * from './Bytes';
539+
export * from './FieldPath';
540+
export * from './FieldValue';
541+
export * from './GeoPoint';
542+
export * from './Timestamp';

packages/firestore/type-test.ts

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
1-
import firebase, { FirebaseFirestoreTypes } from '.';
1+
import firebase, {
2+
FirebaseFirestoreTypes,
3+
addDoc,
4+
collection,
5+
collectionGroup,
6+
doc,
7+
endAt,
8+
getDoc,
9+
getDocFromCache,
10+
getDocFromServer,
11+
getDocs,
12+
getDocsFromCache,
13+
getDocsFromServer,
14+
onSnapshot,
15+
query,
16+
startAfter,
17+
updateDoc,
18+
} from '.';
219

320
console.log(firebase().collection);
421

@@ -107,3 +124,70 @@ firebase
107124
complete() {},
108125
},
109126
);
127+
128+
collection(firebase.firestore(), 'foo');
129+
collection(firebase.firestore(), 'foo', 'foo', 'foo');
130+
collection(doc(collection(firebase.firestore(), 'foo'), 'foo'), 'foo');
131+
doc(firebase.firestore(), 'foo', 'foo');
132+
doc(collection(firebase.firestore(), 'foo'), 'foo');
133+
addDoc(collection(firebase.firestore(), 'foo'), { foo: 'bar' }).then();
134+
updateDoc(doc(firebase.firestore(), 'foo', 'foo'), { foo: 'bar' }).then();
135+
getDoc(doc(firebase.firestore(), 'foo', 'foo')).then();
136+
getDocFromCache(doc(firebase.firestore(), 'foo', 'foo')).then();
137+
getDocFromServer(doc(firebase.firestore(), 'foo', 'foo')).then();
138+
getDocs(query(collectionGroup(firebase.firestore(), 'foo'), endAt(123), startAfter(123))).then();
139+
getDocsFromCache(
140+
query(collectionGroup(firebase.firestore(), 'foo'), endAt(123), startAfter(123)),
141+
).then();
142+
getDocsFromServer(
143+
query(collectionGroup(firebase.firestore(), 'foo'), endAt(123), startAfter(123)),
144+
).then();
145+
onSnapshot(doc(firebase.firestore(), 'foo', 'foo'), () => {});
146+
onSnapshot(doc(firebase.firestore(), 'foo', 'foo'), {
147+
next: (snapshot: FirebaseFirestoreTypes.DocumentSnapshot) => {
148+
console.log(snapshot.get('foo'));
149+
},
150+
error: (error: { message: any }) => {
151+
console.log(error.message);
152+
},
153+
});
154+
onSnapshot(
155+
doc(firebase.firestore(), 'foo', 'foo'),
156+
{
157+
includeMetadataChanges: true,
158+
},
159+
{
160+
next: (snapshot: FirebaseFirestoreTypes.DocumentSnapshot) => {
161+
console.log(snapshot.get('foo'));
162+
},
163+
error: (error: { message: any }) => {
164+
console.log(error.message);
165+
},
166+
complete() {},
167+
},
168+
);
169+
onSnapshot(
170+
collection(firebase.firestore(), 'foo'),
171+
(snapshot: FirebaseFirestoreTypes.QuerySnapshot) => {
172+
console.log(snapshot.docs);
173+
},
174+
(error: { message: any }) => {
175+
console.log(error.message);
176+
},
177+
() => {},
178+
);
179+
onSnapshot(
180+
collection(firebase.firestore(), 'foo'),
181+
{
182+
includeMetadataChanges: true,
183+
},
184+
{
185+
next: (snapshot: FirebaseFirestoreTypes.QuerySnapshot) => {
186+
console.log(snapshot.docs);
187+
},
188+
error: (error: { message: any }) => {
189+
console.log(error.message);
190+
},
191+
complete() {},
192+
},
193+
);

0 commit comments

Comments
 (0)