Class PaginationResult<Result>

Type Parameters

Result extends unknown[]

Hierarchy (View Summary)

Pagination
- PaginationResult

Implements

IPaginationResult<Result>

Index

Constructors

constructor

new PaginationResult<Result extends unknown[]>(
    model: any,
    ...pagination: [
        limit: number,
        page: number,
        count: number,
        exceedCount: boolean,
        exceedTotalPages: boolean,
    ],
): PaginationResult<Result>
Type Parameters
- Result extends unknown[]
Parameters
- model: any
- ...pagination: [
      limit: number,
      page: number,
      count: number,
      exceedCount: boolean,
      exceedTotalPages: boolean,
  ]
Returns PaginationResult<Result>
Overrides Pagination.constructor
- Defined in src/pagination/result/PaginationResult.ts:12

Properties

count

count: number = NaN

Count how many rows on has on table/model with query filter

`Readonly`exceedCount

exceedCount: boolean = false

See

ExceedCount

Default

false

`Readonly`exceedTotalPages

exceedTotalPages: boolean = false

Default

false

See

ExceedTotalPages

limit

limit: number = NaN

Limit how much rows to return

result

result: Result

Accessors

hasNextPage

get hasNextPage(): boolean
If has result on next page index

Returns boolean
Implementation of IPaginationResult.hasNextPage
Inherited from Pagination.hasNextPage
- Defined in src/pagination/Pagination.ts:31

hasPrevPage

get hasPrevPage(): boolean
If has result on last page index

Returns boolean
Implementation of IPaginationResult.hasPrevPage
Inherited from Pagination.hasPrevPage
- Defined in src/pagination/Pagination.ts:35

totalPages

get totalPages(): number
Total of pages based on pagination arguments

Returns number
Implementation of IPaginationResult.totalPages
Inherited from Pagination.totalPages
- Defined in src/pagination/Pagination.ts:39

Methods

[custom]

"[custom]"(): Omit<PaginationResult<Result>, "toJSON">
Returns Omit<PaginationResult<Result>, "toJSON">
Inherited from Pagination.[custom]
- Defined in src/pagination/Pagination.ts:18

nextPage(): Promise<PaginationResult<Result>>
Returns Promise<PaginationResult<Result>>
- Defined in src/pagination/result/PaginationResult.ts:20

toJSON

toJSON(): Omit<PaginationResult<Result>, "toJSON">
Returns Omit<PaginationResult<Result>, "toJSON">
Inherited from Pagination.toJSON
- Defined in src/pagination/Pagination.ts:22

`Static`extractCount

extractCount(count: any): number
Parameters
- count: any
Returns number
Inherited from Pagination.extractCount
- Defined in src/pagination/Pagination.ts:53

`Static`initialPage

initialPage(page: PageArgs): number
Parameters
- page: PageArgs
Returns number
Inherited from Pagination.initialPage
- Defined in src/pagination/Pagination.ts:77

`Static`offset

offset(limit: number, page: PageArgs): number
Parameters
- limit: number
- page: PageArgs
Returns number
Inherited from Pagination.offset
- Defined in src/pagination/Pagination.ts:73

Class PaginationResult<Result>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PaginationResult<Result>

Properties

count

ReadonlyexceedCount

See

Default

ReadonlyexceedTotalPages

Default

See

limit

page

See

Default

result

Accessors

hasNextPage

Returns boolean

hasPrevPage

Returns boolean

totalPages

Returns number

Methods

[custom]

Returns Omit<PaginationResult<Result>, "toJSON">

nextPage

Returns Promise<PaginationResult<Result>>

toJSON

Returns Omit<PaginationResult<Result>, "toJSON">

StaticextractCount

Parameters

Returns number

StaticinitialPage

Parameters

Returns number

Staticoffset

Parameters

Returns number

Settings

On This Page

`Readonly`exceedCount

`Readonly`exceedTotalPages

`Static`extractCount

`Static`initialPage

`Static`offset