caritas/nestjs-paginate
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: README

Browse Source
This commit is contained in:
ppetzold 2022-03-14 20:10:30 +01:00
parent 8bf5e41a11
commit eb6cfd5033
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -199,7 +199,7 @@ const paginateConfig: PaginateConfig<CatEntity> {
* Default: None * Default: None
* https://typeorm.io/#/find-options/advanced-options * https://typeorm.io/#/find-options/advanced-options
*/ */
filterableColumns: { age: [FilterOperator.EQ, FilterOperator.IN] } filterableColumns: { age: [FilterOperator.EQ, FilterOperator.IN] },
/** /**
* Required: false * Required: false
@ -212,6 +212,8 @@ const paginateConfig: PaginateConfig<CatEntity> {
## Usage with Query Builder ## Usage with Query Builder
You can paginate custom queries by passing on the query builder:
### Example ### Example
```typescript ```typescript
@ -225,6 +227,8 @@ const result = await paginate<CatEntity>(query, queryBuilder, config)
## Usage with Relations ## Usage with Relations
You can utilize simplified left-join form using `relations`:
### Example ### Example
#### Endpoint #### Endpoint