Class PaginationResult<Result>

Type Parameters

Result extends unknown[] = unknown[]

Hierarchy (view full)

Pagination
- PaginationResult

Implements

IPaginationResult<Result>

Index

Constructors

constructor

new PaginationResult<Result>(model, ...pagination): PaginationResult<Result>
Type Parameters
- Result extends unknown[] = unknown[]
Parameters
- model: any
- Rest ...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

`Private` `Readonly` #model

#model: any

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:30

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:34

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:38

Methods

`Private` #nextPagePaginateArgs

#nextPagePaginateArgs(): PaginationArgs
Returns PaginationArgs
- Defined in src/pagination/result/PaginationResult.ts:24

`Private` #validateExceedCount

#validateExceedCount(): void
Returns void
Inherited from Pagination.#validateExceedCount
- Defined in src/pagination/Pagination.ts:47

`Private` #validateExceedTotalPages

#validateExceedTotalPages(): void
Returns void
Inherited from Pagination.#validateExceedTotalPages
- Defined in src/pagination/Pagination.ts:42

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:21

toString

toString(): string
Returns string
Inherited from Pagination.toString
- Defined in src/pagination/Pagination.ts:17

`Static` extractCount

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

`Static` initialPage

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

`Static` offset

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

Class PaginationResult<Result>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PaginationResult<Result>

Properties

Private Readonly #model

count

Readonly exceedCount

See

Default

Readonly exceedTotalPages

Default

See

limit

page

See

Default

result

Accessors

hasNextPage

Returns boolean

hasPrevPage

Returns boolean

totalPages

Returns number

Methods

Private #nextPagePaginateArgs

Returns PaginationArgs

Private #validateExceedCount

Returns void

Private #validateExceedTotalPages

Returns void

nextPage

Returns Promise<PaginationResult<Result>>

toJSON

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

toString

Returns string

Static extractCount

Parameters

Returns number

Static initialPage

Parameters

Returns number

Static offset

Parameters

Returns number

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` #model

`Readonly` exceedCount

`Readonly` exceedTotalPages

`Private` #nextPagePaginateArgs

`Private` #validateExceedCount

`Private` #validateExceedTotalPages

`Static` extractCount

`Static` initialPage

`Static` offset