Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Paginator

Index

Constructors

constructor

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

Properties

Private _collector

_collector: ReactionCollector | undefined

Private _customFooter

_customFooter: string | undefined

Private _message

_message: Message

currentPage

currentPage: number = 1

The current page

pages

pages: MessageEmbed[] = []

templateEmbed

templateEmbed: MessageEmbed | undefined

The embed all pages will be based on

Accessors

footer

  • get footer(): string

Methods

Private _askPage

  • _askPage(): Promise<number>

Private _removeReactions

  • _removeReactions(message: Message): Promise<void>

Private _updatePage

  • _updatePage(message: Message): Promise<this>

add

  • add(embedFunction: (embed: MessageEmbed) => MessageEmbed): this

backward

  • backward(): Promise<this>

first_page

  • first_page(): Promise<this>

forward

  • forward(): Promise<this>

last_page

  • last_page(): Promise<this>

page

  • page(): Promise<this>

setCustomFooter

  • setCustomFooter(footer: string): void

start

  • start(): Promise<void>

stop

  • stop(): Promise<void>

Object literals

Private _navigation

_navigation: object

The emojis used for navigation

backward

backward: string = "◀️"

first_page

first_page: string = "⏮️"

forward

forward: string = "▶️"

last_page

last_page: string = "⏭️"

page

page: string = "🔢"

stop

stop: string = "⏹️"

Generated using TypeDoc