Hierarchy

  • Pagination

Constructors

Properties

Methods

Constructors

  • Parameters

    • channel: TextChannel | DMChannel

      The target channel

    • pages: EmbedBuilder[]

      Embed pages

    • Optional footerText: string = "Page"

      Optional footer text, will show Text 1 of 5 if you pass Text, for example

    • Optional timeout: number

      How long button need to be active

    • Optional options: ButtonOption[]

      optional options for the buttons

    • Optional Author: UserResolvable

      To limit the pagination to a specific author

    • Optional files: AttachmentBuilder[]

      Optional files to attach

    Returns Pagination

Properties

channel: TextChannel | DMChannel
defaultOptions: ButtonOption[] = ...
index: number = 0
message?: Message<boolean>
pages: EmbedBuilder[]

Methods

  • Starts the pagination

    Returns Promise<void>

Generated using TypeDoc