From 3ec97f60400976c5c863d1f549d7fc2a4d1fbc6a Mon Sep 17 00:00:00 2001 From: zptx-bot Date: Fri, 14 Jun 2024 08:45:18 +0000 Subject: [PATCH] docs: update docs for Skeleton/next --- .../classes/ModuleAutocompleteHandler.html | 24 ++++++++--------- .../next/classes/ModuleButtonHandler.html | 24 ++++++++--------- .../next/classes/ModuleCommandHandler.html | 26 +++++++++---------- Skeleton/next/classes/ModuleEventHandler.html | 26 +++++++++---------- .../classes/ModuleMenuCommandHandler.html | 26 +++++++++---------- .../classes/ModuleMessageCommandHandler.html | 24 ++++++++--------- .../classes/ModuleModalSubmitHandler.html | 24 ++++++++--------- .../next/classes/ModuleSelectMenuHandler.html | 24 ++++++++--------- Skeleton/next/classes/SkeletonClient.html | 20 +++++++------- Skeleton/next/types/AcceptedEventTypes.html | 2 +- .../next/types/InteractionHandlersObject.html | 2 +- Skeleton/next/variables/ZPTXClient.html | 2 +- Skeleton/next/variables/logger.html | 2 +- 13 files changed, 113 insertions(+), 113 deletions(-) diff --git a/Skeleton/next/classes/ModuleAutocompleteHandler.html b/Skeleton/next/classes/ModuleAutocompleteHandler.html index 001c48d..a66d80d 100644 --- a/Skeleton/next/classes/ModuleAutocompleteHandler.html +++ b/Skeleton/next/classes/ModuleAutocompleteHandler.html @@ -1,4 +1,4 @@ -ModuleAutocompleteHandler | Skeleton (next) - v4.1.1

Class ModuleAutocompleteHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleAutocompleteHandler

Constructors

constructor +ModuleAutocompleteHandler | Skeleton (next) - v4.1.1

Class ModuleAutocompleteHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleAutocompleteHandler

Constructors

constructor

Properties

execute type

Methods

isAutocompleteHandler @@ -12,24 +12,24 @@ isUnconfiguredHandler setExecute validate -

Constructors

constructor

Properties

execute

execute: GenericAutocompleteExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericAutocompleteExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the execute function is set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleButtonHandler.html b/Skeleton/next/classes/ModuleButtonHandler.html index 2bbbfe9..392593b 100644 --- a/Skeleton/next/classes/ModuleButtonHandler.html +++ b/Skeleton/next/classes/ModuleButtonHandler.html @@ -1,4 +1,4 @@ -ModuleButtonHandler | Skeleton (next) - v4.1.1

Class ModuleButtonHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleButtonHandler

Constructors

constructor +ModuleButtonHandler | Skeleton (next) - v4.1.1

Class ModuleButtonHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleButtonHandler

Constructors

constructor

Properties

execute type

Methods

isAutocompleteHandler @@ -12,24 +12,24 @@ isUnconfiguredHandler setExecute validate -

Constructors

constructor

Properties

execute

execute: GenericButtonExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericButtonExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the execute function is set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleCommandHandler.html b/Skeleton/next/classes/ModuleCommandHandler.html index 8bdfc7b..b0664a9 100644 --- a/Skeleton/next/classes/ModuleCommandHandler.html +++ b/Skeleton/next/classes/ModuleCommandHandler.html @@ -1,4 +1,4 @@ -ModuleCommandHandler | Skeleton (next) - v4.1.1

Class ModuleCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleCommandHandler

Constructors

constructor +ModuleCommandHandler | Skeleton (next) - v4.1.1

Class ModuleCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleCommandHandler

Constructors

constructor

Properties

data execute type @@ -14,27 +14,27 @@ setData setExecute validate -

Constructors

constructor

Properties

data

data: SlashCommandBuilder

execute

execute: GenericCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

data

data: SlashCommandBuilder

execute

execute: GenericCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setData

