Skip to content

Fix documentation for getDocsFromCache. #6879

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 12, 2022
Merged

Fix documentation for getDocsFromCache. #6879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd61ec9
Fix documentation for getDocsFromCache.
MarkDuckworth Dec 12, 2022
9b158cd
Create wild-frogs-play.md
MarkDuckworth Dec 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-frogs-play.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@firebase/firestore": patch
---

Fix documentation for getDocsFromCache.
3 changes: 2 additions & 1 deletion packages/firestore/src/api/reference_impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {

/**
* Executes the query and returns the results as a `QuerySnapshot` from cache.
* Returns an error if the document is not currently cached.
* Returns an empty result set if no documents matching the query are currently
* cached.
*
* @returns A `Promise` that will be resolved with the results of the query.
*/
Expand Down