chore: refactor reference.ts to one class per file #2037
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
…rkduckworth/vector-search-profiling
product-auto-label
bot
added
size: xl
MarkDuckworth
added
the
do not merge
|
Wait to merge until #2017 merges, so we don't force the community contribution to refactor. |
…rkduckworth/refactor-reference
MarkDuckworth
removed
the
do not merge
ehsannas
approved these changes
May 17, 2024
Comment on lines
+62
to
+81
| /** | ||
| * onSnapshot() callback that receives a QuerySnapshot. | ||
| * | ||
| * @callback querySnapshotCallback | ||
| * @param {QuerySnapshot} snapshot A query snapshot. | ||
| */ | ||
|
|
||
| /** | ||
| * onSnapshot() callback that receives a DocumentSnapshot. | ||
| * | ||
| * @callback documentSnapshotCallback | ||
| * @param {DocumentSnapshot} snapshot A document snapshot. | ||
| */ | ||
|
|
||
| /** | ||
| * onSnapshot() callback that receives an error. | ||
| * | ||
| * @callback errorCallback | ||
| * @param {Error} err An error from a listen. | ||
| */ |
There was a problem hiding this comment.
I see these in the original reference.ts, but it looks like we should remove them.
There was a problem hiding this comment.
These are being used by JSDoc to build the documentation at https://googleapis.dev/nodejs/firestore/latest/global.html#querySnapshotCallback. If we migrate the SDK to only use TSDoc, then we can remove these.
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> 🦕