setData

  • setData(data): this

  • Sets the SlashCommandBuilder data for this handler.

    Parameters

    • data: SlashCommandBuilder

      The SlashCommandBuilder data.

    Returns this

    This instance for chaining.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the SlashCommandBuilder data and execute function are set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructordataexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetDatasetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordataexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetDatasetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleEventHandler.html b/Skeleton/next/classes/ModuleEventHandler.html index f2e9f9a..5025102 100644 --- a/Skeleton/next/classes/ModuleEventHandler.html +++ b/Skeleton/next/classes/ModuleEventHandler.html @@ -1,4 +1,4 @@ -ModuleEventHandler | Skeleton (next) - v4.1.1

Class ModuleEventHandler<E>

Type Parameters

Hierarchy

  • ModuleBaseHandler
    • ModuleEventHandler

Constructors

constructor +ModuleEventHandler | Skeleton (next) - v4.1.1

Class ModuleEventHandler<E>

Type Parameters

Hierarchy

  • ModuleBaseHandler
    • ModuleEventHandler

Constructors

constructor

Properties

execute once type @@ -15,28 +15,28 @@ setExecute setOnce validate -

Constructors

constructor

Properties

execute

execute: GenericEventExecuteFunction<keyof ClientEvents>

once

once: boolean = false

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericEventExecuteFunction<keyof ClientEvents>

once

once: boolean = false

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setEvent

setEvent

setExecute

  • setExecute(execute): this

  • Parameters

    • execute: E extends keyof ClientEvents
          ? GenericEventExecuteFunction<E<E>>
          : GenericExecuteFunction

    Returns this

setOnce

setExecute

  • setExecute(execute): this

  • Parameters

    • execute: E extends keyof ClientEvents
          ? GenericEventExecuteFunction<E<E>>
          : GenericExecuteFunction

    Returns this

setOnce

  • setOnce(once): this

  • Set whether this event handler should only be called once.

    Parameters

    • once: boolean

      Whether this event handler should only be called once.

    Returns this

    This instance for chaining.

    -

validate

Settings

Member Visibility

Theme

On This Page

constructorexecuteoncetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetEventsetExecutesetOncevalidate
\ No newline at end of file +

validate

Settings

Member Visibility

Theme

On This Page

constructorexecuteoncetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetEventsetExecutesetOncevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleMenuCommandHandler.html b/Skeleton/next/classes/ModuleMenuCommandHandler.html index 04719cf..fc406a8 100644 --- a/Skeleton/next/classes/ModuleMenuCommandHandler.html +++ b/Skeleton/next/classes/ModuleMenuCommandHandler.html @@ -1,4 +1,4 @@ -ModuleMenuCommandHandler | Skeleton (next) - v4.1.1

Class ModuleMenuCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleMenuCommandHandler

Constructors

constructor +ModuleMenuCommandHandler | Skeleton (next) - v4.1.1

Class ModuleMenuCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleMenuCommandHandler

Constructors

constructor

Properties

data execute type @@ -14,27 +14,27 @@ setData setExecute validate -

Constructors

constructor

Properties

data

data: ContextMenuCommandBuilder

execute

execute: GenericMenuCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

data

data: ContextMenuCommandBuilder

execute

execute: GenericMenuCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setData

setData

  • setData(data): this

  • Sets the ContextMenuCommandBuilder data for this handler.

    Parameters

    • data: ContextMenuCommandBuilder

      The ContextMenuCommandBuilder data.

    Returns this

    This instance for chaining.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the ContextMenuCommandBuilder data and execute function are set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructordataexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetDatasetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordataexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetDatasetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleMessageCommandHandler.html b/Skeleton/next/classes/ModuleMessageCommandHandler.html index 37275b9..a49a848 100644 --- a/Skeleton/next/classes/ModuleMessageCommandHandler.html +++ b/Skeleton/next/classes/ModuleMessageCommandHandler.html @@ -1,4 +1,4 @@ -ModuleMessageCommandHandler | Skeleton (next) - v4.1.1

Class ModuleMessageCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleMessageCommandHandler

Constructors

constructor +ModuleMessageCommandHandler | Skeleton (next) - v4.1.1

Class ModuleMessageCommandHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleMessageCommandHandler

Constructors

constructor

Properties

execute type

Methods

isAutocompleteHandler @@ -12,24 +12,24 @@ isUnconfiguredHandler setExecute validate -

Constructors

constructor

Properties

execute

