docs: Add documentation for FirestoreDataConverter #1059
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
thebrianchen
force-pushed
the
bc/conv-docs
branch
from
53a4dbe to
d657706
Compare
Codecov Report
@@ Coverage Diff @@
## node10 #1059 +/- ##
=======================================
Coverage 98.63% 98.64%
=======================================
Files 27 27
Lines 17460 17509 +49
Branches 1381 1381
=======================================
+ Hits 17222 17271 +49
Misses 235 235
Partials 3 3
Continue to review full report at Codecov.
|
schmidt-sebastian
approved these changes
Apr 30, 2020
dev/src/reference.ts
Outdated
| @@ -576,7 +575,8 @@ export class DocumentReference<T = DocumentData> implements Serializable { | |||
| * post.someNonExistentProperty; // TS error | |||
| * } | |||
| * | |||
| * @param converter Converts objects to and from Firestore. | |||
| * @param {FirestoreDataConverter=} converter Converts objects to and from | |||
There was a problem hiding this comment.
Drop = since it is not optional.
dev/src/reference.ts
Outdated
| @@ -2176,7 +2176,8 @@ export class Query<T = DocumentData> { | |||
| * post.someNonExistentProperty; // TS error | |||
| * } | |||
| * | |||
| * @param converter Converts objects to and from Firestore. | |||
| * @param {FirestoreDataConverter=} converter Converts objects to and from | |||
There was a problem hiding this comment.
Drop = since it is not optional.
dev/src/reference.ts
Outdated
| @@ -2450,7 +2451,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> { | |||
| * post.someNonExistentProperty; // TS error | |||
| * } | |||
| * | |||
| * @param converter Converts objects to and from Firestore. | |||
| * @param {FirestoreDataConverter=} converter Converts objects to and from | |||
There was a problem hiding this comment.
Drop = since it is not optional.
schmidt-sebastian
added a commit
that referenced
this pull request
Jun 24, 2020
* fix!: mark v1beta1 client as deprecated (#937) * feat!: use QueryDocumentSnapshot in FirestoreDataConverter (#965) * deps: update to gts 2.x (#1013) * chore!: update settings for Node 10 (#1019) * deps: drop through2 (#1014) * feat: support BigInt (#1016) * fix: make update.sh work on Linux (#1043) * fix: only use BigInt in BigInt system test (#1044) * fix: make pbjs compile admin proto again (#1045) * Add BulkWriter (#1055) * docs: Add documentation for FirestoreDataConverter (#1059) * chore: enforce return types (#1065) * fix: add generic to Firestore.getAll() (#1066) * chore: remove internal WriteOp (#1067) * chore: add linter checks for it|describe.only (#1068) * fix: handle terminate in BulkWriter (#1070) * chore: run template copying last in synthtool (#1071) * feat: Firestore Bundles implementation (#1078) * feat: add support for set() with SetOptions when using FirestoreDataConverter (#1087) * feat: Add totalDocuments and totalBytes to bundle metadata. (#1085) * feat: Add totalDocuments and totalBytes to bundle metadata. * fix: Better comment * fix: Better testing. * fix: Improve metadata testing. * fix: incomplete expect in rate-limiter test (#1092) * Remove BatchWrite proto, fix conformance tests * chore: use public API types internally (#1100) * feat: add Partition and BatchWrite protos (#1110) * fix: remove GCF transaction fallback (#1112) * fix: add BulkWriter integration tests, java backport changes, delete fix (#1117) * chore: merge master (#1218) * chore: add eslint check for console.log statements (#1229) * fix: another attempt at fixing the flaky BulkWriter test (#1228) * Fix comment * Renames * Test fix * Fix unit tests Co-authored-by: Brian Chen <chenbrian@google.com> Co-authored-by: wu-hui <53845758+wu-hui@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looking at the docs, I realized that
FirestoreDataConverterwas nowhere to be found since I didn't include it inindex.ts. I added links to it in each thewithConverter@paramdefinitions as well. However, I'm not sure how to properly include the method docs for to/fromFirestore in JSdoc without actually writing out code for the interface. I included the methods as@property, which isn't ideal but is better that nothing.