From e4be713422762b78398392f9173458103a46c3cf Mon Sep 17 00:00:00 2001 From: Pronin Egor Date: Sat, 13 Aug 2022 13:35:18 +0300 Subject: [PATCH] docs: regenerate --- docs/interfaces/AutoGeneratePagesOptions.html | 73 ++ docs/interfaces/PagesInteraction.html | 657 ++++++++++++++++++ .../interfaces/ResetListenTimeoutOptions.html | 66 ++ docs/interfaces/Trigger.html | 78 +++ docs/types/ActionLabelUnion.html | 65 ++ docs/types/ActionObject.html | 65 ++ docs/types/ActionUnion.html | 65 ++ docs/types/AllowArray.html | 69 ++ docs/types/Button.html | 65 ++ docs/types/EmbedPage.html | 65 ++ docs/types/EndMethodUnion.html | 65 ++ docs/types/FunctionPage.html | 73 ++ docs/types/Middleware.html | 78 +++ docs/types/Page.html | 65 ++ docs/types/TriggerCallback.html | 84 +++ docs/types/TriggersMap.html | 65 ++ 16 files changed, 1698 insertions(+) create mode 100644 docs/interfaces/AutoGeneratePagesOptions.html create mode 100644 docs/interfaces/PagesInteraction.html create mode 100644 docs/interfaces/ResetListenTimeoutOptions.html create mode 100644 docs/interfaces/Trigger.html create mode 100644 docs/types/ActionLabelUnion.html create mode 100644 docs/types/ActionObject.html create mode 100644 docs/types/ActionUnion.html create mode 100644 docs/types/AllowArray.html create mode 100644 docs/types/Button.html create mode 100644 docs/types/EmbedPage.html create mode 100644 docs/types/EndMethodUnion.html create mode 100644 docs/types/FunctionPage.html create mode 100644 docs/types/Middleware.html create mode 100644 docs/types/Page.html create mode 100644 docs/types/TriggerCallback.html create mode 100644 docs/types/TriggersMap.html diff --git a/docs/interfaces/AutoGeneratePagesOptions.html b/docs/interfaces/AutoGeneratePagesOptions.html new file mode 100644 index 0000000..270ed9a --- /dev/null +++ b/docs/interfaces/AutoGeneratePagesOptions.html @@ -0,0 +1,73 @@ +AutoGeneratePagesOptions | discord.js-pages
+
+ +
+
+
+
+ +

Interface AutoGeneratePagesOptions

+
+

Hierarchy

+
    +
  • AutoGeneratePagesOptions
+
+
+
+ +
+
+

Properties

+
countPerPage? +items +
+
+

Properties

+
+

Optional countPerPage

+
countPerPage?: number
+
+

items

+
items: string[]
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/PagesInteraction.html b/docs/interfaces/PagesInteraction.html new file mode 100644 index 0000000..4834573 --- /dev/null +++ b/docs/interfaces/PagesInteraction.html @@ -0,0 +1,657 @@ +PagesInteraction | discord.js-pages
+
+ +
+
+
+
+ +

Interface PagesInteraction

+
+

Hierarchy

+
    +
  • ChatInputCommandInteraction +
      +
    • PagesInteraction
+
+
+
+ +
+
+

Properties

+
appPermissions +applicationId +channelId +client +commandGuildId +commandId +commandName +commandType +deferred +ephemeral +guildId +guildLocale +id +locale +member +memberPermissions +options +pagesBuilder +replied +token +type +user +version +webhook +
+
+

Accessors

+
channel +command +createdAt +createdTimestamp +guild +
+
+

Methods

+
awaitModalSubmit +deferReply +deleteReply +editReply +fetchReply +followUp +inCachedGuild +inGuild +inRawGuild +isAutocomplete +isButton +isChatInputCommand +isCommand +isContextMenuCommand +isMessageComponent +isMessageContextMenuCommand +isModalSubmit +isRepliable +isSelectMenu +isUserContextMenuCommand +reply +showModal +toJSON +toString +valueOf +
+
+

