Paginator | @shane4368/discord.js-paginator - v2.0.0

Hierarchy

EventEmitter
- Paginator

Index

Constructors

constructor

Properties

Constructors

constructor

new Paginator(data?: Partial<PaginatorData>): Paginator

Overrides EventEmitter.constructor
- Defined in src/index.ts:198
Parameters
- data: Partial<PaginatorData> = {}
Returns Paginator

Properties

destroyed

destroyed: boolean = false

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): Paginator

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/globals.d.ts:547
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Paginator

addPage

addPage(page: string | MessageEmbed): Paginator

- Defined in src/index.ts:230
Parameters
- page: string | MessageEmbed
Returns Paginator

destroy

destroy(): void

- Defined in src/index.ts:327
Returns void

emit

emit(event: "end", reason: string): boolean
emit(event: "error", error: Error | TypeError): boolean

Inherited from EventEmitter.emit
- Defined in src/index.ts:579
Parameters
- event: "end"
- reason: string
Returns boolean
Inherited from EventEmitter.emit
- Defined in src/index.ts:580
Parameters
- event: "error"
- error: Error | TypeError
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

listen

listen(userID: string): Paginator

- Defined in src/index.ts:284
Parameters
- userID: string
Returns Paginator

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

off(event: "end", listener: (reason: string) => void): Paginator
off(event: "error", listener: (error: Error | TypeError) => void): Paginator

Inherited from EventEmitter.off
- Defined in src/index.ts:576
Parameters
- event: "end"
- listener: (reason: string) => void
  - - (reason: string): void
    - Parameters
      - reason: string
      Returns void
Returns Paginator
Inherited from EventEmitter.off
- Defined in src/index.ts:577
Parameters
- event: "error"
- listener: (error: Error | TypeError) => void
  - - (error: Error | TypeError): void
    - Parameters
      - error: Error | TypeError
      Returns void
Returns Paginator

on

on(event: "end", listener: (reason: string) => void): Paginator
on(event: "error", listener: (error: Error | TypeError) => void): Paginator

Inherited from EventEmitter.on
- Defined in src/index.ts:570
Parameters
- event: "end"
- listener: (reason: string) => void
  - - (reason: string): void
    - Parameters
      - reason: string
      Returns void
Returns Paginator
Inherited from EventEmitter.on
- Defined in src/index.ts:571
Parameters
- event: "error"
- listener: (error: Error | TypeError) => void
  - - (error: Error | TypeError): void
    - Parameters
      - error: Error | TypeError
      Returns void
Returns Paginator

once

once(event: "end", listener: (reason: string) => void): Paginator
once(event: "error", listener: (error: Error | TypeError) => void): Paginator

Inherited from EventEmitter.once
- Defined in src/index.ts:573
Parameters
- event: "end"
- listener: (reason: string) => void
  - - (reason: string): void
    - Parameters
      - reason: string
      Returns void
Returns Paginator
Inherited from EventEmitter.once
- Defined in src/index.ts:574
Parameters
- event: "error"
- listener: (error: Error | TypeError) => void
  - - (error: Error | TypeError): void
    - Parameters
      - error: Error | TypeError
      Returns void
Returns Paginator

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): Paginator

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Paginator

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Paginator

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Paginator

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Paginator

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns Paginator

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): Paginator

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Paginator

setCircular

setCircular(circular: boolean): Paginator

- Defined in src/index.ts:279
Parameters
- circular: boolean
Returns Paginator

setContent

setContent(content: string): Paginator

- Defined in src/index.ts:274
Parameters
- content: string
Returns Paginator

setDeleteOnTimeout

setDeleteOnTimeout(deleteOnTimeout: boolean): Paginator

- Defined in src/index.ts:264
Parameters
- deleteOnTimeout: boolean
Returns Paginator

setEmbedTemplate

setEmbedTemplate(embed: MessageEmbed): Paginator

- Defined in src/index.ts:269
Parameters
- embed: MessageEmbed
Returns Paginator

setEmojis

setEmojis(emojis: Partial<PaginatorEmojis>): Paginator

- Defined in src/index.ts:244
Parameters
- emojis: Partial<PaginatorEmojis>
Returns Paginator

setInfoOptions

setInfoOptions(infoOptions: Partial<PaginatorInfoOptions>): Paginator

- Defined in src/index.ts:249
Parameters
- infoOptions: Partial<PaginatorInfoOptions>
Returns Paginator

setJumpOptions

setJumpOptions(jumpOptions: Partial<PaginatorJumpOptions>): Paginator

- Defined in src/index.ts:254
Parameters
- jumpOptions: Partial<PaginatorJumpOptions>
Returns Paginator

setMaxListeners

setMaxListeners(n: number): Paginator

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns Paginator

setPages

setPages(pages: (string | MessageEmbed)[]): Paginator

- Defined in src/index.ts:237
Parameters
- pages: (string | MessageEmbed)[]
Returns Paginator

setTimeout

setTimeout(timeout: number): Paginator

- Defined in src/index.ts:259
Parameters
- timeout: number
Returns Paginator

start

start(channel: TextBasedChannelFields): Promise<void>

- Defined in src/index.ts:292
Parameters
- channel: TextBasedChannelFields
  
  The channel to create the Paginator in.
Returns Promise<void>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc