Skip to content

Commit 37f31c5

Browse files
Fix documentation for getDocsFromCache. (#6879)
Fix documentation for getDocsFromCache.
1 parent 70e6254 commit 37f31c5

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.changeset/wild-frogs-play.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@firebase/firestore": patch
3+
---
4+
5+
Fix documentation for getDocsFromCache.

packages/firestore/src/api/reference_impl.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {
196196

197197
/**
198198
* Executes the query and returns the results as a `QuerySnapshot` from cache.
199-
* Returns an error if the document is not currently cached.
199+
* Returns an empty result set if no documents matching the query are currently
200+
* cached.
200201
*
201202
* @returns A `Promise` that will be resolved with the results of the query.
202203
*/

0 commit comments

Comments
 (0)