Properties

+
+

appPermissions

+
appPermissions: null | Readonly<PermissionsBitField>
+
+

applicationId

+
applicationId: string
+
+

channelId

+
channelId: string
+
+

Readonly client

+
client: Client<boolean>
+
+

commandGuildId

+
commandGuildId: null | string
+
+

commandId

+
commandId: string
+
+

commandName

+
commandName: string
+
+

commandType

+
commandType: ChatInput
+
+

deferred

+
deferred: boolean
+
+

ephemeral

+
ephemeral: null | boolean
+
+

guildId

+
guildId: null | string
+
+

guildLocale

+
guildLocale: null | Locale
+
+

id

+
id: string
+
+

locale

+
locale: Locale
+
+

member

+
member: null | APIInteractionGuildMember | GuildMember
+
+

memberPermissions

+
memberPermissions: null | Readonly<PermissionsBitField>
+
+

options

+
options: Omit<CommandInteractionOptionResolver<CacheType>, "getMessage" | "getFocused">
+
+

pagesBuilder

+
pagesBuilder: (() => PagesBuilder)
+
+

Type declaration

+
+
+

replied

+
replied: boolean
+
+

Readonly token

+
token: string
+
+

type

+
type: ApplicationCommand
+
+

user

+
user: User
+
+

version

+
version: number
+
+

webhook

+
webhook: InteractionWebhook
+
+

Accessors

+
+

channel

+
    +
  • get channel(): CacheTypeReducer<Cached, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | TextBasedChannel>
    • +
  • +

    Returns CacheTypeReducer<Cached, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | TextBasedChannel>

+
+

command

+
    +
  • get command(): null | ApplicationCommand<{}> | ApplicationCommand<{ guild: GuildResolvable }>
    • +
  • +

    Returns null | ApplicationCommand<{}> | ApplicationCommand<{ guild: GuildResolvable }>

+
+

createdAt

+
    +
  • get createdAt(): Date
    • +
  • +

    Returns Date

+
+

createdTimestamp

+
    +
  • get createdTimestamp(): number
    • +
  • +

    Returns number

+
+

guild

+
    +
  • get guild(): CacheTypeReducer<Cached, Guild, null, null | Guild, null | Guild>
    • +
  • +

    Returns CacheTypeReducer<Cached, Guild, null, null | Guild, null | Guild>

+
+

Methods

+
+

awaitModalSubmit

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>
    +

    Returns Promise<ModalSubmitInteraction<CacheType>>

+
+

deferReply

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: InteractionDeferReplyOptions & { fetchReply: true }
    +

    Returns Promise<Message<boolean>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional options: InteractionDeferReplyOptions
    +

    Returns Promise<InteractionResponse<boolean>>

+
+

deleteReply

+
    + +
  • +

    Returns Promise<void>

+
+

editReply

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: string | MessagePayload | WebhookEditMessageOptions
    +

    Returns Promise<Message<boolean>>

+
+

fetchReply

+
    + +
  • +

    Returns Promise<Message<boolean>>

+
+

followUp

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: string | InteractionReplyOptions | MessagePayload
    +

    Returns Promise<Message<boolean>>

+
+

inCachedGuild

+
    + +
  • +

    Returns this is ChatInputCommandInteraction<"cached">

+
+

inGuild

+
    + +
  • +

    Returns this is ChatInputCommandInteraction<"raw" | "cached">

+
+

inRawGuild

+
    + +
  • +

    Returns this is ChatInputCommandInteraction<"raw">

+
+

isAutocomplete

+
    + +
  • +

    Returns this is AutocompleteInteraction<CacheType>

+
+

isButton

+
    + +
  • +

    Returns this is ButtonInteraction<CacheType>

+
+

isChatInputCommand

+
    + +
  • +

    Returns this is ChatInputCommandInteraction<CacheType>

+
+

isCommand

