Skip to content

Commit 199bb1a

Browse files
committed
Fixes #56.
1 parent c83d7d8 commit 199bb1a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -506,14 +506,17 @@ For collection-specific queries see [fulltext queries](#fulltext-queries) and [g
506506

507507
#### database.query
508508

509-
`database.query(query: string | QueryBuilder, [bindVars: Object,] [callback: Callback]): Promise<Cursor>`
509+
`database.query(query: string | QueryBuilder, [bindVars: Object,] [opts: Object,] [callback: Callback]): Promise<Cursor>`
510510

511511
Performs a database query using the given *query* and *bindVars*, then passes a new *Cursor* instance for the result list to the callback.
512512

513513
*Parameter*
514514

515515
* *query*: an AQL query string or a [query builder](https://npmjs.org/package/aqb) instance.
516516
* *bindVars* (optional): an object with the variables to bind the query to.
517+
* *opts* (optional): additional options that will be passed to the query API.
518+
519+
If *opts.count* is set to `true`, the cursor will have a *count* property set to the query result count.
517520

518521
For more information on *Cursor* instances see the [*Cursor API* below](#cursor-api).
519522

0 commit comments

Comments
 (0)