execute: GenericMessageCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericMessageCommandExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the execute function is set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleModalSubmitHandler.html b/Skeleton/next/classes/ModuleModalSubmitHandler.html index b03ddc2..e51032f 100644 --- a/Skeleton/next/classes/ModuleModalSubmitHandler.html +++ b/Skeleton/next/classes/ModuleModalSubmitHandler.html @@ -1,4 +1,4 @@ -ModuleModalSubmitHandler | Skeleton (next) - v4.1.1

Class ModuleModalSubmitHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleModalSubmitHandler

Constructors

constructor +ModuleModalSubmitHandler | Skeleton (next) - v4.1.1

Class ModuleModalSubmitHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleModalSubmitHandler

Constructors

constructor

Properties

execute type

Methods

isAutocompleteHandler @@ -12,24 +12,24 @@ isUnconfiguredHandler setExecute validate -

Constructors

constructor

Properties

execute

execute: GenericModalSubmitExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericModalSubmitExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the execute function is set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/ModuleSelectMenuHandler.html b/Skeleton/next/classes/ModuleSelectMenuHandler.html index ce1e5a2..3c10e9b 100644 --- a/Skeleton/next/classes/ModuleSelectMenuHandler.html +++ b/Skeleton/next/classes/ModuleSelectMenuHandler.html @@ -1,4 +1,4 @@ -ModuleSelectMenuHandler | Skeleton (next) - v4.1.1

Class ModuleSelectMenuHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleSelectMenuHandler

Constructors

constructor +ModuleSelectMenuHandler | Skeleton (next) - v4.1.1

Class ModuleSelectMenuHandler

Hierarchy

  • ModuleBaseHandler
    • ModuleSelectMenuHandler

Constructors

constructor

Properties

execute type

Methods

isAutocompleteHandler @@ -12,24 +12,24 @@ isUnconfiguredHandler setExecute validate -

Constructors

constructor

Properties

execute

execute: GenericSelectMenuExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

Constructors

constructor

Properties

execute

execute: GenericSelectMenuExecuteFunction

Readonly type

type: string = ...

Methods

isAutocompleteHandler

isButtonHandler

isButtonHandler

isCommandHandler

isCommandHandler

isEventHandler

isEventHandler

isMenuCommandHandler

isMenuCommandHandler

isMessageCommandHandler

isMessageCommandHandler

isModalSubmitHandler

isModalSubmitHandler

isSelectMenuHandler

isSelectMenuHandler

isUnconfiguredHandler

isUnconfiguredHandler

  • isUnconfiguredHandler(): this is ModuleBaseHandler

  • Checks if this handler is an unconfigured handler.

    Returns this is ModuleBaseHandler

    Whether this handler is an unconfigured handler.

    -

setExecute

validate

setExecute

validate

  • validate(): boolean

  • Validates the handler, ensuring the execute function is set.

    Returns boolean

    Whether the handler is valid.

    -

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorexecutetypeisAutocompleteHandlerisButtonHandlerisCommandHandlerisEventHandlerisMenuCommandHandlerisMessageCommandHandlerisModalSubmitHandlerisSelectMenuHandlerisUnconfiguredHandlersetExecutevalidate
\ No newline at end of file diff --git a/Skeleton/next/classes/SkeletonClient.html b/Skeleton/next/classes/SkeletonClient.html index 3c17d86..adf5406 100644 --- a/Skeleton/next/classes/SkeletonClient.html +++ b/Skeleton/next/classes/SkeletonClient.html @@ -1,4 +1,4 @@ -SkeletonClient | Skeleton (next) - v4.1.1

Class SkeletonClient

Hierarchy

  • Client
    • SkeletonClient

Constructors

constructor +SkeletonClient | Skeleton (next) - v4.1.1

Class SkeletonClient

Hierarchy

  • Client
    • SkeletonClient

Constructors

constructor

Properties