+
    + +
  • +

    Returns this is CommandInteraction<CacheType>

+
+

isContextMenuCommand

+
    + +
  • +

    Returns this is ContextMenuCommandInteraction<CacheType>

+
+

isMessageComponent

+
    + +
  • +

    Returns this is MessageComponentInteraction<CacheType>

+
+

isMessageContextMenuCommand

+
    + +
  • +

    Returns this is MessageContextMenuCommandInteraction<CacheType>

+
+

isModalSubmit

+
    + +
  • +

    Returns this is ModalSubmitInteraction<CacheType>

+
+

isRepliable

+
    + +
  • +

    Returns this is PagesInteraction & InteractionResponseFields<CacheType>

+
+

isSelectMenu

+
    + +
  • +

    Returns this is SelectMenuInteraction<CacheType>

+
+

isUserContextMenuCommand

+
    + +
  • +

    Returns this is UserContextMenuCommandInteraction<CacheType>

+
+

reply

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: InteractionReplyOptions & { fetchReply: true }
    +

    Returns Promise<Message<boolean>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      options: string | InteractionReplyOptions | MessagePayload
    +

    Returns Promise<InteractionResponse<boolean>>

+
+

showModal

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      modal: APIModalInteractionResponseCallbackData | JSONEncodable<APIModalInteractionResponseCallbackData> | ModalComponentData
    +

    Returns Promise<void>

+
+

toJSON

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Rest ...props: Record<string, string | boolean>[]
    +

    Returns unknown

+
+

toString

+
    + +
  • +

    Returns string

+
+

valueOf

+
    + +
  • +

    Returns string

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/ResetListenTimeoutOptions.html b/docs/interfaces/ResetListenTimeoutOptions.html new file mode 100644 index 0000000..595143a --- /dev/null +++ b/docs/interfaces/ResetListenTimeoutOptions.html @@ -0,0 +1,66 @@ +ResetListenTimeoutOptions | discord.js-pages
+
+ +
+
+
+
+ +

Interface ResetListenTimeoutOptions

+
+

Hierarchy

+
    +
  • ResetListenTimeoutOptions
+
+
+
+ +
+
+

Properties

+
isFirstBuild? +
+
+

Properties

+
+

Optional isFirstBuild

+
isFirstBuild?: boolean
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/Trigger.html b/docs/interfaces/Trigger.html new file mode 100644 index 0000000..4362210 --- /dev/null +++ b/docs/interfaces/Trigger.html @@ -0,0 +1,78 @@ +Trigger | discord.js-pages
+
+ +
+
+
+
+ +

Interface Trigger<T>

+
+

Type Parameters

+
    +
  • +

    T extends MessageActionRowComponent

+
+

Hierarchy

+
    +
  • Trigger
+
+
+
+ +
+
+

Properties

+
callback +name +
+
+

Properties

+
+

callback

+
callback: TriggerCallback<T>
+
+

name

+
name: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ActionLabelUnion.html b/docs/types/ActionLabelUnion.html new file mode 100644 index 0000000..a56e7ba --- /dev/null +++ b/docs/types/ActionLabelUnion.html @@ -0,0 +1,65 @@ +ActionLabelUnion | discord.js-pages
+
+ +
+
+
+
+ +

Type alias ActionLabelUnion

+
ActionLabelUnion: `${ActionLabel}`
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ActionObject.html b/docs/types/ActionObject.html new file mode 100644 index 0000000..2623632 --- /dev/null +++ b/docs/types/ActionObject.html @@ -0,0 +1,65 @@ +ActionObject | discord.js-pages
+
+ +
+
+
+
+ +

Type alias ActionObject

+
ActionObject: { [ key in Action | ActionUnion]: ButtonBuilder }
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ActionUnion.html b/docs/types/ActionUnion.html new file mode 100644 index 0000000..5d15169 --- /dev/null +++ b/docs/types/ActionUnion.html @@ -0,0 +1,65 @@ +ActionUnion | discord.js-pages
+
+ +
+
+
+
+ +

