Skip to content

Commit ea1cbd6

Browse files
author
Brian Chen
committed
add comments to test
1 parent 4f84138 commit ea1cbd6

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

packages/firestore/test/lite/integration.test.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1553,13 +1553,17 @@ describe('withConverter() support', () => {
15531553
});
15541554
});
15551555

1556-
it('allows certain types but not others (prevent breaking changes)', () => {
1556+
it('allows certain types but not others', () => {
15571557
const withTryCatch = async (fn: () => Promise<void>): Promise<void> => {
15581558
try {
15591559
await fn();
15601560
} catch {}
15611561
};
15621562

1563+
// These tests exist to establish which object types are allowed to be
1564+
// passed in by default when `T = DocumentData`. Some objects extend
1565+
// the Javascript `{}`, which is why they're allowed whereas others
1566+
// throw an error.
15631567
return withTestDoc(async doc => {
15641568
// @ts-expect-error
15651569
await withTryCatch(() => setDoc(doc, 1));

0 commit comments

Comments
 (0)