Skip to content

Commit 09df0d6

Browse files
committed
Update documentation for Each queries.
Each queries can also accept useMasterKey option: this is now documented.
1 parent 9d252ef commit 09df0d6

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/ParseQuery.js

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -395,9 +395,15 @@ export default class ParseQuery {
395395
* @method each
396396
* @param {Function} callback Callback that will be called with each result
397397
* of the query.
398-
* @param {Object} options An optional Backbone-like options object with
399-
* success and error callbacks that will be invoked once the iteration
400-
* has finished.
398+
* @param {Object} options A Backbone-style options object. Valid options
399+
* are:<ul>
400+
* <li>success: Function to call when the iteration completes successfully.
401+
* <li>error: Function to call when the iteration fails.
402+
* <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
403+
* be used for this request.
404+
* <li>sessionToken: A valid session token, used for making a request on
405+
* behalf of a specific user.
406+
* </ul>
401407
* @return {Parse.Promise} A promise that will be fulfilled once the
402408
* iteration has completed.
403409
*/

0 commit comments

Comments
 (0)