Type alias ActionUnion

+
ActionUnion: `${Action}`
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/AllowArray.html b/docs/types/AllowArray.html new file mode 100644 index 0000000..c8bbcfd --- /dev/null +++ b/docs/types/AllowArray.html @@ -0,0 +1,69 @@ +AllowArray | discord.js-pages
+
+ +
+
+
+
+ +

Type alias AllowArray<T>

+
AllowArray<T>: T | T[]
+

Type Parameters

+
    +
  • +

    T

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Button.html b/docs/types/Button.html new file mode 100644 index 0000000..5b899cd --- /dev/null +++ b/docs/types/Button.html @@ -0,0 +1,65 @@ +Button | discord.js-pages
+
+ +
+
+
+
+ +

Type alias Button

+
Button: Action | ActionUnion | ActionObject
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/EmbedPage.html b/docs/types/EmbedPage.html new file mode 100644 index 0000000..9fafd3a --- /dev/null +++ b/docs/types/EmbedPage.html @@ -0,0 +1,65 @@ +EmbedPage | discord.js-pages
+
+ +
+
+
+
+ +

Type alias EmbedPage

+
EmbedPage: EmbedBuilder
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/EndMethodUnion.html b/docs/types/EndMethodUnion.html new file mode 100644 index 0000000..e5626f9 --- /dev/null +++ b/docs/types/EndMethodUnion.html @@ -0,0 +1,65 @@ +EndMethodUnion | discord.js-pages
+
+ +
+
+
+
+ +

Type alias EndMethodUnion

+
EndMethodUnion: `${EndMethod}`
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/FunctionPage.html b/docs/types/FunctionPage.html new file mode 100644 index 0000000..2546057 --- /dev/null +++ b/docs/types/FunctionPage.html @@ -0,0 +1,73 @@ +FunctionPage | discord.js-pages
+
+ +
+
+
+
+ +

Type alias FunctionPage

+
FunctionPage: (() => EmbedPage | Promise<EmbedPage>)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Middleware.html b/docs/types/Middleware.html new file mode 100644 index 0000000..c058c25 --- /dev/null +++ b/docs/types/Middleware.html @@ -0,0 +1,78 @@ +Middleware | discord.js-pages
+
+ +
+
+
+
+ +

Type alias Middleware

+
Middleware: ((message: PagesInteraction) => void)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Page.html b/docs/types/Page.html new file mode 100644 index 0000000..804c874 --- /dev/null +++ b/docs/types/Page.html @@ -0,0 +1,65 @@ +Page | discord.js-pages
+
+ +
+
+
+
+ +

Type alias Page

+
Page: EmbedPage | FunctionPage
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/TriggerCallback.html b/docs/types/TriggerCallback.html new file mode 100644 index 0000000..44535da --- /dev/null +++ b/docs/types/TriggerCallback.html @@ -0,0 +1,84 @@ +TriggerCallback | discord.js-pages
+
+ +
+
+
+
+ +

Type alias TriggerCallback<T>

+
TriggerCallback<T>: ((interaction: MessageComponentInteraction, ...components: T[]) => unknown)
+

Type Parameters

+
    +
  • +

    T extends MessageActionRowComponent

+
+

Type declaration

+
    +
  • +
      +
    • (interaction: MessageComponentInteraction, ...components: T[]): unknown
      • +
    • +
      +

      Parameters

      +
        +
      • +
        interaction: MessageComponentInteraction
        • +
      • +
        Rest ...components: T[]
      +

      Returns unknown

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/TriggersMap.html b/docs/types/TriggersMap.html new file mode 100644 index 0000000..69ec486 --- /dev/null +++ b/docs/types/TriggersMap.html @@ -0,0 +1,65 @@ +TriggersMap | discord.js-pages
+
+ +
+
+
+
+ +

Type alias TriggersMap

+
TriggersMap: Map<EmojiIdentifierResolvable, TriggerCallback<any>>
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file