From dd61ec9158587f020de40d470d44b96c6e8b512c Mon Sep 17 00:00:00 2001 From: Mark Duckworth Date: Mon, 12 Dec 2022 12:40:46 -0700 Subject: [PATCH 1/2] Fix documentation for getDocsFromCache. --- packages/firestore/src/api/reference_impl.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/firestore/src/api/reference_impl.ts b/packages/firestore/src/api/reference_impl.ts index dbefef93d26..eabd0fb0021 100644 --- a/packages/firestore/src/api/reference_impl.ts +++ b/packages/firestore/src/api/reference_impl.ts @@ -196,7 +196,8 @@ export function getDocs(query: Query): Promise> { /** * 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. */ From 9b158cdbb05f9253b4ce218414775b3f6d9ef50b Mon Sep 17 00:00:00 2001 From: Mark Duckworth <1124037+MarkDuckworth@users.noreply.github.com> Date: Mon, 12 Dec 2022 12:50:09 -0700 Subject: [PATCH 2/2] Create wild-frogs-play.md --- .changeset/wild-frogs-play.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/wild-frogs-play.md diff --git a/.changeset/wild-frogs-play.md b/.changeset/wild-frogs-play.md new file mode 100644 index 00000000000..680ffff4fd4 --- /dev/null +++ b/.changeset/wild-frogs-play.md @@ -0,0 +1,5 @@ +--- +"@firebase/firestore": patch +--- + +Fix documentation for getDocsFromCache.