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

update README

Browse Source
This commit is contained in:
ppetzold 2023-03-17 21:42:53 +01:00
parent c42fde65c3
commit 8b9c32247f
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -231,6 +231,15 @@ const paginateConfig: PaginateConfig<CatEntity> {
*/ */
relations: [], relations: [],
/**
* Required: false
* Type: boolean
* Default: false
* Description: Load eager relations using TypeORM's eager property.
* Only works if `relations` is not defined.
*/
loadEagerRelations: true
/** /**
* Required: false * Required: false
* Type: boolean * Type: boolean
@ -253,14 +262,6 @@ const paginateConfig: PaginateConfig<CatEntity> {
* Description: Overrides the origin of absolute resource links if set. * Description: Overrides the origin of absolute resource links if set.
*/ */
origin: 'http://cats.example', origin: 'http://cats.example',
/**
* Required: false
* Type: boolean
* Default: false
* Description: Load eager relations using TypeORM's eager property.
*/
loadEagerRelations: true
} }
``` ```