From 37f31c57b62bc6486bc08d9e5c64e2c32d25cb0a Mon Sep 17 00:00:00 2001 From: Mark Duckworth <1124037+MarkDuckworth@users.noreply.github.com> Date: Mon, 12 Dec 2022 15:48:19 -0700 Subject: [PATCH] Fix documentation for getDocsFromCache. (#6879) Fix documentation for getDocsFromCache. --- .changeset/wild-frogs-play.md | 5 +++++ packages/firestore/src/api/reference_impl.ts | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) 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. 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. */