Class Paginator

Hierarchy

Paginator

Index

Constructors

constructor

Properties

Accessors

footer

Methods

Constructors

constructor

new Paginator(message: Message, templateEmbed?: MessageEmbed, navigation?: Navigation): Paginator

- Defined in src/lib/util/Paginator.ts:27
Parameters
- message: Message
  
  The message sent by the user
- Optional templateEmbed: MessageEmbed
  
  The embed template
- Optional navigation: Navigation
  
  The navigation object containing the emojis, if you want it to be different from the default
Returns Paginator

Properties

Private _collector

_collector: undefined | ReactionCollector

Private _customFooter

_customFooter: undefined | string

Private _message

_message: Message

Private _navigation

_navigation: Navigation = ...

The emojis used for navigation

currentPage

currentPage: number = 1

The current page

pages

pages: MessageEmbed[] = []

templateEmbed

templateEmbed: undefined | MessageEmbed

The embed all pages will be based on

Accessors

footer

get footer(): string

- Defined in src/lib/util/Paginator.ts:126
Returns string

Methods

Private _askPage

_askPage(): Promise<number>

- Defined in src/lib/util/Paginator.ts:68
Returns Promise<number>

Private _removeReactions

_removeReactions(message: Message): Promise<void>

- Defined in src/lib/util/Paginator.ts:75
Parameters
- message: Message
Returns Promise<void>

Private _updatePage

_updatePage(message: Message): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:63
Parameters
- message: Message
Returns Promise<Paginator>

add

add(embedFunction: (embed: MessageEmbed) => MessageEmbed): Paginator

- Defined in src/lib/util/Paginator.ts:53
Add a page to the embed

Parameters
- embedFunction: (embed: MessageEmbed) => MessageEmbed
  - - (embed: MessageEmbed): MessageEmbed
    - Parameters
      - embed: MessageEmbed
      Returns MessageEmbed
Returns Paginator

backward

backward(): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:103
Go to the previous page

Returns Promise<Paginator>

first_page

first_page(): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:109
Jump to the first page

Returns Promise<Paginator>

forward

forward(): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:97
Go to the next page

Returns Promise<Paginator>

last_page

last_page(): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:115
Jump to the last page

Returns Promise<Paginator>

page

page(): Promise<Paginator>

- Defined in src/lib/util/Paginator.ts:82
Jump to a page

Returns Promise<Paginator>

setCustomFooter

setCustomFooter(footer: string): void

- Defined in src/lib/util/Paginator.ts:59
Set a custom footer to use with the default embed template

Parameters
- footer: string
Returns void

start

start(): Promise<void>

- Defined in src/lib/util/Paginator.ts:34
Start the paginator

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/lib/util/Paginator.ts:121
Stop the paginator

Returns Promise<void>

Generated using TypeDoc