Skip to content

Commit

Permalink
fix: change keyword naming offset to skip
Browse files Browse the repository at this point in the history
  • Loading branch information
HMarzban committed Oct 14, 2019
1 parent c122ba9 commit 11725af
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For example, a query such as: `name=john&age>21&fields=name,age&sort=name,-age&o
options: {
fields: { name: true, age: true },
sort: { name: 1, age: -1 },
offset: 10,
skip: 10,
limit: 10
}
}
Expand Down Expand Up @@ -61,7 +61,7 @@ console.log(query)
* **maxLimit** The maximum limit (default is none)
* **ignore** List of criteria to ignore in addition to keywords used for query options ("fields", "omit", "sort", "offset", "limit")
* **parser** Query parser to use instead of _querystring_. Must implement `parse(string)` and `stringify(obj)`.
* **keywords** Override the keywords used for query options ("fields", "omit", "sort", "offset", "limit"). For example: `{fields:'$fields', omit:'$omit', sort:'$sort', offset:'$offset', limit:'$limit'}`
* **keywords** Override the keywords used for query options ("fields", "omit", "sort", "skip", "limit"). For example: `{fields:'$fields', omit:'$omit', sort:'$sort', offset:'$skip', limit:'$limit'}`

#### returns:
* **criteria** Mongo query criteria.
Expand Down

0 comments on commit 11725af

Please sign in to comment.