_logger application channels @@ -78,17 +78,17 @@
  • Optional appName: string

    The name of the application

    • Returns SkeletonClient

    Example

    const client = new SkeletonClient(
        {
            intents: [
                GatewayIntentBits.Guilds,
            ],
            partials: [
                Partials.Channel
            ],
        },
        'MusicBot'
    );
    -
  • new SkeletonClient(options, appOptions): SkeletonClient

  • Creates an instance of SkeletonClient.

    +
  • new SkeletonClient(options, appOptions): SkeletonClient

  • Creates an instance of SkeletonClient.

    Parameters

    • options: ClientOptions

      discord.js ClientOptions

    • appOptions: {
          appName?: string;
          prefix?: string | string[];
      }

      Options for the application

      • Optional appName?: string
      • Optional prefix?: string | string[]

    Returns SkeletonClient

    Example

    const client = new SkeletonClient(
        {
            intents: [
                GatewayIntentBits.Guilds,
            ],
            partials: [
                Partials.Channel
            ],
        },
        { appName: 'MusicBot', prefix: 'm!' }
    );

    Example

    const client = new SkeletonClient(
        {
            intents: [
                GatewayIntentBits.Guilds,
            ],
            partials: [
                Partials.Channel
            ],
        },
        { appName: 'MusicBot', prefix: ['musicbot ', '@mention ', 'm!'] }
    );
    -

    • Properties

    Private _logger

    _logger: LoggerObject = ...

    Internal logger

    -

    application

    application: ClientApplication

    channels

    channels: ChannelManager

    Private commandData

    commandData: SlashCommandBuilder[] = []

    Command data stored internally for use in deploying commands

    -

    Private deploy

    deploy: boolean = ...

    Protected eventHandlers

    eventHandlers: Collection<string, ModuleEventHandler<AcceptedEventTypes>[]> = ...

    guilds

    guilds: GuildManager

    Private initialized

    initialized: boolean = false

    Protected interactionHandlers

    interactionHandlers: InteractionHandlersObject = ...

    logger

    logger: LoggerObject

    Private menuCommandData

    menuCommandData: ContextMenuCommandBuilder[] = []

    Menu command data stored internally for use in deploying commands

    -

    Protected messageCommandHandlers

    messageCommandHandlers: Collection<string, ModuleMessageCommandHandler> = ...

    options

    options: Omit<ClientOptions, "intents"> & {
        intents: IntentsBitField;
    }

    Type declaration

    • intents: IntentsBitField

    Private prefix

    prefix: string[] = []

    readyTimestamp

    readyTimestamp: number

    rest

    rest: REST

    shard

    shard: ShardClientUtil

    sweepers

    sweepers: Sweepers

    token

    token: string

    user

    user: ClientUser

    users

    users: UserManager

    Private verbose

    verbose: boolean = ...

    voice

    voice: ClientVoiceManager

    ws

    ws: WebSocketManager

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    Properties

    Private _logger

    _logger: LoggerObject = ...

    Internal logger

    +

    application

    application: ClientApplication

    channels

    channels: ChannelManager

    Private commandData

    commandData: SlashCommandBuilder[] = []

    Command data stored internally for use in deploying commands

    +

    Private deploy

    deploy: boolean = ...

    Protected eventHandlers

    eventHandlers: Collection<string, ModuleEventHandler<AcceptedEventTypes>[]> = ...

    guilds

    guilds: GuildManager

    Private initialized

    initialized: boolean = false

    Protected interactionHandlers

    interactionHandlers: InteractionHandlersObject = ...

    logger

    logger: LoggerObject

    Private menuCommandData

    menuCommandData: ContextMenuCommandBuilder[] = []

    Menu command data stored internally for use in deploying commands

    +

    Protected messageCommandHandlers

    messageCommandHandlers: Collection<string, ModuleMessageCommandHandler> = ...

    options

    options: Omit<ClientOptions, "intents"> & {
        intents: IntentsBitField;
    }

    Type declaration

    • intents: IntentsBitField

    Private prefix

    prefix: string[] = []

    readyTimestamp

    readyTimestamp: number

    rest

    rest: REST

    shard

    shard: ShardClientUtil

    sweepers

    sweepers: Sweepers

    token

    token: string

    user

    user: ClientUser

    users

    users: UserManager

    Private verbose

    verbose: boolean = ...

    voice

    voice: ClientVoiceManager

    ws

    ws: WebSocketManager

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    See how to write a custom rejection handler.

    Since

    v13.4.0, v12.16.0

    Static captureRejections

    captureRejections: boolean

    Value: boolean

    @@ -125,8 +125,8 @@

    Example

    const

    Accessors

    Private _censoredToken

    • get _censoredToken(): string

    • Returns string

    emojis

    • get emojis(): BaseGuildEmojiManager

    • Returns BaseGuildEmojiManager

    readyAt

    • get readyAt(): If<Ready, Date, null>

    • Returns If<Ready, Date, null>

    uptime

    • get uptime(): If<Ready, number, null>

    • Returns If<Ready, number, null>

    Methods

    [asyncDispose]

    • [asyncDispose](): Promise<void>

    • Returns Promise<void>

    Optional [captureRejectionSymbol]

    • [captureRejectionSymbol]<K>(error, event, ...args): void

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest ...args: AnyRest

      Returns void

    addListener

    • addListener<K>(eventName, listener): this

    • Alias for emitter.on(eventName, listener).

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

    deleteCommands

    • deleteCommands(): Promise<void>

    • Deletes application commands. Only use after you've logged in to Discord.

      -

      Returns Promise<void>

    deleteWebhook

    • deleteWebhook(id, options?): Promise<void>

    • Parameters

      • id: string
      • Optional options: WebhookDeleteOptions

      Returns Promise<void>

    deployCommands

    • deployCommands(): Promise<void>

    • Deploys application commands. Only use after you've initialized the client and logged in to Discord.

      -

      Returns Promise<void>

    destroy

    • destroy(): Promise<void>

    • Returns Promise<void>

    emit

    • emit<Event>(event, ...args): boolean

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      Returns boolean

    • emit<Event>(event, ...args): boolean

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • Rest ...args: unknown[]

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered +

      Returns Promise<void>

    deleteWebhook

    • deleteWebhook(id, options?): Promise<void>

    • Parameters

      • id: string
      • Optional options: WebhookDeleteOptions

      Returns Promise<void>

    deployCommands

    • deployCommands(): Promise<void>

    • Deploys application commands. Only use after you've initialized the client and logged in to Discord.

      +

      Returns Promise<void>

    destroy

    • destroy(): Promise<void>

    • Returns Promise<void>

    emit

    • emit<Event>(event, ...args): boolean

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      Returns boolean

    • emit<Event>(event, ...args): boolean

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • Rest ...args: unknown[]

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
      @@ -139,7 +139,7 @@

      Example

      const
      Parameters
      • baseURL: string
        The base URL (usually import.meta.url) of the main/index file
        
 
      Returns Promise<void>
      Example
      await client.initialize(import.meta.url);
      client.login(process.env.DISCORD_BOT_TOKEN);
 
      
