Skip to content

Commit 98b1858

Browse files
Boris AbramovBoris Abramov
authored andcommitted
Add important notice to documentation
1 parent 9c11bfa commit 98b1858

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ return new UserResource(users).omit('id', 'password').paginate()
124124
- **page** — Number of the page to show (optional, default: 1)
125125
- **limit** — Items per page (optional, default: 10)
126126

127+
### Important notice
128+
129+
Do not use `paginate()` on a collection that has already been paginated. If the collection is paginated by an ORM or ODM, this extension will only forward the original pagination metadata to the endpoint without altering it.
130+
127131
## Pagination support
128132

129133
Offset-based pagination is supported for [Lucid](https://github.com/adonisjs/lucid) and [MongoDB ODM for AdonisJS](https://github.com/DreamsHive/adonis-odm)

0 commit comments

Comments
 (0)