Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enkot/prisma-pagination
Helper library for Prisma offset pagination
https://github.com/enkot/prisma-pagination
node pagination prisma
Last synced: about 5 hours ago
JSON representation
Helper library for Prisma offset pagination
- Host: GitHub
- URL: https://github.com/enkot/prisma-pagination
- Owner: enkot
- Created: 2021-11-24T22:06:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T17:14:22.000Z (about 2 years ago)
- Last Synced: 2024-11-11T19:11:26.496Z (8 days ago)
- Topics: node, pagination, prisma
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/prisma-pagination
- Size: 60.5 KB
- Stars: 45
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Prisma Pagination
Helper library for [Prisma](https://www.prisma.io/docs/concepts/components/prisma-client/pagination) offset pagination with Typescript support.
[](https://npmjs.org/package/prisma-pagination)
[](https://npmjs.org/package/prisma-pagination)
## Installation
```bash
npm i prisma-pagination
```
## Usage
```typescript
import { createPaginator } from 'prisma-pagination'
import { User, Prisma } from '@prisma/client'
// ...
const paginate = createPaginator({ perPage: 20 })
app.get('/', async ({ query, prisma }, res) => {
// Generic types can be passed to "paginate",
// so args and result will be typed and autocompleted :)
const result = await paginate(
prisma.user,
{
where: {
name: {
contains: 'Alice'
}
}
orderBy: {
id: 'desc',
}
},
{ page: query.page }
})
/* Result structure:
{
data: User[]
meta: {
total: number
lastPage: number
currentPage: number
perPage: number
prev: number | null
next: number | null
}
}
*/
})
```
For Express-like frameworks, `page` and `perPage` can be initialized in the middleware:
```typescript
import { createPaginator } from 'prisma-pagination'
const pagination = (req, res, next) => {
req.paginate = createPaginator({ page: req.query.page, perPage: 20 })
next()
}
app.use(pagination)
```
so there is no need to pass `page` value in each handler:
```typescript
app.get('/', async ({ paginate, prisma }, res) => {
return await paginate(prisma.user)
})
```
To have proper Typescript support, Request interface can be extended this way:
```typescript
import { PaginateFunction } from 'prisma-pagination'
declare global {
namespace Express {
export interface Request {
paginate: PaginateFunction
}
}
}
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)