-

    isReady

    • isReady(): this is Client<true>

    • Returns this is Client<true>

    listenerCount

    • listenerCount<K>(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. +

    isReady

    • isReady(): this is Client<true>

    • Returns this is Client<true>

    listenerCount

    • listenerCount<K>(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

        @@ -149,7 +149,7 @@

        Example

        constserver.on('connection', (stream) => {
          console.log('someone connected!');
        });
        console.log(util.inspect(server.listeners('connection')));
        // Prints: [ [Function] ]

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol

        Returns Function[]

        Since

        v0.1.26

        -

    login

    • login(token): Promise<string>

    • Parameters

      • token: string

      Returns Promise<string>

    off

    • off<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • off<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    on

    • on<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • on<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    once

    • once<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • once<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    prependListener

    • prependListener<K>(eventName, listener): this

    • Adds the listener function to the beginning of the listeners array for the +

    login

    • login(token): Promise<string>

    • Parameters

      • token: string

      Returns Promise<string>

    off

    • off<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • off<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    on

    • on<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • on<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    once

    • once<Event>(event, listener): this

    • Type Parameters

      • Event extends keyof ClientEvents

      Parameters

      • event: Event
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: ClientEvents[Event]

            Returns void

      Returns this

    • once<Event>(event, listener): this

    • Type Parameters

      • Event extends string | symbol

      Parameters

      • event: Exclude<Event, keyof ClientEvents>
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    prependListener

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/Skeleton/next/variables/logger.html b/Skeleton/next/variables/logger.html index 93e7b37..429637e 100644 --- a/Skeleton/next/variables/logger.html +++ b/Skeleton/next/variables/logger.html @@ -1,2 +1,2 @@ logger | Skeleton (next) - v4.1.1

    Variable loggerConst

    logger: Logger = DeprecatedLogger

    Deprecated

    Use the logger provided by SkeletonClient instead.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file