Skip to content

Commit

Permalink
Merge pull request #546 from share/docs-createQuery-options-types
Browse files Browse the repository at this point in the history
[Docs] Indicate create*Query options.results is a Doc[]
  • Loading branch information
alecgibson committed Apr 12, 2022
2 parents 40c87bf + c49ad21 commit 92479d2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/api/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ Optional

> Default: `{}`
> `options.results` -- Object[]
> `options.results` -- [`Doc`]({{ site.baseurl }}{% link api/doc.md %})[]
> > Prior query results, if available, such as from server rendering
> > Prior query results, if available, such as from server rendering. This should be an array of Doc instances, as obtained from `connection.get(collection, id)`. If the docs' data is already available, invoke [`ingestSnapshot`]({{ site.baseurl }}{% link api/doc.md %}#ingestsnapshot) for each Doc instance beforehand to avoid re-transferring the data from the server.
> `options.*` -- any
Expand Down Expand Up @@ -105,9 +105,9 @@ Optional

> Default: `{}`
> `options.results` -- Object[]
> `options.results` -- [`Doc`]({{ site.baseurl }}{% link api/doc.md %})[]
> > Prior query results, if available, such as from server rendering
> > Prior query results, if available, such as from server rendering. This should be an array of Doc instances, as obtained from `connection.get(collection, id)`. If the docs' data is already available, invoke [`ingestSnapshot`]({{ site.baseurl }}{% link api/doc.md %}#ingestsnapshot) for each Doc instance beforehand to avoid re-transferring the data from the server.
> `options.*` -- any
Expand Down Expand Up @@ -228,4 +228,4 @@ The document **must** be of a [type]({{ site.baseurl }}{% link types/index.md %}
Return value

> A [`Presence`]({{ site.baseurl }}{% link api/presence.md %}) instance tied to the given document
> A [`Presence`]({{ site.baseurl }}{% link api/presence.md %}) instance tied to the given document

0 comments on commit 92479d2

Please sign in to comment.