diff --git a/docs/api/connection.md b/docs/api/connection.md index 1b79a25d..87df406c 100644 --- a/docs/api/connection.md +++ b/docs/api/connection.md @@ -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 @@ -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 @@ -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 \ No newline at end of file +> A [`Presence`]({{ site.baseurl }}{% link api/presence.md %}) instance tied to the given document