Skip to content

Commit cf7351f

Browse files
committed
docs(Query): fix the params for #scan
1 parent 2294ef2 commit cf7351f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/query.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,10 @@ module.exports = function(AV) {
291291
* scan a Query. masterKey required.
292292
*
293293
* @since 2.1.0
294-
* @param {String} orderedBy
295-
* @param {Number} batchSize
294+
* @param {object} [options]
295+
* @param {string} [options.orderedBy] specify the key to sort
296+
* @param {number} [options.batchSize] specify the batch size for each request
297+
* @param {AuthOptions} [authOptions]
296298
* @return {AsyncIterator.<AV.Object>}
297299
* @example const scan = new AV.Query(TestClass).scan({
298300
* orderedBy: 'objectId',

0 commit comments

Comments
 (0)