Class Pagination

Query pagination configuration

Hierarchy

Pagination

Index

Constructors

Methods

getLimit getOffset hasLimit hasOffset incrementOffset incrementOffsetBy replace setLimit setOffset toString find replace

Constructors

constructor

new Pagination(limit: number, offset: number): Pagination
Constructor
Parameters
- limit: number
  
  upper bound number of rows
- offset: number
  
  row result starting offset
Returns Pagination
- Defined in lib/db/pagination.ts:115

Methods

getLimit

getLimit(): number
Get the limit

Returns
upper bound number of rows

Returns number
- Defined in lib/db/pagination.ts:124

getOffset

getOffset(): number
Get the offset

Returns
row result starting offset

Returns number
- Defined in lib/db/pagination.ts:148

hasLimit

hasLimit(): boolean
Is there positive limit

Returns
true if limit above 0

Returns boolean
- Defined in lib/db/pagination.ts:140

hasOffset

hasOffset(): boolean
Is there an offset

Returns
true if has an offset

Returns boolean
- Defined in lib/db/pagination.ts:156

incrementOffset

incrementOffset(): void
If the limit is positive, increment the offset

Returns void
- Defined in lib/db/pagination.ts:174

incrementOffsetBy

incrementOffsetBy(count: number): void
Increment the offset by the count
Parameters
- count: number
  
  count to increment
Returns void
- Defined in lib/db/pagination.ts:184

replace

replace(sql: string): string
Replace the limit and offset in the SQL statement with the pagination values

Returns
modified SQL statement
Parameters
- sql: string
  
  SQL statement
Returns string
- Defined in lib/db/pagination.ts:197

setLimit

setLimit(limit: number): void
Set the limit
Parameters
- limit: number
  
  upper bound number of rows
Returns void
- Defined in lib/db/pagination.ts:132

setOffset

setOffset(offset: number): void
Set the offset
Parameters
- offset: number
  
  row result starting offset
Returns void
- Defined in lib/db/pagination.ts:164

toString

toString(): string
Inherit Doc

Returns string
- Defined in lib/db/pagination.ts:204

`Static` find

find(sql: string): Pagination
Find the pagination offset and limit from the SQL statement

Returns
pagination or null if not found
Parameters
- sql: string
  
  SQL statement
Returns Pagination
- Defined in lib/db/pagination.ts:55

`Static` replace

replace(pagination: Pagination, sql: string): string
Replace the pagination limit and offset in the SQL statement

Returns
modified SQL statement
Parameters
- pagination: Pagination
  
  pagination settings
- sql: string
  
  SQL statement
Returns string
- Defined in lib/db/pagination.ts:86

Generated using TypeDoc