Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avivharuzi/mongoose-simple-pagination
Mongoose simple pagination plugin written specially for typescript and async purposes
https://github.com/avivharuzi/mongoose-simple-pagination
mongodb mongoose pagination typescript
Last synced: about 22 hours ago
JSON representation
Mongoose simple pagination plugin written specially for typescript and async purposes
- Host: GitHub
- URL: https://github.com/avivharuzi/mongoose-simple-pagination
- Owner: avivharuzi
- License: mit
- Created: 2021-07-02T12:34:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-13T19:37:18.000Z (about 3 years ago)
- Last Synced: 2024-10-06T06:42:48.025Z (about 1 month ago)
- Topics: mongodb, mongoose, pagination, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/mongoose-simple-pagination
- Size: 140 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mongoose-simple-pagination
Mongoose simple pagination plugin written specially for typescript and async purposes.
## Why?
I created this package because I met typing problems in alternative libraries such as mongoose-paginate-v2. This package is for people who
looking for typescript solution with typings.
## Installation
```sh
npm i mongoose-simple-pagination
```
## Usage
Add plugin to a schema and then use model `paginate` method:
```ts
import { Document, model, Schema } from 'mongoose';
import { mongooseSimplePagination, PaginationModel } from 'mongoose-simple-pagination';
interface Product extends Document {
// ...
}
const productSchema = new Schema(
{
// ...
}
);
productSchema.plugin(mongoosePaginate);
export const ProductModel = model>(
'Product',
productSchema,
'products'
);
(async () => {
const pagination = await ProductModel.paginate();
const products = pagination.documents; // Our products array.
const hasNextPage = pagination.hasNextPage; // true.
})();
```
## API
### Model.paginate([filter], [options])
Returns promise
**Parameters**
- `[filter]` {FilterQuery} - Filter query criteria. [Documentation](https://docs.mongodb.org/manual/tutorial/query-documents)
- `[options]` {Options}
- `[collation]` {CollationDocument} - Specify the collation. [Documentation](https://docs.mongodb.com/manual/reference/collation/)
- `[lean=false]` {boolean | any} - Should return plain javascript objects instead of Mongoose document object.
- `[page=1]` {number}
- `[perPage=20]` {number}
- `[populate]` {string | PopulateOptions | PopulateOptions[]} - Paths which should be populated with other
documents. [Documentation](http://mongoosejs.com/docs/api.html#query_Query-populate)
- `[projection=null]` {any | null} - Get/set the query
projection. [Documentation](https://mongoosejs.com/docs/api/query.html#query_Query-projection)
- `[queryOptions={}]` {QueryOptions | null} - Query options passed to Mongoose's `find()`
function. [Documentation](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
- `[select='']` {string | any} - Fields to return (by default returns all fields)
. [Documentation](http://mongoosejs.com/docs/api.html#query_Query-select)
- `[sort='']` {string | any} - Sort order. [Documentation](http://mongoosejs.com/docs/api.html#query_Query-sort)
**Return value**
Promise fulfilled with Pagination object having properties:
- `documents` {T[]} - Array of documents.
- `hasNextPage` {bool} - Availability of next page.
- `hasPreviousPage` {bool} - Availability of previous page.
- `nextPage` {number} - Next page number if available or NULL.
- `page` {number} - Current page number.
- `perPage` {number} - Number of documents per page.
- `previousPage` {number} - Previous page number if available or NULL.
- `totalDocuments` {number} - Total number of documents in collection that match a query.
- `totalPages` {number} - Total number of pages.
## License
[MIT](LICENSE)