Skip to content

Commit

Permalink
Improve populate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hagopj13 committed Dec 27, 2020
1 parent aad3e07 commit e003a3c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/models/plugins/paginate.plugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ const paginate = (schema) => {
* Query for documents with pagination
* @param {Object} [filter] - Mongo filter
* @param {Object} [options] - Query options
* @param {string} [options.populate] - populate data fields. Hierarchy of fields should be separated by (.). Multiple sorting criteria should be separated by commas (,)
* @param {string} [options.sortBy] - Sorting criteria using the format: sortField:(desc|asc). Multiple sorting criteria should be separated by commas (,)
* @param {string} [options.populate] - Populate data fields. Hierarchy of fields should be separated by (.). Multiple populating criteria should be separated by commas (,)
* @param {number} [options.limit] - Maximum number of results per page (default = 10)
* @param {number} [options.page] - Current page (default = 1)
* @returns {Promise<QueryResult>}
Expand Down

0 comments on commit e003a3c

Please sign in to comment.