-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: refactor reference.ts to one class per file #2037
Conversation
…rkduckworth/vector-search-profiling
Wait to merge until #2017 merges, so we don't force the community contribution to refactor. |
…rkduckworth/refactor-reference
/** | ||
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see these in the original reference.ts
, but it looks like we should remove them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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> 🦕