Class Pagination<T>

constructor

• new Pagination<
      T extends PaginationResolver<Resolver> = PaginationResolver<Resolver>,
  >(
      sendTo: PaginationSendTo,
      pages: T | PaginationItem[],
      config?: PaginationOptions,
  ): Pagination<T>

  Type Parameters

  • T extends PaginationResolver<Resolver> = PaginationResolver<Resolver>

  Parameters

  • sendTo: PaginationSendTo
  • pages: T | PaginationItem[]
  • Optionalconfig: PaginationOptions

  Returns Pagination<T>

Optionalcollectors

Optionalconfig

currentPage

maxLength

Optionalmessage

pages

sendTo

isSent

• get isSent(): boolean

  Returns boolean

canNavigateNext

• canNavigateNext(): boolean

  Check if pagination can navigate to next page

  Returns boolean

canNavigatePrevious

• canNavigatePrevious(): boolean

  Check if pagination can navigate to previous page

  Returns boolean

getPage

• getPage(page: number): Promise<PaginationBuilder>

  Get page

  Parameters

  • page: number

  Returns Promise<PaginationBuilder>

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;
  }

navigateNext

• navigateNext(): boolean

  Navigate to next page

  Returns boolean

navigatePrevious

• navigatePrevious(): boolean

  Navigate to previous page

  Returns boolean

navigateToEnd

• navigateToEnd(): boolean

  Navigate to last page

  Returns boolean

navigateToPage

• navigateToPage(page: number): boolean

  Navigate to a specific page

  Parameters

  • page: number

  Returns boolean

navigateToStart

• navigateToStart(): boolean

  Navigate to first page

  Returns boolean

send

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

  Send pagination

  Returns Promise<{ collectors: PaginationCollectors; message: Message }>

stop

• stop(): void

  Stop the pagination collector

  Returns void