Class Pagination<T>

Type Parameters

T extends PaginationResolver = PaginationResolver

Index

Constructors

constructor

new Pagination<
    T extends PaginationResolver<Resolver> = PaginationResolver<Resolver>,
>(
    sendTo: PaginationSendTo,
    pageData: T | PaginationItem[],
    config?: PaginationOptions,
): Pagination<T>
Type Parameters
- T extends PaginationResolver<Resolver> = PaginationResolver<Resolver>
Parameters
- sendTo: PaginationSendTo
- pageData: T | PaginationItem[]
- Optionalconfig: PaginationOptions
Returns Pagination<T>
- Defined in packages/pagination/src/pagination/pagination.ts:104

Accessors

currentPage

get currentPage(): number
Returns number
- Defined in packages/pagination/src/pagination/pagination.ts:60

isSent

get isSent(): boolean
Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:56

maxLength

get maxLength(): number
Returns number
- Defined in packages/pagination/src/pagination/pagination.ts:64

message

get message(): Message
Returns Message
- Defined in packages/pagination/src/pagination/pagination.ts:46

pages

get pages(): T | PaginationItem[]
Returns T | PaginationItem[]
- Defined in packages/pagination/src/pagination/pagination.ts:68

Methods

canNavigateNext

canNavigateNext(): boolean
Check if pagination can navigate to next page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:361

canNavigatePrevious

canNavigatePrevious(): boolean
Check if pagination can navigate to previous page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:368

getPage

getPage(page: number): Promise<PaginationBuilder>
Get page
Parameters
- page: number
Returns Promise<PaginationBuilder>
- Defined in packages/pagination/src/pagination/pagination.ts:222

getPageInfo

getPageInfo(): {
    canNext: boolean;
    canPrevious: boolean;
    currentPage: number;
    isFirst: boolean;
    isLast: boolean;
    totalPages: number;
}
Get current page info

Returns {
    canNext: boolean;
    canPrevious: boolean;
    currentPage: number;
    isFirst: boolean;
    isLast: boolean;
    totalPages: number;
}
- Defined in packages/pagination/src/pagination/pagination.ts:375

navigateNext

navigateNext(): boolean
Navigate to next page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:329

navigatePrevious

navigatePrevious(): boolean
Navigate to previous page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:343

navigateToEnd

navigateToEnd(): boolean
Navigate to last page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:410

navigateToPage

navigateToPage(page: number): boolean
Navigate to a specific page
Parameters
- page: number
Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:308

navigateToStart

navigateToStart(): boolean
Navigate to first page

Returns boolean
- Defined in packages/pagination/src/pagination/pagination.ts:396

send

send(): Promise<{ collectors: PaginationCollectors; message: Message }>
Send pagination

Returns Promise<{ collectors: PaginationCollectors; message: Message }>
- Defined in packages/pagination/src/pagination/pagination.ts:251

setCurrentPage

setCurrentPage(page: number): void
Parameters
- page: number
Returns void
- Defined in packages/pagination/src/pagination/pagination.ts:72

setMaxLength

setMaxLength(length: number): void
Parameters
- length: number
Returns void
- Defined in packages/pagination/src/pagination/pagination.ts:82

setPages

setPages(pages: T | PaginationItem[]): void
Parameters
- pages: T | PaginationItem[]
Returns void
- Defined in packages/pagination/src/pagination/pagination.ts:95

stop

stop(): void
Stop the pagination collector

Returns void
- Defined in packages/pagination/src/pagination/pagination.ts:289