-
-
Notifications
You must be signed in to change notification settings - Fork 198
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement standard offset,limit based pagination
- Loading branch information
1 parent
6ba940f
commit d3584fe
Showing
26 changed files
with
1,310 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { setup, cleanup } from './test-helpers' | ||
|
|
||
| setup(false).then(() => { | ||
| console.log('Tables created') | ||
| console.log('They will be removed upon existing this script gracefully.') | ||
| process.on('SIGTERM', async () => { | ||
| await cleanup() | ||
| console.log('Dropping tables') | ||
| process.exit(1) | ||
| }) | ||
| process.on('SIGINT', async () => { | ||
| await cleanup() | ||
| console.log('Dropping tables') | ||
| process.exit(1) | ||
| }) | ||
| }).catch(console.log) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * @adonisjs/lucid | ||
| * | ||
| * (c) Harminder Virk <virk@adonisjs.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| import { stringify } from 'qs' | ||
| import { | ||
| SimplePaginatorMeta, | ||
| SimplePaginatorContract, | ||
| } from '@ioc:Adonis/Lucid/DatabaseQueryBuilder' | ||
|
|
||
| /** | ||
| * Simple paginator works with the data set provided by the standard | ||
| * `offset` and `limit` based pagination. | ||
| */ | ||
| export class SimplePaginator implements SimplePaginatorContract<any[]> { | ||
| private qs: { [key: string]: any } = {} | ||
| private url: string = '/' | ||
|
|
||
| /** | ||
| * The first page is always 1 | ||
| */ | ||
| public readonly firstPage: number = 1 | ||
|
|
||
| /** | ||
| * Find if results set is empty or not | ||
| */ | ||
| public readonly isEmpty: boolean = this.rows.length === 0 | ||
|
|
||
| /** | ||
| * Casting `total` to a number. Later, we can think of situations | ||
| * to cast it to a bigint | ||
| */ | ||
| public readonly total = Number(this.totalNumber) | ||
|
|
||
| /** | ||
| * Find if there are total records or not. This is not same as | ||
| * `isEmpty`. | ||
| * | ||
| * The `isEmpty` reports about the current set of results. However `hasTotal` | ||
| * reports about the total number of records, regardless of the current. | ||
| */ | ||
| public readonly hasTotal: boolean = this.total > 0 | ||
|
|
||
| /** | ||
| * The Last page number | ||
| */ | ||
| public readonly lastPage: number = Math.max(Math.ceil(this.total / this.perPage), 1) | ||
|
|
||
| /** | ||
| * Find if there are more pages to come | ||
| */ | ||
| public readonly hasMorePages: boolean = this.lastPage > this.currentPage | ||
|
|
||
| /** | ||
| * Find if there are enough results to be paginated or not | ||
| */ | ||
| public readonly hasPages: boolean = this.currentPage !== 1 || this.hasMorePages | ||
|
|
||
| constructor ( | ||
| private rows: any[], | ||
| private totalNumber: number, | ||
| public readonly perPage: number, | ||
| public readonly currentPage: number, | ||
| ) { | ||
| } | ||
|
|
||
| /** | ||
| * A reference to the result rows | ||
| */ | ||
| public all () { | ||
| return this.rows | ||
| } | ||
|
|
||
| /** | ||
| * Returns JSON meta data | ||
| */ | ||
| public getMeta (): SimplePaginatorMeta { | ||
| return { | ||
| total: this.total, | ||
| per_page: this.perPage, | ||
| current_page: this.currentPage, | ||
| last_page: this.lastPage, | ||
| first_page: this.firstPage, | ||
| first_page_url: this.getUrl(1), | ||
| last_page_url: this.getUrl(this.lastPage), | ||
| next_page_url: this.getNextPageUrl(), | ||
| previous_page_url: this.getPreviousPageUrl(), | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns JSON representation of the paginated | ||
| * data | ||
| */ | ||
| public toJSON () { | ||
| return { | ||
| meta: this.getMeta(), | ||
| data: this.all(), | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Define query string to be appended to the pagination links | ||
| */ | ||
| public queryString (values: { [key: string]: any }): this { | ||
| this.qs = values | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * Define base url for making the pagination links | ||
| */ | ||
| public baseUrl (url: string): this { | ||
| this.url = url | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * Returns url for a given page. Doesn't validates the integrity of the | ||
| * page | ||
| */ | ||
| public getUrl (page: number): string { | ||
| const qs = stringify(Object.assign({}, this.qs, { page: page < 1 ? 1 : page })) | ||
| return `${this.url}?${qs}` | ||
| } | ||
|
|
||
| /** | ||
| * Returns url for the next page | ||
| */ | ||
| public getNextPageUrl (): string | null { | ||
| if (this.hasMorePages) { | ||
| return this.getUrl(this.currentPage + 1) | ||
| } | ||
| return null | ||
| } | ||
|
|
||
| /** | ||
| * Returns URL for the previous page | ||
| */ | ||
| public getPreviousPageUrl (): string | null { | ||
| if (this.currentPage > 1) { | ||
| return this.getUrl(this.currentPage - 1) | ||
| } | ||
|
|
||
| return null | ||
| } | ||
| } |
Oops, something went wrong.