From a5863d799a984174ae80620942356c423a06d45e Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Wed, 8 May 2024 18:27:05 +0000 Subject: [PATCH] deploy: 56db02cc12a10b67c03cba0443a5d99a51453799 --- classes/_buape_dotperms.PermissionUser.html | 10 ++-- .../_buape_experiments.ExperimentManager.html | 4 +- classes/_buape_lib.ApplicationCommand.html | 22 ++++---- .../_buape_lib.ApplicationCommandHandler.html | 4 +- classes/_buape_lib.AutocompleteHandler.html | 12 ++--- classes/_buape_lib.BetterClient.html | 54 +++++++++---------- classes/_buape_lib.Button.html | 16 +++--- classes/_buape_lib.ButtonHandler.html | 4 +- classes/_buape_lib.Dropdown.html | 16 +++--- classes/_buape_lib.DropdownHandler.html | 4 +- classes/_buape_lib.EventHandler.html | 14 ++--- classes/_buape_lib.ModalSubmit.html | 10 ++-- classes/_buape_lib.ModalSubmitHandler.html | 16 +++--- classes/_buape_lib.Paginator.html | 52 +++++++++--------- classes/_buape_lib.TextCommand.html | 4 +- classes/_buape_lib.TextCommandHandler.html | 4 +- classes/_buape_lib.Type.html | 32 +++++------ classes/_buape_lib._BaseComponent.html | 24 ++++----- classes/_buape_lib._BaseHandler.html | 4 +- classes/kiai_js.APIError.html | 14 ++--- classes/kiai_js.KiaiClient.html | 6 +-- classes/kiai_js.RatelimitError.html | 16 +++--- enums/_buape_lib.HandlerType.html | 4 +- enums/_buape_lib.LogLevel.html | 4 +- functions/_buape_functions.checkAccess.html | 2 +- functions/_buape_functions.emojiList.html | 2 +- functions/_buape_functions.generateEmbed.html | 2 +- .../_buape_functions.generateTimestamp.html | 2 +- functions/_buape_functions.getFiles.html | 2 +- functions/_buape_functions.parseUser.html | 2 +- functions/_buape_functions.randomInt.html | 2 +- functions/_buape_functions.titleCase.html | 2 +- functions/_buape_functions.uploadHaste.html | 2 +- .../_buape_dotperms.UserPermissionSet.html | 2 +- .../_buape_dotperms.UserPermissions.html | 2 +- .../_buape_experiments.experimentData.html | 4 +- interfaces/_buape_functions.AccessRoles.html | 2 +- .../_buape_functions.AccessSettings.html | 4 +- ...pe_functions.GenerateTimestampOptions.html | 4 +- .../_buape_functions.GeneratedMessage.html | 4 +- .../_buape_lib.ApplicationCommandOptions.html | 4 +- .../_buape_lib.BaseComponentOptions.html | 4 +- interfaces/_buape_lib.EventEmitterLike.html | 4 +- interfaces/_buape_lib.EventOptions.html | 4 +- interfaces/_buape_lib.LibConfig.html | 4 +- types/_buape_dotperms.Permission.html | 2 +- types/_buape_lib.ButtonOptions.html | 2 +- types/_buape_lib.DropdownOptions.html | 2 +- types/_buape_lib.PaginatorMessage.html | 2 +- types/_buape_lib.TextCommandOptions.html | 2 +- 50 files changed, 210 insertions(+), 210 deletions(-) diff --git a/classes/_buape_dotperms.PermissionUser.html b/classes/_buape_dotperms.PermissionUser.html index 008e4dce..fe41b4f4 100644 --- a/classes/_buape_dotperms.PermissionUser.html +++ b/classes/_buape_dotperms.PermissionUser.html @@ -1,4 +1,4 @@ -PermissionUser | Buape Utilities - v0.0.0

Class PermissionUser

Constructors

constructor +PermissionUser | Buape Utilities - v0.0.0

Class PermissionUser

Constructors

constructor

Properties

id permissions

Methods

addPermissions @@ -6,9 +6,9 @@ list

Constructors

constructor

Properties

id

id: string

permissions

permissions: UserPermissions

Methods

addPermissions

check

  • check(permission): boolean | UserPermissionSet

  • Check a permission against the user's permissions

    +

Returns PermissionUser

Properties

id

id: string

permissions

permissions: UserPermissions

Methods

addPermissions

check

list

  • list(): Permission[]

  • List all permissions the user has

    +

Returns boolean | UserPermissionSet

list

Settings

Member Visibility

Theme

On This Page

constructoridpermissionsaddPermissionschecklist
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridpermissionsaddPermissionschecklist
\ No newline at end of file diff --git a/classes/_buape_experiments.ExperimentManager.html b/classes/_buape_experiments.ExperimentManager.html index 3c7df353..c8cb3a15 100644 --- a/classes/_buape_experiments.ExperimentManager.html +++ b/classes/_buape_experiments.ExperimentManager.html @@ -1,7 +1,7 @@ -ExperimentManager | Buape Utilities - v0.0.0

Class ExperimentManager

Constructors

constructor +ExperimentManager | Buape Utilities - v0.0.0

Class ExperimentManager

Constructors

constructor

Properties

experiments

Methods

checkExperimentAccess getExperimentByHash getExperimentByKey loadExperiments -

Constructors

constructor

Properties

experiments

experiments: Experiment[]

Methods

checkExperimentAccess

  • checkExperimentAccess(featureKey, guildId): boolean

  • Parameters

    • featureKey: string
    • guildId: string

    Returns boolean

getExperimentByHash

  • getExperimentByHash(id): undefined | Experiment

  • Parameters

    • id: number

    Returns undefined | Experiment

getExperimentByKey

  • getExperimentByKey(key): undefined | Experiment

  • Parameters

    • key: string

    Returns undefined | Experiment

Private loadExperiments

Settings

Member Visibility

Theme

On This Page

constructorexperimentscheckExperimentAccessgetExperimentByHashgetExperimentByKeyloadExperiments
\ No newline at end of file +

Constructors

constructor

Properties

experiments

experiments: Experiment[]

Methods

checkExperimentAccess

  • checkExperimentAccess(featureKey, guildId): boolean

  • Parameters

    • featureKey: string
    • guildId: string

    Returns boolean

getExperimentByHash

  • getExperimentByHash(id): undefined | Experiment

  • Parameters

    • id: number

    Returns undefined | Experiment

getExperimentByKey

  • getExperimentByKey(key): undefined | Experiment

  • Parameters

    • key: string

    Returns undefined | Experiment

Private loadExperiments

Settings

Member Visibility

Theme

On This Page

constructorexperimentscheckExperimentAccessgetExperimentByHashgetExperimentByKeyloadExperiments
\ No newline at end of file diff --git a/classes/_buape_lib.ApplicationCommand.html b/classes/_buape_lib.ApplicationCommand.html index c604d138..e023b890 100644 --- a/classes/_buape_lib.ApplicationCommand.html +++ b/classes/_buape_lib.ApplicationCommand.html @@ -1,5 +1,5 @@ ApplicationCommand | Buape Utilities - v0.0.0

Class ApplicationCommand

The base component class that other components extend from.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

authorOnly client cooldown @@ -13,19 +13,19 @@ run specificValidate validate -

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

-

Readonly client

client: BetterClient

The client that instantiated this component.

-

Readonly cooldown

cooldown: number

The cooldown of this component. +

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

+

Readonly client

client: BetterClient

The client that instantiated this component.

+

Readonly cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

-

Readonly description

description: string

The description of the command

-

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

-

Readonly key

key: string

The key of this component. +

Readonly description

description: string

The description of the command

+

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

+

Readonly key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

-

Readonly options

options: ApplicationCommandOptionData[] = []

The options of the command

+

Readonly options

options: ApplicationCommandOptionData[] = []

The options of the command

Default

[]
-

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

-

Readonly type

type: ApplicationCommandType = ApplicationCommandType.ChatInput

The type of the command

+

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

+

Readonly type

type: ApplicationCommandType = ApplicationCommandType.ChatInput

The type of the command

Default

ApplicationCommandType.ChatInput
-

Methods

autocomplete

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndescriptiondmPermissionkeyoptionspermissionstypeautocompleterunspecificValidatevalidate
\ No newline at end of file +

Methods

autocomplete

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndescriptiondmPermissionkeyoptionspermissionstypeautocompleterunspecificValidatevalidate
\ No newline at end of file diff --git a/classes/_buape_lib.ApplicationCommandHandler.html b/classes/_buape_lib.ApplicationCommandHandler.html index 5eddde1c..a01dd4d1 100644 --- a/classes/_buape_lib.ApplicationCommandHandler.html +++ b/classes/_buape_lib.ApplicationCommandHandler.html @@ -1,4 +1,4 @@ -ApplicationCommandHandler | Buape Utilities - v0.0.0

Class ApplicationCommandHandler

Hierarchy (view full)

Constructors

constructor +ApplicationCommandHandler | Buape Utilities - v0.0.0

Class ApplicationCommandHandler

Hierarchy (view full)

Constructors

constructor

Properties

client cooldowns

Methods

fetchComponent @@ -8,4 +8,4 @@ postLoad reloadFiles specificChecks -

Constructors

constructor

Properties

client

client: BetterClient

Private cooldowns

cooldowns: Collection<string, number>

Methods

fetchComponent

Private getDiscordCommandData

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientcooldownsfetchComponentgetDiscordCommandDatahandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file +

Constructors

constructor

Properties

client

client: BetterClient

Private cooldowns

cooldowns: Collection<string, number>

Methods

fetchComponent

Private getDiscordCommandData

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientcooldownsfetchComponentgetDiscordCommandDatahandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file diff --git a/classes/_buape_lib.AutocompleteHandler.html b/classes/_buape_lib.AutocompleteHandler.html index b1502c52..ce68cdce 100644 --- a/classes/_buape_lib.AutocompleteHandler.html +++ b/classes/_buape_lib.AutocompleteHandler.html @@ -1,17 +1,17 @@ -AutocompleteHandler | Buape Utilities - v0.0.0

Class AutocompleteHandler

Constructors

constructor +AutocompleteHandler | Buape Utilities - v0.0.0

Class AutocompleteHandler

Constructors

constructor

Properties

client

Methods

fetchAutocomplete handleAutocomplete runAutocomplete

Constructors

constructor

Properties

Private Readonly client

client: BetterClient

Our client.

-

Methods

Private fetchAutocomplete

  • fetchAutocomplete(name): undefined | ApplicationCommand

  • Fetch the autocomplete with the provided name.

    +

Returns AutocompleteHandler

Properties

Private Readonly client

client: BetterClient

Our client.

+

Methods

Private fetchAutocomplete

handleAutocomplete

handleAutocomplete

  • handleAutocomplete(interaction): Promise<void>

  • Handle the interaction created for this autocomplete to make sure the user and client can execute it.

    Parameters

    • interaction: AutocompleteInteraction<CacheType>

      The interaction created.

      -

    Returns Promise<void>

Private runAutocomplete

  • runAutocomplete(autocomplete, interaction): Promise<void>

  • Execute our autocomplete.

    +

Returns Promise<void>

Private runAutocomplete

Settings

Member Visibility

Theme

On This Page

constructorclientfetchAutocompletehandleAutocompleterunAutocomplete
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorclientfetchAutocompletehandleAutocompleterunAutocomplete
\ No newline at end of file diff --git a/classes/_buape_lib.BetterClient.html b/classes/_buape_lib.BetterClient.html index 4f9fdc42..1b72b1d9 100644 --- a/classes/_buape_lib.BetterClient.html +++ b/classes/_buape_lib.BetterClient.html @@ -1,4 +1,4 @@ -BetterClient | Buape Utilities - v0.0.0

Class BetterClient

Hierarchy

  • Client
    • BetterClient

Constructors

constructor +BetterClient | Buape Utilities - v0.0.0

Class BetterClient

Hierarchy

  • Client
    • BetterClient

Constructors

constructor

Properties

__dirname application applicationCommandHandler @@ -84,49 +84,49 @@ once setMaxListeners

Constructors

constructor

Properties

Readonly __dirname

__dirname: string

__dirname is not in our version of ECMA, so we make do with a shitty fix.

-

application

application: null | ClientApplication

Readonly applicationCommandHandler

applicationCommandHandler: ApplicationCommandHandler

applicationCommands

applicationCommands: Collection<string, ApplicationCommand>

Readonly autocompleteHandler

autocompleteHandler: AutocompleteHandler

Readonly buttonHandler

buttonHandler: ButtonHandler

buttons

buttons: Collection<string, Button>

channels

channels: ChannelManager

config

config: LibConfig

Readonly dropdownHandler

dropdownHandler: DropdownHandler

dropdowns

dropdowns: Collection<string, Dropdown>

events

events: Map<string, EventHandler>

guilds

guilds: GuildManager

hasteStore

hasteStore: Collection<string, string[]>

localeCache

localeCache: Collection<string, Locale> = ...

Readonly modalSubmitHandler

modalSubmitHandler: ModalSubmitHandler

modals

modals: Collection<string, ModalSubmit>

options

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

Type declaration

  • intents: IntentsBitField

readyTimestamp

readyTimestamp: null | number

rest

rest: REST

shard

shard: null | ShardClientUtil

sudo

sudo: Collection<string, string> = ...

sweepers

sweepers: Sweepers

Readonly textCommandHandler

textCommandHandler: TextCommandHandler

textCommands

textCommands: Collection<string, TextCommand>

token

token: null | string

user

user: null | ClientUser

userChannelCache

userChannelCache: Collection<`${string}-${string}`, string>

users

users: UserManager

usersUsingBot

usersUsingBot: Set<string> = ...

voice

voice: ClientVoiceManager

ws

ws: WebSocketManager

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' +

Parameters

Returns BetterClient

Properties

Readonly __dirname

__dirname: string

__dirname is not in our version of ECMA, so we make do with a shitty fix.

+

application

application: null | ClientApplication

Readonly applicationCommandHandler

applicationCommandHandler: ApplicationCommandHandler

applicationCommands

applicationCommands: Collection<string, ApplicationCommand>

Readonly autocompleteHandler

autocompleteHandler: AutocompleteHandler

Readonly buttonHandler

buttonHandler: ButtonHandler

buttons

buttons: Collection<string, Button>

channels

channels: ChannelManager

config

config: LibConfig

Readonly dropdownHandler

dropdownHandler: DropdownHandler

dropdowns

dropdowns: Collection<string, Dropdown>

events

events: Map<string, EventHandler>

guilds

guilds: GuildManager

hasteStore

hasteStore: Collection<string, string[]>

localeCache

localeCache: Collection<string, Locale> = ...

Readonly modalSubmitHandler

modalSubmitHandler: ModalSubmitHandler

modals

modals: Collection<string, ModalSubmit>

options

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

Type declaration

  • intents: IntentsBitField

readyTimestamp

readyTimestamp: null | number

rest

rest: REST

shard

shard: null | ShardClientUtil

sudo

sudo: Collection<string, string> = ...

sweepers

sweepers: Sweepers

Readonly textCommandHandler

textCommandHandler: TextCommandHandler

textCommands

textCommands: Collection<string, TextCommand>

token

token: null | string

user

user: null | ClientUser

userChannelCache

userChannelCache: Collection<`${string}-${string}`, string>

users

users: UserManager

usersUsingBot

usersUsingBot: Set<string> = ...

voice

voice: ClientVoiceManager

ws

ws: WebSocketManager

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

+

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Accessors

Private _censoredToken

  • get _censoredToken(): null | string

  • Returns null | 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).

    +

Accessors

Private _censoredToken

  • get _censoredToken(): null | string

  • Returns null | 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

    -

deleteWebhook

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

  • Parameters

    • id: string
    • Optional options: WebhookDeleteOptions

    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 +

deleteWebhook

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

  • Parameters

    • id: string
    • Optional options: WebhookDeleteOptions

    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.

    const EventEmitter = require('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) ]

    Returns (string | symbol)[]

    Since

    v6.0.0

    -

fetchGuildPreview

  • fetchGuildPreview(guild): Promise<GuildPreview>

  • Parameters

    • guild: GuildResolvable

    Returns Promise<GuildPreview>

fetchGuildTemplate

  • fetchGuildTemplate(template): Promise<GuildTemplate>

  • Parameters

    • template: string

    Returns Promise<GuildTemplate>

fetchGuildWidget

  • fetchGuildWidget(guild): Promise<Widget>

  • Parameters

    • guild: GuildResolvable

    Returns Promise<Widget>

fetchInvite

  • fetchInvite(invite, options?): Promise<Invite>

  • Parameters

    • invite: string
    • Optional options: ClientFetchInviteOptions

    Returns Promise<Invite>

fetchPremiumStickerPacks

  • fetchPremiumStickerPacks(): Promise<Collection<string, StickerPack>>

  • Returns Promise<Collection<string, StickerPack>>

    Deprecated

    Use Client.fetchStickerPacks instead.

    +

fetchGuildPreview

  • fetchGuildPreview(guild): Promise<GuildPreview>

  • Parameters

    • guild: GuildResolvable

    Returns Promise<GuildPreview>

fetchGuildTemplate

  • fetchGuildTemplate(template): Promise<GuildTemplate>

  • Parameters

    • template: string

    Returns Promise<GuildTemplate>

fetchGuildWidget

  • fetchGuildWidget(guild): Promise<Widget>

  • Parameters

    • guild: GuildResolvable

    Returns Promise<Widget>

fetchInvite

  • fetchInvite(invite, options?): Promise<Invite>

  • Parameters

    • invite: string
    • Optional options: ClientFetchInviteOptions

    Returns Promise<Invite>

fetchPremiumStickerPacks

  • fetchPremiumStickerPacks(): Promise<Collection<string, StickerPack>>

  • Returns Promise<Collection<string, StickerPack>>

    Deprecated

    Use Client.fetchStickerPacks instead.

fetchSticker

  • fetchSticker(id): Promise<Sticker>

  • Parameters

    • id: string

    Returns Promise<Sticker>

fetchStickerPacks

  • fetchStickerPacks(): Promise<Collection<string, StickerPack>>

  • Returns Promise<Collection<string, StickerPack>>

fetchVoiceRegions

  • fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>

  • Returns Promise<Collection<string, VoiceRegion>>

fetchWebhook

  • fetchWebhook(id, token?): Promise<Webhook<WebhookType>>

  • Parameters

    • id: string
    • Optional token: string

    Returns Promise<Webhook<WebhookType>>

generateInvite

  • generateInvite(options?): string

  • Parameters

    • Optional options: InviteGenerationOptions

    Returns string

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

    -

hasteFlush

  • hasteFlush(id, url?): Promise<null | string>

  • This function is used to upload a hastebin stored using the hasteLog function.

    +

hasteFlush

  • hasteFlush(id, url?): Promise<null | string>

  • This function is used to upload a hastebin stored using the hasteLog function.

    Parameters

    • id: string

      The ID of the store you are using.

    • Optional url: string

      The URL to upload the hastebin to. If not provided, it will use the default hastebin.

    Returns Promise<null | string>

    The resulting URL

    -

hasteLog

hasteLog

  • hasteLog(id, text): void

  • This function is used when you want to slowly generate a hastebin. It provides a collection that can be accessed from the client, and will automatically append each string to a new line. You can use the hasteFlush function to upload the hastebin.

    Parameters

    • id: string

      The ID of the store you are using.

    • text: string

      The text to add to the store.

      -

    Returns void

isReady

  • isReady(): this is Client<true>

  • Returns this is Client<true>

listenerCount

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

  • Returns the number of listeners listening to the event named eventName.

    +

Returns void

isReady

  • isReady(): this is Client<true>

  • Returns this is Client<true>

listenerCount

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

  • Returns the number of listeners listening to 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

    • Optional listener: Function

      The event handler function

    Returns number

    Since

    v3.2.0

    -

listeners

  • listeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

listeners

  • listeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    server.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

    -

Private loadEvents

log

  • log(message, level?): void

  • Log to the console. This function can be overridden to provide a custom logger.

    +

Private loadEvents

log

  • log(message, level?): void

  • Log to the console. This function can be overridden to provide a custom logger.

    Parameters

    • message: string

      The message to log.

    • level: LogLevel = LogLevel.INFO

      The level of the log.

      -

    Returns void

login

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 +

Returns void

login

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 event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -136,7 +136,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v6.0.0

    -

prependOnceListener

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

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

prependOnceListener

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

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    @@ -144,13 +144,13 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v6.0.0

    -

rawListeners

  • rawListeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName, +

rawListeners

  • rawListeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v9.4.0

    -

reloadEvents

removeAllListeners

  • removeAllListeners<Event>(event?): this

  • Type Parameters

    • Event extends keyof ClientEvents

    Parameters

    Returns this

  • removeAllListeners<Event>(event?): this

  • Type Parameters

    • Event extends string | symbol

    Parameters

    • Optional event: Exclude<Event, keyof ClientEvents>

    Returns this

removeListener

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

  • Removes the specified listener from the listener array for the event namedeventName.

    +

reloadEvents

removeAllListeners

  • removeAllListeners<Event>(event?): this

  • Type Parameters

    • Event extends keyof ClientEvents

    Parameters

    Returns this

  • removeAllListeners<Event>(event?): this

  • Type Parameters

    • Event extends string | symbol

    Parameters

    • Optional event: Exclude<Event, keyof ClientEvents>

    Returns this

removeListener

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

  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the @@ -174,13 +174,13 @@

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • K

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

    -

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are +

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

    -

toJSON

  • toJSON(): unknown

  • Returns unknown

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    +

toJSON

  • toJSON(): unknown

  • Returns unknown

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -194,7 +194,7 @@

    Parameters

    • signal: AbortSignal
    • resource: ((event) => void)
        • (event): void

        • Parameters

          • event: Event

          Returns void

    Returns Disposable

    Disposable that removes the abort listener.

    Since

    v18.18.0

    -

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the @@ -202,7 +202,7 @@ 

    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }

    Parameters

    • emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget
    • name: string | symbol

    Returns Function[]

    Since

    v15.2.0, v14.17.0

    -

Static getMaxListeners

  • getMaxListeners(emitter): number

  • Returns the currently set max amount of listeners.

    +

Static getMaxListeners

  • getMaxListeners(emitter): number

  • Returns the currently set max amount of listeners.

    For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

    For EventTargets this is the only way to get the max event listeners for the @@ -211,14 +211,14 @@ 

    import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

    {
      const ee = new EventEmitter();
      console.log(getMaxListeners(ee)); // 10
      setMaxListeners(11, ee);
      console.log(getMaxListeners(ee)); // 11
    }
    {
      const et = new EventTarget();
      console.log(getMaxListeners(et)); // 10
      setMaxListeners(11, et);
      console.log(getMaxListeners(et)); // 11
    }

    Parameters

    • emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget

    Returns number

    Since

    v18.17.0

    -

Static listenerCount

  • listenerCount(emitter, eventName): number

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +

Static listenerCount

  • listenerCount(emitter, eventName): number

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2

    Parameters

    • emitter: EventEmitter<DefaultEventMap>

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

Static on

  • on(emitter, eventName, options?): AsyncIterableIterator<any>
  • const { on, EventEmitter } = require('events');

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();
+

Static on

  • on(emitter, eventName, options?): AsyncIterableIterator<any>
  • const { on, EventEmitter } = require('events');

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when @@ -230,7 +230,7 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter<DefaultEventMap>
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    Since

    v13.6.0, v12.16.0

    -
  • on<Emitter, Events>(eventEmitter, eventName): AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

  • Type Parameters

    • Emitter extends __module
    • Events extends keyof ClientEvents

    Parameters

    Returns AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

Static once

  • once(emitter, eventName, options?): Promise<any[]>

  • Creates a Promise that is fulfilled when the EventEmitter emits the given +

  • on<Emitter, Events>(eventEmitter, eventName): AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

  • Type Parameters

    • Emitter extends __module
    • Events extends keyof ClientEvents

    Parameters

    Returns AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

Static once

  • once(emitter, eventName, options?): Promise<any[]>

  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

    @@ -247,8 +247,8 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

    Since

    v11.13.0, v10.16.0

    -
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • once<Emitter, Event>(eventEmitter, eventName): Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

  • Type Parameters

    • Emitter extends __module
    • Event extends keyof ClientEvents

    Parameters

    Returns Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

Static setMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • const {
      setMaxListeners,
      EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • once<Emitter, Event>(eventEmitter, eventName): Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

  • Type Parameters

    • Emitter extends __module
    • Event extends keyof ClientEvents

    Parameters

    Returns Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

Static setMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • const {
      setMaxListeners,
      EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);

    Parameters

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest ...eventTargets: (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]

    Returns void

    Since

    v15.4.0

    -

Settings

Member Visibility

Theme

On This Page

constructor__dirnameapplicationapplicationCommandHandlerapplicationCommandsautocompleteHandlerbuttonHandlerbuttonschannelsconfigdropdownHandlerdropdownseventsguildshasteStorelocaleCachemodalSubmitHandlermodalsoptionsreadyTimestamprestshardsudosweeperstextCommandHandlertextCommandstokenuseruserChannelCacheusersusersUsingBotvoicewscaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor_censoredTokenemojisreadyAtuptime[asyncDispose][captureRejectionSymbol]addListenerdeleteWebhookdestroyemiteventNamesfetchGuildPreviewfetchGuildTemplatefetchGuildWidgetfetchInvitefetchPremiumStickerPacksfetchStickerfetchStickerPacksfetchVoiceRegionsfetchWebhookgenerateInvitegetMaxListenershasteFlushhasteLogisReadylistenerCountlistenersloadEventslogloginoffononceprependListenerprependOnceListenerrawListenersreloadEventsremoveAllListenersremoveListenersetMaxListenerstoJSONaddAbortListenergetEventListenersgetMaxListenerslistenerCountononcesetMaxListeners
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor__dirnameapplicationapplicationCommandHandlerapplicationCommandsautocompleteHandlerbuttonHandlerbuttonschannelsconfigdropdownHandlerdropdownseventsguildshasteStorelocaleCachemodalSubmitHandlermodalsoptionsreadyTimestamprestshardsudosweeperstextCommandHandlertextCommandstokenuseruserChannelCacheusersusersUsingBotvoicewscaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor_censoredTokenemojisreadyAtuptime[asyncDispose][captureRejectionSymbol]addListenerdeleteWebhookdestroyemiteventNamesfetchGuildPreviewfetchGuildTemplatefetchGuildWidgetfetchInvitefetchPremiumStickerPacksfetchStickerfetchStickerPacksfetchVoiceRegionsfetchWebhookgenerateInvitegetMaxListenershasteFlushhasteLogisReadylistenerCountlistenersloadEventslogloginoffononceprependListenerprependOnceListenerrawListenersreloadEventsremoveAllListenersremoveListenersetMaxListenerstoJSONaddAbortListenergetEventListenersgetMaxListenerslistenerCountononcesetMaxListeners
\ No newline at end of file diff --git a/classes/_buape_lib.Button.html b/classes/_buape_lib.Button.html index 8ccff73f..f65ac956 100644 --- a/classes/_buape_lib.Button.html +++ b/classes/_buape_lib.Button.html @@ -1,5 +1,5 @@ Button | Buape Utilities - v0.0.0

Class Button

The base component class that other components extend from.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

authorOnly client cooldown @@ -9,12 +9,12 @@

Methods

run specificValidate validate -

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

-

Readonly client

client: BetterClient

The client that instantiated this component.

-

Readonly cooldown

cooldown: number

The cooldown of this component. +

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

+

Readonly client

client: BetterClient

The client that instantiated this component.

+

Readonly cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

-

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

-

Readonly key

key: string

The key of this component. +

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

+

Readonly key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

-

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

-

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndmPermissionkeypermissionsrunspecificValidatevalidate
\ No newline at end of file +

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

+

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndmPermissionkeypermissionsrunspecificValidatevalidate
\ No newline at end of file diff --git a/classes/_buape_lib.ButtonHandler.html b/classes/_buape_lib.ButtonHandler.html index 9ff09826..b0ee81e3 100644 --- a/classes/_buape_lib.ButtonHandler.html +++ b/classes/_buape_lib.ButtonHandler.html @@ -1,4 +1,4 @@ -ButtonHandler | Buape Utilities - v0.0.0

Class ButtonHandler

Hierarchy (view full)

Constructors

constructor +ButtonHandler | Buape Utilities - v0.0.0

Class ButtonHandler

Hierarchy (view full)

Constructors

constructor

Properties

client

Methods

fetchComponent handleComponent @@ -6,4 +6,4 @@ postLoad reloadFiles specificChecks -

Constructors

constructor

Properties

client

client: BetterClient

Methods

fetchComponent

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientfetchComponenthandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file +

Constructors

constructor

Properties

client

client: BetterClient

Methods

fetchComponent

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientfetchComponenthandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file diff --git a/classes/_buape_lib.Dropdown.html b/classes/_buape_lib.Dropdown.html index faf525e7..9eab7936 100644 --- a/classes/_buape_lib.Dropdown.html +++ b/classes/_buape_lib.Dropdown.html @@ -1,5 +1,5 @@ Dropdown | Buape Utilities - v0.0.0

Class Dropdown

The base component class that other components extend from.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

authorOnly client cooldown @@ -9,12 +9,12 @@

Methods

run specificValidate validate -

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

-

Readonly client

client: BetterClient

The client that instantiated this component.

-

Readonly cooldown

cooldown: number

The cooldown of this component. +

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

+

Readonly client

client: BetterClient

The client that instantiated this component.

+

Readonly cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

-

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

-

Readonly key

key: string

The key of this component. +

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

+

Readonly key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

-

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

-

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndmPermissionkeypermissionsrunspecificValidatevalidate
\ No newline at end of file +

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

+

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientcooldowndmPermissionkeypermissionsrunspecificValidatevalidate
\ No newline at end of file diff --git a/classes/_buape_lib.DropdownHandler.html b/classes/_buape_lib.DropdownHandler.html index 91a6fdaf..e51396b1 100644 --- a/classes/_buape_lib.DropdownHandler.html +++ b/classes/_buape_lib.DropdownHandler.html @@ -1,4 +1,4 @@ -DropdownHandler | Buape Utilities - v0.0.0

Class DropdownHandler

Hierarchy (view full)

Constructors

constructor +DropdownHandler | Buape Utilities - v0.0.0

Class DropdownHandler

Hierarchy (view full)

Constructors

constructor

Properties

client

Methods

fetchComponent handleComponent @@ -6,4 +6,4 @@ postLoad reloadFiles specificChecks -

Constructors

constructor

Properties

client

client: BetterClient

Methods

fetchComponent

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientfetchComponenthandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file +

Constructors

constructor

Properties

client

client: BetterClient

Methods

fetchComponent

handleComponent

loadFiles

postLoad

reloadFiles

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclientfetchComponenthandleComponentloadFilespostLoadreloadFilesspecificChecks
\ No newline at end of file diff --git a/classes/_buape_lib.EventHandler.html b/classes/_buape_lib.EventHandler.html index 5e3be92c..babf1465 100644 --- a/classes/_buape_lib.EventHandler.html +++ b/classes/_buape_lib.EventHandler.html @@ -1,4 +1,4 @@ -EventHandler | Buape Utilities - v0.0.0

Class EventHandler

Constructors

constructor +EventHandler | Buape Utilities - v0.0.0

Class EventHandler

Constructors

constructor

Properties

_listener client emitter? @@ -11,12 +11,12 @@

Constructors

constructor

Properties

Private Readonly _listener

_listener: ((...args) => Promise<any>)

Type declaration

    • (...args): Promise<any>

    • Execute our event.

      +

Returns EventHandler

Properties

Private Readonly _listener

_listener: ((...args) => Promise<any>)

Type declaration

    • (...args): Promise<any>

    • Execute our event.

      Parameters

      • Rest ...args: any

        The arguments for our event.

        -

      Returns Promise<any>

Readonly client

client: BetterClient

Private Optional Readonly emitter

emitter?: EventEmitterLike

Readonly name

name: string

Private Readonly once

once: boolean

Methods

Private _run

  • _run(...args): Promise<any>

  • Execute our event.

    +

Returns Promise<any>

Readonly client

client: BetterClient

Private Optional Readonly emitter

emitter?: EventEmitterLike

Readonly name

name: string

Private Readonly once

once: boolean

Methods

Private _run

listen

removeListener

run

  • run(..._args): Promise<any>

  • Execute our event.

    +

Returns Promise<any>

listen

removeListener

run

Settings

Member Visibility

Theme

On This Page

constructor_listenerclientemitternameonce_runlistenremoveListenerrun
\ No newline at end of file +

Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructor_listenerclientemitternameonce_runlistenremoveListenerrun
\ No newline at end of file diff --git a/classes/_buape_lib.ModalSubmit.html b/classes/_buape_lib.ModalSubmit.html index a14b5a32..52a43aa8 100644 --- a/classes/_buape_lib.ModalSubmit.html +++ b/classes/_buape_lib.ModalSubmit.html @@ -1,12 +1,12 @@ -ModalSubmit | Buape Utilities - v0.0.0

Class ModalSubmit

Constructors

constructor +ModalSubmit | Buape Utilities - v0.0.0

Class ModalSubmit

Constructors

constructor

Properties

client name

Methods

run

Constructors

constructor

Properties

Readonly client

client: BetterClient

Our client.

-

Readonly name

name: string

The beginning of the customId this modal listens for.

-

Methods

run

  • run(_interaction): Promise<any>

  • Run this modal.

    +

Returns ModalSubmit

Properties

Readonly client

client: BetterClient

Our client.

+

Readonly name

name: string

The beginning of the customId this modal listens for.

+

Methods

run

  • run(_interaction): Promise<any>

  • Run this modal.

    Parameters

    • _interaction: ModalSubmitInteraction<CacheType>

      The interaction that was created.

      -

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorclientnamerun
\ No newline at end of file +

Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorclientnamerun
\ No newline at end of file diff --git a/classes/_buape_lib.ModalSubmitHandler.html b/classes/_buape_lib.ModalSubmitHandler.html index 29cae70a..9902f468 100644 --- a/classes/_buape_lib.ModalSubmitHandler.html +++ b/classes/_buape_lib.ModalSubmitHandler.html @@ -1,4 +1,4 @@ -ModalSubmitHandler | Buape Utilities - v0.0.0

Class ModalSubmitHandler

Constructors

constructor +ModalSubmitHandler | Buape Utilities - v0.0.0

Class ModalSubmitHandler

Constructors

constructor

Properties

client

Methods

fetchModal handleModal @@ -7,14 +7,14 @@ runModal

Constructors

constructor

Properties

Private Readonly client

client: BetterClient

Our client.

-

Methods

Private fetchModal

  • fetchModal(customId): undefined | ModalSubmit

  • Fetch the modal that starts with the provided customId.

    +

Returns ModalSubmitHandler

Properties

Private Readonly client

client: BetterClient

Our client.

+

Methods

Private fetchModal

handleModal

handleModal

  • handleModal(interaction): Promise<void | InteractionResponse<boolean>>

  • Handle the interaction created for this modal to make sure the user and client can execute it.

    Parameters

    • interaction: ModalSubmitInteraction<CacheType>

      The interaction created.

      -

    Returns Promise<void | InteractionResponse<boolean>>

loadModals

reloadButtBuilders

Private runModal

  • runModal(modal, interaction): Promise<void>

  • Execute our modal.

    +

Returns Promise<void | InteractionResponse<boolean>>

loadModals

reloadButtBuilders

Private runModal

Settings

Member Visibility

Theme

On This Page

constructorclientfetchModalhandleModalloadModalsreloadButtBuildersrunModal
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorclientfetchModalhandleModalloadModalsreloadButtBuildersrunModal
\ No newline at end of file diff --git a/classes/_buape_lib.Paginator.html b/classes/_buape_lib.Paginator.html index d4af9d9f..d5d9a264 100644 --- a/classes/_buape_lib.Paginator.html +++ b/classes/_buape_lib.Paginator.html @@ -1,7 +1,7 @@ Paginator | Buape Utilities - v0.0.0

Class Paginator

A paginator for Discord messages.

Example

const pages: PaginatorMessage[] = [
    {
        embeds: [
            // embed
        ],
        components: [
            // components
        ],
        ephemeral: true
    }]
const paginator = new Paginator({
    id: interaction.id,
    userId: interaction.user.id,
    client: client
}, pages)
paginator.send(interaction)
-

Hierarchy

  • EventEmitter
    • Paginator

Constructors

constructor +

Hierarchy

  • EventEmitter
    • Paginator

Constructors

constructor

Properties

id pages settings @@ -39,42 +39,42 @@ on once setMaxListeners -

Constructors

constructor

Properties

id

id: string

pages

pages: PaginatorMessage[]

settings

settings: PaginatorSettings

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' +

Constructors

constructor

Properties

id

id: string

pages

pages: PaginatorMessage[]

settings

settings: PaginatorSettings

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

+

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Methods

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).

    +

Methods

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

    -

addPages

Private awaitIt

  • awaitIt(message): Promise<undefined | null | Message<boolean>>

  • Parameters

    • message: Message<boolean> | InteractionResponse<boolean>

    Returns Promise<undefined | null | Message<boolean>>

emit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments +

addPages

Private awaitIt

  • awaitIt(message): Promise<undefined | null | Message<boolean>>

  • Parameters

    • message: Message<boolean> | InteractionResponse<boolean>

    Returns Promise<undefined | null | Message<boolean>>

emit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • Rest ...args: AnyRest

    Returns boolean

    Since

    v0.1.26

    -

eventNames

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

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

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.

    const EventEmitter = require('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) ]

    Returns (string | symbol)[]

    Since

    v6.0.0

    -

Private generateDiscordComponents

  • generateDiscordComponents(thisPage?): ActionRowBuilder<MessageActionRowComponentBuilder>[]

  • Parameters

    • thisPage: number = 1

    Returns ActionRowBuilder<MessageActionRowComponentBuilder>[]

Private getDiscordMessage

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either +

Private generateDiscordComponents

  • generateDiscordComponents(thisPage?): ActionRowBuilder<MessageActionRowComponentBuilder>[]

  • Parameters

    • thisPage: number = 1

    Returns ActionRowBuilder<MessageActionRowComponentBuilder>[]

Private getDiscordMessage

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

    -

Private getPrevNext

  • getPrevNext(page): {
        next: number;
        previous: number;
    }

  • Parameters

    • page: number

    Returns {
        next: number;
        previous: number;
    }

    • next: number
    • previous: number

Private handleDiscordInteraction

listenerCount

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

  • Returns the number of listeners listening to the event named eventName.

    +

Private getPrevNext

  • getPrevNext(page): {
        next: number;
        previous: number;
    }

  • Parameters

    • page: number

    Returns {
        next: number;
        previous: number;
    }

    • next: number
    • previous: number

Private handleDiscordInteraction

listenerCount

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

  • Returns the number of listeners listening to 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

    • Optional listener: Function

      The event handler function

    Returns number

    Since

    v3.2.0

    -

listeners

  • listeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

listeners

  • listeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    server.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

    -

off

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

  • Alias for emitter.removeListener().

    +

off

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

  • Alias for emitter.removeListener().

    Type Parameters

    • K

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v10.0.0

    -

on

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

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

on

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

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -88,7 +88,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.101

    -

once

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

  • Adds a one-timelistener function for the event named eventName. The +

once

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

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    @@ -100,7 +100,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.3.0

    -

prependListener

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

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

prependListener

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

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    @@ -110,7 +110,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v6.0.0

    -

prependOnceListener

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

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

prependOnceListener

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

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    @@ -118,18 +118,18 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v6.0.0

    -

rawListeners

  • rawListeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName, +

rawListeners

  • rawListeners<K>(eventName): Function[]

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v9.4.0

    -

removeAllListeners

  • removeAllListeners(event?): this

  • Removes all listeners, or those of the specified eventName.

    +

removeAllListeners

  • removeAllListeners(event?): this

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • Optional event: string | symbol

    Returns this

    Since

    v0.1.26

    -

removeListener

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

  • Removes the specified listener from the listener array for the event namedeventName.

    +

removeListener

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

  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the @@ -153,13 +153,13 @@

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • K

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

    -

send

  • send(interaction, page?, edit?): Promise<undefined | null | Message<boolean>>

  • Parameters

    • interaction: ButtonInteraction<CacheType> | ChatInputCommandInteraction<CacheType>
    • page: number = 1
    • edit: undefined | Message<boolean> = undefined

    Returns Promise<undefined | null | Message<boolean>>

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are +

send

  • send(interaction, page?, edit?): Promise<undefined | null | Message<boolean>>

  • Parameters

    • interaction: ButtonInteraction<CacheType> | ChatInputCommandInteraction<CacheType>
    • page: number = 1
    • edit: undefined | Message<boolean> = undefined

    Returns Promise<undefined | null | Message<boolean>>

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

    -

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    +

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -173,7 +173,7 @@

    Parameters

    • signal: AbortSignal
    • resource: ((event) => void)
        • (event): void

        • Parameters

          • event: Event

          Returns void

    Returns Disposable

    Disposable that removes the abort listener.

    Since

    v18.18.0

    -

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    +

Static getEventListeners

  • getEventListeners(emitter, name): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the @@ -181,7 +181,7 @@ 

    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }

    Parameters

    • emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget
    • name: string | symbol

    Returns Function[]

    Since

    v15.2.0, v14.17.0

    -

Static getMaxListeners

  • getMaxListeners(emitter): number

  • Returns the currently set max amount of listeners.

    +

Static getMaxListeners

  • getMaxListeners(emitter): number

  • Returns the currently set max amount of listeners.

    For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

    For EventTargets this is the only way to get the max event listeners for the @@ -190,14 +190,14 @@ 

    import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

    {
      const ee = new EventEmitter();
      console.log(getMaxListeners(ee)); // 10
      setMaxListeners(11, ee);
      console.log(getMaxListeners(ee)); // 11
    }
    {
      const et = new EventTarget();
      console.log(getMaxListeners(et)); // 10
      setMaxListeners(11, et);
      console.log(getMaxListeners(et)); // 11
    }

    Parameters

    • emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget

    Returns number

    Since

    v18.17.0

    -

Static listenerCount

  • listenerCount(emitter, eventName): number

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +

Static listenerCount

  • listenerCount(emitter, eventName): number

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2

    Parameters

    • emitter: EventEmitter<DefaultEventMap>

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

Static on

  • on(emitter, eventName, options?): AsyncIterableIterator<any>
  • const { on, EventEmitter } = require('events');

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();
+

Static on

  • on(emitter, eventName, options?): AsyncIterableIterator<any>
  • const { on, EventEmitter } = require('events');

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when @@ -209,7 +209,7 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter<DefaultEventMap>
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    Since

    v13.6.0, v12.16.0

    -
  • on<Emitter, Events>(eventEmitter, eventName): AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

  • Type Parameters

    • Emitter extends __module
    • Events extends keyof ClientEvents

    Parameters

    Returns AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

Static once

  • once(emitter, eventName, options?): Promise<any[]>

  • Creates a Promise that is fulfilled when the EventEmitter emits the given +

  • on<Emitter, Events>(eventEmitter, eventName): AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

  • Type Parameters

    • Emitter extends __module
    • Events extends keyof ClientEvents

    Parameters

    Returns AsyncIterableIterator<Emitter extends Client<boolean>
        ? ClientEvents[Events]
        : any>

Static once

  • once(emitter, eventName, options?): Promise<any[]>

  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

    @@ -226,8 +226,8 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

    Since

    v11.13.0, v10.16.0

    -
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • once<Emitter, Event>(eventEmitter, eventName): Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

  • Type Parameters

    • Emitter extends __module
    • Event extends keyof ClientEvents

    Parameters

    Returns Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

Static setMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • const {
      setMaxListeners,
      EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • once<Emitter, Event>(eventEmitter, eventName): Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

  • Type Parameters

    • Emitter extends __module
    • Event extends keyof ClientEvents

    Parameters

    Returns Promise<Emitter extends Client<boolean>
        ? ClientEvents[Event]
        : any[]>

Static setMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • const {
      setMaxListeners,
      EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);

    Parameters

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest ...eventTargets: (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]

    Returns void

    Since

    v15.4.0

    -

Settings

Member Visibility

Theme

On This Page

constructoridpagessettingscaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor[captureRejectionSymbol]addListeneraddPagesawaitItemiteventNamesgenerateDiscordComponentsgetDiscordMessagegetMaxListenersgetPrevNexthandleDiscordInteractionlistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersendsetMaxListenersaddAbortListenergetEventListenersgetMaxListenerslistenerCountononcesetMaxListeners
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoridpagessettingscaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor[captureRejectionSymbol]addListeneraddPagesawaitItemiteventNamesgenerateDiscordComponentsgetDiscordMessagegetMaxListenersgetPrevNexthandleDiscordInteractionlistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersendsetMaxListenersaddAbortListenergetEventListenersgetMaxListenerslistenerCountononcesetMaxListeners
\ No newline at end of file diff --git a/classes/_buape_lib.TextCommand.html b/classes/_buape_lib.TextCommand.html index 6d19a31c..e57b91e3 100644 --- a/classes/_buape_lib.TextCommand.html +++ b/classes/_buape_lib.TextCommand.html @@ -1,7 +1,7 @@ -TextCommand | Buape Utilities - v0.0.0

Class TextCommand

Constructors

constructor +TextCommand | Buape Utilities - v0.0.0

Class TextCommand

Constructors

constructor

Properties

client key restriction?

Methods

run validate -

Constructors

constructor

Properties

Readonly client

client: BetterClient

Readonly key

key: string

Optional Readonly restriction

restriction?: string

Methods

run

validate

Settings

Member Visibility

Theme

On This Page

constructorclientkeyrestrictionrunvalidate
\ No newline at end of file +

Constructors

constructor

Properties

Readonly client

client: BetterClient

Readonly key

key: string

Optional Readonly restriction

restriction?: string

Methods

run

validate

Settings

Member Visibility

Theme

On This Page

constructorclientkeyrestrictionrunvalidate
\ No newline at end of file diff --git a/classes/_buape_lib.TextCommandHandler.html b/classes/_buape_lib.TextCommandHandler.html index c03c01ce..29e7aa59 100644 --- a/classes/_buape_lib.TextCommandHandler.html +++ b/classes/_buape_lib.TextCommandHandler.html @@ -1,4 +1,4 @@ -TextCommandHandler | Buape Utilities - v0.0.0

Class TextCommandHandler

Constructors

constructor +TextCommandHandler | Buape Utilities - v0.0.0

Class TextCommandHandler

Constructors

constructor

Properties

client customPrefix?

Methods

fetchCommand @@ -6,4 +6,4 @@ loadFiles reloadFiles runCommand -

Constructors

constructor

Properties

client

client: BetterClient

Private Optional customPrefix

customPrefix?: string

Methods

fetchCommand

handle

loadFiles

reloadFiles

Private runCommand

Settings

Member Visibility

Theme

On This Page

constructorclientcustomPrefixfetchCommandhandleloadFilesreloadFilesrunCommand
\ No newline at end of file +

Constructors

constructor

Properties

client

client: BetterClient

Private Optional customPrefix

customPrefix?: string

Methods

fetchCommand

handle

loadFiles

reloadFiles

Private runCommand

Settings

Member Visibility

Theme

On This Page

constructorclientcustomPrefixfetchCommandhandleloadFilesreloadFilesrunCommand
\ No newline at end of file diff --git a/classes/_buape_lib.Type.html b/classes/_buape_lib.Type.html index fdafee49..ecb53a0e 100644 --- a/classes/_buape_lib.Type.html +++ b/classes/_buape_lib.Type.html @@ -1,5 +1,5 @@ Type | Buape Utilities - v0.0.0

Class Type

The class for deep checking Types

-

Constructors

constructor +

Constructors

constructor

Properties

childKeys childValues is @@ -16,18 +16,18 @@ resolve

Constructors

constructor

Properties

Private childKeys

childKeys: Map<string, Type>

The child keys of this Type

-

Private childValues

childValues: Map<string, Type>

The child values of this Type

-

is

is: string

The shallow type of this

-

Private Optional parent

parent?: Type

The parent of this type

-

value

value: any

The value to generate a deep Type of

-

Accessors

childTypes

Methods

Private addEntry

  • addEntry(__namedParameters): void

  • The subtype to create based on this.value's entries.

    -

    Parameters

    • __namedParameters: [string, any]

    Returns void

addValue

check

isCircular

Private parents

toString

Static list

Static resolve

Settings

Member Visibility

Theme

On This Page

constructorchildKeyschildValuesisparentvaluechildTypesaddEntryaddValuecheckisCircularparentstoStringlistresolve
\ No newline at end of file +

Returns Type

Properties

Private childKeys

childKeys: Map<string, Type>

The child keys of this Type

+

Private childValues

childValues: Map<string, Type>

The child values of this Type

+

is

is: string

The shallow type of this

+

Private Optional parent

parent?: Type

The parent of this type

+

value

value: any

The value to generate a deep Type of

+

Accessors

childTypes

Methods

Private addEntry

  • addEntry(__namedParameters): void

  • The subtype to create based on this.value's entries.

    +

    Parameters

    • __namedParameters: [string, any]

    Returns void

addValue

check

isCircular

Private parents

toString

Static list

Static resolve

Settings

Member Visibility

Theme

On This Page

constructorchildKeyschildValuesisparentvaluechildTypesaddEntryaddValuecheckisCircularparentstoStringlistresolve
\ No newline at end of file diff --git a/classes/_buape_lib._BaseComponent.html b/classes/_buape_lib._BaseComponent.html index cf54fbcb..5843e47e 100644 --- a/classes/_buape_lib._BaseComponent.html +++ b/classes/_buape_lib._BaseComponent.html @@ -1,5 +1,5 @@ _BaseComponent | Buape Utilities - v0.0.0

Class _BaseComponent

The base component class that other components extend from.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

authorOnly client clientPermissions? @@ -13,16 +13,16 @@

Methods

run specificValidate validate -

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

-

Readonly client

client: BetterClient

The client that instantiated this component.

-

Private Optional Readonly clientPermissions

clientPermissions?: PermissionsBitField

The permissions required from the application to run this component.

-

Readonly cooldown

cooldown: number

The cooldown of this component. +

Constructors

constructor

Properties

Readonly authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

+

Readonly client

client: BetterClient

The client that instantiated this component.

+

Private Optional Readonly clientPermissions

clientPermissions?: PermissionsBitField

The permissions required from the application to run this component.

+

Readonly cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

-

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

-

Private Readonly guildOnly

guildOnly: boolean

Whether this component can only be used in guilds.

-

Readonly key

key: string

The key of this component. +

Optional Readonly dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

+

Private Readonly guildOnly

guildOnly: boolean

Whether this component can only be used in guilds.

+

Readonly key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

-

Private Readonly ownerOnly

ownerOnly: boolean

Whether this component can only be used by the owner of the guild.

-

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

-

Private Optional Readonly restriction

restriction?: string

The access role required to run this component.

-

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientclientPermissionscooldowndmPermissionguildOnlykeyownerOnlypermissionsrestrictionrunspecificValidatevalidate
\ No newline at end of file +

Private Readonly ownerOnly

ownerOnly: boolean

Whether this component can only be used by the owner of the guild.

+

Optional Readonly permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

+

Private Optional Readonly restriction

restriction?: string

The access role required to run this component.

+

Methods

run

specificValidate

validate

Settings

Member Visibility

Theme

On This Page

constructorauthorOnlyclientclientPermissionscooldowndmPermissionguildOnlykeyownerOnlypermissionsrestrictionrunspecificValidatevalidate
\ No newline at end of file diff --git a/classes/_buape_lib._BaseHandler.html b/classes/_buape_lib._BaseHandler.html index 45b56420..07ba26c9 100644 --- a/classes/_buape_lib._BaseHandler.html +++ b/classes/_buape_lib._BaseHandler.html @@ -1,4 +1,4 @@ -_BaseHandler | Buape Utilities - v0.0.0

Class _BaseHandler

Hierarchy (view full)

Constructors

constructor +_BaseHandler | Buape Utilities - v0.0.0

Class _BaseHandler

Hierarchy (view full)

Constructors

constructor

Properties

client type

Methods

fetchComponent @@ -8,4 +8,4 @@ reloadFiles runComponent specificChecks -

Constructors

constructor

Properties

client

client: BetterClient

Private type

type: HandlerType

Methods

fetchComponent

handleComponent

  • handleComponent(interaction): Promise<void | InteractionResponse<boolean>>

  • Parameters

    • interaction: ButtonInteraction<CacheType> | CommandInteraction<CacheType> | AnySelectMenuInteraction

    Returns Promise<void | InteractionResponse<boolean>>

loadFiles

postLoad

reloadFiles

Private runComponent

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclienttypefetchComponenthandleComponentloadFilespostLoadreloadFilesrunComponentspecificChecks
\ No newline at end of file +

Constructors

constructor

Properties

client

client: BetterClient

Private type

type: HandlerType

Methods

fetchComponent

handleComponent

  • handleComponent(interaction): Promise<void | InteractionResponse<boolean>>

  • Parameters

    • interaction: ButtonInteraction<CacheType> | CommandInteraction<CacheType> | AnySelectMenuInteraction

    Returns Promise<void | InteractionResponse<boolean>>

loadFiles

postLoad

reloadFiles

Private runComponent

specificChecks

Settings

Member Visibility

Theme

On This Page

constructorclienttypefetchComponenthandleComponentloadFilespostLoadreloadFilesrunComponentspecificChecks
\ No newline at end of file diff --git a/classes/kiai_js.APIError.html b/classes/kiai_js.APIError.html index dc760ad0..b7b02c91 100644 --- a/classes/kiai_js.APIError.html +++ b/classes/kiai_js.APIError.html @@ -1,4 +1,4 @@ -APIError | Buape Utilities - v0.0.0

Class APIError

Hierarchy

  • Error
    • APIError

Constructors

constructor +APIError | Buape Utilities - v0.0.0

Class APIError

Hierarchy

  • Error
    • APIError

Constructors

constructor

Properties

message name stack? @@ -6,10 +6,10 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

message

message: string

The message of this error

-

name

name: string

The type of error (APIError)

-

Optional stack

stack?: string

status

status: number

HTTP status of the error

-

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

message

message: string

The message of this error

+

name

name: string

The type of error (APIError)

+

Optional stack

stack?: string

status

status: number

HTTP status of the error

+

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructormessagenamestackstatusprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file +

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructormessagenamestackstatusprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/kiai_js.KiaiClient.html b/classes/kiai_js.KiaiClient.html index 305fb2c8..173aa9ba 100644 --- a/classes/kiai_js.KiaiClient.html +++ b/classes/kiai_js.KiaiClient.html @@ -1,4 +1,4 @@ -KiaiClient | Buape Utilities - v0.0.0

Class KiaiClient

Constructors

constructor +KiaiClient | Buape Utilities - v0.0.0

Class KiaiClient

Constructors

constructor

Properties

_requestHandler apiKey baseURL @@ -17,5 +17,5 @@
  • Optional options: {
        baseURL?: string;
        debug?: boolean;
        fetchFunction: ((url, init?) => Promise<Response>);
        version?: `v${number}`;
    }

    The options to use

    • Optional baseURL?: string

      The base URL to use

    • Optional debug?: boolean

      Whether to enable debug mode

      -
    • fetchFunction: ((url, init?) => Promise<Response>)
        • (url, init?): Promise<Response>

        • Parameters

          • url: string | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    • Optional version?: `v${number}`

    • Returns KiaiClient

    Properties

    _requestHandler

    _requestHandler: RequestHandler

    apiKey

    apiKey: string

    baseURL

    baseURL: string

    blacklist

    blacklist: Blacklist

    Deprecated

    use denylist

    -

    debug

    debug: boolean

    denylist

    denylist: Denylist

    leveling

    leveling: Leveling

    multipliers

    multipliers: Multipliers

    rewards

    rewards: Rewards

    settings

    settings: Settings

    version

    version: `v${string}`

    Methods

    createVirtualMessage

    getRatelimit

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_requestHandlerapiKeybaseURLblacklistdebugdenylistlevelingmultipliersrewardssettingsversioncreateVirtualMessagegetRatelimit
    \ No newline at end of file +
  • fetchFunction: ((url, init?) => Promise<Response>)
      • (url, init?): Promise<Response>

      • Parameters

        • url: string | URL
        • Optional init: RequestInit

        Returns Promise<Response>

  • Optional version?: `v${number}`

    • Returns KiaiClient

    Properties

    _requestHandler

    _requestHandler: RequestHandler

    apiKey

    apiKey: string

    baseURL

    baseURL: string

    blacklist

    blacklist: Blacklist

    Deprecated

    use denylist

    +

    debug

    debug: boolean

    denylist

    denylist: Denylist

    leveling

    leveling: Leveling

    multipliers

    multipliers: Multipliers

    rewards

    rewards: Rewards

    settings

    settings: Settings

    version

    version: `v${string}`

    Methods

    createVirtualMessage

    getRatelimit

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_requestHandlerapiKeybaseURLblacklistdebugdenylistlevelingmultipliersrewardssettingsversioncreateVirtualMessagegetRatelimit
    \ No newline at end of file diff --git a/classes/kiai_js.RatelimitError.html b/classes/kiai_js.RatelimitError.html index be907e94..494d80ca 100644 --- a/classes/kiai_js.RatelimitError.html +++ b/classes/kiai_js.RatelimitError.html @@ -1,4 +1,4 @@ -RatelimitError | Buape Utilities - v0.0.0

    Class RatelimitError

    Hierarchy

    • Error
      • RatelimitError

    Constructors

    constructor +RatelimitError | Buape Utilities - v0.0.0

    Class RatelimitError

    Hierarchy

    • Error
      • RatelimitError

    Constructors

    constructor

    Properties

    message name remaining @@ -7,11 +7,11 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    The message of this error

    -

    name

    name: string

    The type of error (RatelimitError)

    -

    remaining

    remaining: number

    The time remaining for your ratelimit to expire in milliseconds

    -

    Optional stack

    stack?: string

    status

    status: number

    HTTP status of the error

    -

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    The message of this error

    +

    name

    name: string

    The type of error (RatelimitError)

    +

    remaining

    remaining: number

    The time remaining for your ratelimit to expire in milliseconds

    +

    Optional stack

    stack?: string

    status

    status: number

    HTTP status of the error

    +

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructormessagenameremainingstackstatusprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file +

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructormessagenameremainingstackstatusprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/enums/_buape_lib.HandlerType.html b/enums/_buape_lib.HandlerType.html index bc37213d..35cd69cd 100644 --- a/enums/_buape_lib.HandlerType.html +++ b/enums/_buape_lib.HandlerType.html @@ -1,5 +1,5 @@ -HandlerType | Buape Utilities - v0.0.0

    Enumeration HandlerType

    Enumeration Members

    ApplicationCommand +HandlerType | Buape Utilities - v0.0.0

    Enumeration HandlerType

    Enumeration Members

    ApplicationCommand Button Dropdown TextCommand -

    Enumeration Members

    ApplicationCommand

    ApplicationCommand: "applicationCommands"

    Button

    Button: "buttons"

    Dropdown

    Dropdown: "dropdowns"

    TextCommand

    TextCommand: "textCommands"

    Settings

    Member Visibility

    Theme

    On This Page

    ApplicationCommandButtonDropdownTextCommand
    \ No newline at end of file +

    Enumeration Members

    ApplicationCommand

    ApplicationCommand: "applicationCommands"

    Button

    Button: "buttons"

    Dropdown

    Dropdown: "dropdowns"

    TextCommand

    TextCommand: "textCommands"

    Settings

    Member Visibility

    Theme

    On This Page

    ApplicationCommandButtonDropdownTextCommand
    \ No newline at end of file diff --git a/enums/_buape_lib.LogLevel.html b/enums/_buape_lib.LogLevel.html index f0b82931..a7360c6c 100644 --- a/enums/_buape_lib.LogLevel.html +++ b/enums/_buape_lib.LogLevel.html @@ -1,6 +1,6 @@ -LogLevel | Buape Utilities - v0.0.0

    Enumeration LogLevel

    Enumeration Members

    DEBUG +LogLevel | Buape Utilities - v0.0.0

    Enumeration LogLevel

    Enumeration Members

    DEBUG ERROR INFO NULL WARN -

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    NULL

    NULL: "null"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    Theme

    On This Page

    DEBUGERRORINFONULLWARN
    \ No newline at end of file +

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    NULL

    NULL: "null"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    Theme

    On This Page

    DEBUGERRORINFONULLWARN
    \ No newline at end of file diff --git a/functions/_buape_functions.checkAccess.html b/functions/_buape_functions.checkAccess.html index 358838ed..08f0ec2d 100644 --- a/functions/_buape_functions.checkAccess.html +++ b/functions/_buape_functions.checkAccess.html @@ -5,4 +5,4 @@
  • restriction: string | string[]

    The restriction type to check access for.

  • settings: AccessSettings

    The settings to use for access checking.

  • client: Client<boolean>

    The discord.js Client.

    -

    • Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.emojiList.html b/functions/_buape_functions.emojiList.html index aecaada4..799a4561 100644 --- a/functions/_buape_functions.emojiList.html +++ b/functions/_buape_functions.emojiList.html @@ -2,4 +2,4 @@

    Parameters

    • items: string[]

      An array of strings to format

    • useEmojiForFirstLine: boolean = false

      Whether the first line should have an list starting emoji (true) or be left blank to use as the title (false)

    Returns string

    Note

    These emojis are from Buape's servers. They should work fine in interaction responses, but may not show for non-Buape bots in regular messages.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.generateEmbed.html b/functions/_buape_functions.generateEmbed.html index 694e5d34..1c580df3 100644 --- a/functions/_buape_functions.generateEmbed.html +++ b/functions/_buape_functions.generateEmbed.html @@ -5,4 +5,4 @@
  • ephemeral: boolean = false

    Whether our message should be ephemeral or not.

  • supportServer: undefined | string = undefined

    Whether or not to add the support server link as a component (for error messages only).

    • Returns GeneratedMessage

    The generated message.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.generateTimestamp.html b/functions/_buape_functions.generateTimestamp.html index 7d4d76fe..cd509bd0 100644 --- a/functions/_buape_functions.generateTimestamp.html +++ b/functions/_buape_functions.generateTimestamp.html @@ -1,4 +1,4 @@ generateTimestamp | Buape Utilities - v0.0.0

    Function generateTimestamp

    • generateTimestamp(options?): string

    • Generate a unix timestamp for Discord to be rendered locally per user.

      Parameters

      Returns string

      The generated timestamp.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.getFiles.html b/functions/_buape_functions.getFiles.html index ee93da0e..9e05e721 100644 --- a/functions/_buape_functions.getFiles.html +++ b/functions/_buape_functions.getFiles.html @@ -3,4 +3,4 @@
  • fileExtension: string

    The extension to search for.

  • createDirIfNotFound: boolean = false

    Whether or not the parent directory should be created if it doesn't exist.

    • Returns string[]

    The files in the directory.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.parseUser.html b/functions/_buape_functions.parseUser.html index c86b4ffd..7f241252 100644 --- a/functions/_buape_functions.parseUser.html +++ b/functions/_buape_functions.parseUser.html @@ -3,4 +3,4 @@

    Parameters

    • userInput: string

      The string to parse the user from.

    • client: Client<boolean>

      The discord.js Client.

    Returns Promise<null | User>

    The parsed user.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.randomInt.html b/functions/_buape_functions.randomInt.html index c88a77e9..74166462 100644 --- a/functions/_buape_functions.randomInt.html +++ b/functions/_buape_functions.randomInt.html @@ -3,4 +3,4 @@

    Parameters

    • min: number

      The minimum number to generate

    • max: number

      The maximum number to generate

    Returns number

    The random integer

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.titleCase.html b/functions/_buape_functions.titleCase.html index a3925ab7..883035e5 100644 --- a/functions/_buape_functions.titleCase.html +++ b/functions/_buape_functions.titleCase.html @@ -3,4 +3,4 @@

    Returns string

    The formatted string

    Example

    titleCase("hello_world") // "Hello world"
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_buape_functions.uploadHaste.html b/functions/_buape_functions.uploadHaste.html index b1f18976..4a4505ce 100644 --- a/functions/_buape_functions.uploadHaste.html +++ b/functions/_buape_functions.uploadHaste.html @@ -4,4 +4,4 @@
  • type: string = "md"

    The file type to append to the end of the haste.

  • url: string = "https://hst.sh"

    A non-standard url to upload to

    • Returns Promise<null | string>

    The URL to the uploaded content.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_buape_dotperms.UserPermissionSet.html b/interfaces/_buape_dotperms.UserPermissionSet.html index 09a5107c..66eb0206 100644 --- a/interfaces/_buape_dotperms.UserPermissionSet.html +++ b/interfaces/_buape_dotperms.UserPermissionSet.html @@ -1 +1 @@ -UserPermissionSet | Buape Utilities - v0.0.0

    Interface UserPermissionSet

    interface UserPermissionSet {
        [prop: string]: true | UserPermissionSet | null;
    }

    Indexable

    [prop: string]: true | UserPermissionSet | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +UserPermissionSet | Buape Utilities - v0.0.0

    Interface UserPermissionSet

    interface UserPermissionSet {
        [prop: string]: true | UserPermissionSet | null;
    }

    Indexable

    [prop: string]: true | UserPermissionSet | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_buape_dotperms.UserPermissions.html b/interfaces/_buape_dotperms.UserPermissions.html index 0c37f3dc..07459fdd 100644 --- a/interfaces/_buape_dotperms.UserPermissions.html +++ b/interfaces/_buape_dotperms.UserPermissions.html @@ -1 +1 @@ -UserPermissions | Buape Utilities - v0.0.0

    Interface UserPermissions

    interface UserPermissions {
        [prop: string]: UserPermissionSet;
    }

    Indexable

    [prop: string]: UserPermissionSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +UserPermissions | Buape Utilities - v0.0.0

    Interface UserPermissions

    interface UserPermissions {
        [prop: string]: UserPermissionSet;
    }

    Indexable

    [prop: string]: UserPermissionSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_buape_experiments.experimentData.html b/interfaces/_buape_experiments.experimentData.html index 93426a50..4e7f5a6a 100644 --- a/interfaces/_buape_experiments.experimentData.html +++ b/interfaces/_buape_experiments.experimentData.html @@ -1,6 +1,6 @@ -experimentData | Buape Utilities - v0.0.0

    Interface experimentData

    interface experimentData {
        feature_key: string;
        force_disabled?: string[];
        force_enabled?: string[];
        name: string;
        rollout_percentage: number;
    }

    Properties

    feature_key +experimentData | Buape Utilities - v0.0.0

    Interface experimentData

    interface experimentData {
        feature_key: string;
        force_disabled?: string[];
        force_enabled?: string[];
        name: string;
        rollout_percentage: number;
    }

    Properties

    feature_key force_disabled? force_enabled? name rollout_percentage -

    Properties

    feature_key

    feature_key: string

    Optional force_disabled

    force_disabled?: string[]

    Optional force_enabled

    force_enabled?: string[]

    name

    name: string

    rollout_percentage

    rollout_percentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    feature_keyforce_disabledforce_enablednamerollout_percentage
    \ No newline at end of file +

    Properties

    feature_key

    feature_key: string

    Optional force_disabled

    force_disabled?: string[]

    Optional force_enabled

    force_enabled?: string[]

    name

    name: string

    rollout_percentage

    rollout_percentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    feature_keyforce_disabledforce_enablednamerollout_percentage
    \ No newline at end of file diff --git a/interfaces/_buape_functions.AccessRoles.html b/interfaces/_buape_functions.AccessRoles.html index 4e628f17..33916f0c 100644 --- a/interfaces/_buape_functions.AccessRoles.html +++ b/interfaces/_buape_functions.AccessRoles.html @@ -1,4 +1,4 @@ AccessRoles | Buape Utilities - v0.0.0

    Interface AccessRoles

    An object containing the roles for each restriction type

    Example

    {"staff": "393814075013750315", "admin": "135013865018708735"}
    -
    interface AccessRoles {
        [key: string]: Snowflake[];
    }

    Indexable

    [key: string]: Snowflake[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface AccessRoles {
        [key: string]: Snowflake[];
    }

    Indexable

    [key: string]: Snowflake[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_buape_functions.AccessSettings.html b/interfaces/_buape_functions.AccessSettings.html index 7aa35ad4..dc26f247 100644 --- a/interfaces/_buape_functions.AccessSettings.html +++ b/interfaces/_buape_functions.AccessSettings.html @@ -1,6 +1,6 @@ AccessSettings | Buape Utilities - v0.0.0

    Interface AccessSettings

    The settings to use for access checking.

    Example

    {"roles": {"staff": "393814075013750315", "admin": "135013865018708735"}, "server": "135013865018708735"}
    -
    interface AccessSettings {
        roles: AccessRoles;
        server: string;
    }

    Properties

    roles +
    interface AccessSettings {
        roles: AccessRoles;
        server: string;
    }

    Properties

    roles server -

    Properties

    roles

    roles: AccessRoles

    server

    server: string

    Settings

    Member Visibility

    Theme

    On This Page

    rolesserver
    \ No newline at end of file +

    Properties

    roles

    roles: AccessRoles

    server

    server: string

    Settings

    Member Visibility

    Theme

    On This Page

    rolesserver
    \ No newline at end of file diff --git a/interfaces/_buape_functions.GenerateTimestampOptions.html b/interfaces/_buape_functions.GenerateTimestampOptions.html index 82fc8a75..c0181d04 100644 --- a/interfaces/_buape_functions.GenerateTimestampOptions.html +++ b/interfaces/_buape_functions.GenerateTimestampOptions.html @@ -1,6 +1,6 @@ GenerateTimestampOptions | Buape Utilities - v0.0.0

    Interface GenerateTimestampOptions

    The options to use for the timestamp.

    Example

    {"timestamp": 1620000000000, "type": "f"}
    -
    interface GenerateTimestampOptions {
        timestamp?: number | Date;
        type?: TimestampStylesString;
    }

    Properties

    timestamp? +
    interface GenerateTimestampOptions {
        timestamp?: number | Date;
        type?: TimestampStylesString;
    }

    Properties

    timestamp? type? -

    Properties

    Optional timestamp

    timestamp?: number | Date

    Optional type

    type?: TimestampStylesString

    Settings

    Member Visibility

    Theme

    On This Page

    timestamptype
    \ No newline at end of file +

    Properties

    Optional timestamp

    timestamp?: number | Date

    Optional type

    type?: TimestampStylesString

    Settings

    Member Visibility

    Theme

    On This Page

    timestamptype
    \ No newline at end of file diff --git a/interfaces/_buape_functions.GeneratedMessage.html b/interfaces/_buape_functions.GeneratedMessage.html index d29fa751..135904bf 100644 --- a/interfaces/_buape_functions.GeneratedMessage.html +++ b/interfaces/_buape_functions.GeneratedMessage.html @@ -1,6 +1,6 @@ -GeneratedMessage | Buape Utilities - v0.0.0

    Interface GeneratedMessage

    interface GeneratedMessage {
        components?: ActionRowBuilder<ButtonBuilder>[];
        content?: string;
        embeds?: APIEmbed[];
        ephemeral?: boolean;
        fetchReply?: boolean;
    }

    Properties

    components? +GeneratedMessage | Buape Utilities - v0.0.0

    Interface GeneratedMessage

    interface GeneratedMessage {
        components?: ActionRowBuilder<ButtonBuilder>[];
        content?: string;
        embeds?: APIEmbed[];
        ephemeral?: boolean;
        fetchReply?: boolean;
    }

    Properties

    components? content? embeds? ephemeral? fetchReply? -

    Properties

    Optional components

    components?: ActionRowBuilder<ButtonBuilder>[]

    Optional content

    content?: string

    Optional embeds

    embeds?: APIEmbed[]

    Optional ephemeral

    ephemeral?: boolean

    Optional fetchReply

    fetchReply?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    componentscontentembedsephemeralfetchReply
    \ No newline at end of file +

    Properties

    Optional components

    components?: ActionRowBuilder<ButtonBuilder>[]

    Optional content

    content?: string

    Optional embeds

    embeds?: APIEmbed[]

    Optional ephemeral

    ephemeral?: boolean

    Optional fetchReply

    fetchReply?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    componentscontentembedsephemeralfetchReply
    \ No newline at end of file diff --git a/interfaces/_buape_lib.ApplicationCommandOptions.html b/interfaces/_buape_lib.ApplicationCommandOptions.html index ff1c0257..8ae6c59f 100644 --- a/interfaces/_buape_lib.ApplicationCommandOptions.html +++ b/interfaces/_buape_lib.ApplicationCommandOptions.html @@ -1,4 +1,4 @@ -ApplicationCommandOptions | Buape Utilities - v0.0.0

    Interface ApplicationCommandOptions

    interface ApplicationCommandOptions {
        authorOnly?: boolean;
        clientPermissions?: PermissionsBitField;
        cooldown?: number;
        description?: string;
        dmPermission?: boolean;
        guildOnly?: boolean;
        options?: ApplicationCommandOptionData[];
        ownerOnly?: boolean;
        permissions?: PermissionsBitField;
        restriction?: string;
        type?: ApplicationCommandType;
    }

    Hierarchy (view full)

    Properties

    authorOnly? +ApplicationCommandOptions | Buape Utilities - v0.0.0

    Interface ApplicationCommandOptions

    interface ApplicationCommandOptions {
        authorOnly?: boolean;
        clientPermissions?: PermissionsBitField;
        cooldown?: number;
        description?: string;
        dmPermission?: boolean;
        guildOnly?: boolean;
        options?: ApplicationCommandOptionData[];
        ownerOnly?: boolean;
        permissions?: PermissionsBitField;
        restriction?: string;
        type?: ApplicationCommandType;
    }

    Hierarchy (view full)

    Properties

    authorOnly? clientPermissions? cooldown? description? @@ -9,4 +9,4 @@ permissions? restriction? type? -

    Properties

    Optional authorOnly

    authorOnly?: boolean

    Optional clientPermissions

    clientPermissions?: PermissionsBitField

    Optional cooldown

    cooldown?: number

    Optional description

    description?: string

    Optional dmPermission

    dmPermission?: boolean

    Optional guildOnly

    guildOnly?: boolean

    Optional options

    options?: ApplicationCommandOptionData[]

    Optional ownerOnly

    ownerOnly?: boolean

    Optional permissions

    permissions?: PermissionsBitField

    Optional restriction

    restriction?: string

    Optional type

    type?: ApplicationCommandType

    Settings

    Member Visibility

    Theme

    On This Page

    authorOnlyclientPermissionscooldowndescriptiondmPermissionguildOnlyoptionsownerOnlypermissionsrestrictiontype
    \ No newline at end of file +

    Properties

    Optional authorOnly

    authorOnly?: boolean

    Optional clientPermissions

    clientPermissions?: PermissionsBitField

    Optional cooldown

    cooldown?: number

    Optional description

    description?: string

    Optional dmPermission

    dmPermission?: boolean

    Optional guildOnly

    guildOnly?: boolean

    Optional options

    options?: ApplicationCommandOptionData[]

    Optional ownerOnly

    ownerOnly?: boolean

    Optional permissions

    permissions?: PermissionsBitField

    Optional restriction

    restriction?: string

    Optional type

    type?: ApplicationCommandType

    Settings

    Member Visibility

    Theme

    On This Page

    authorOnlyclientPermissionscooldowndescriptiondmPermissionguildOnlyoptionsownerOnlypermissionsrestrictiontype
    \ No newline at end of file diff --git a/interfaces/_buape_lib.BaseComponentOptions.html b/interfaces/_buape_lib.BaseComponentOptions.html index 87f508ac..fb200854 100644 --- a/interfaces/_buape_lib.BaseComponentOptions.html +++ b/interfaces/_buape_lib.BaseComponentOptions.html @@ -1,4 +1,4 @@ -BaseComponentOptions | Buape Utilities - v0.0.0

    Interface BaseComponentOptions

    interface BaseComponentOptions {
        authorOnly?: boolean;
        clientPermissions?: PermissionsBitField;
        cooldown?: number;
        dmPermission?: boolean;
        guildOnly?: boolean;
        ownerOnly?: boolean;
        permissions?: PermissionsBitField;
        restriction?: string;
    }

    Hierarchy (view full)

    Properties

    authorOnly? +BaseComponentOptions | Buape Utilities - v0.0.0

    Interface BaseComponentOptions

    interface BaseComponentOptions {
        authorOnly?: boolean;
        clientPermissions?: PermissionsBitField;
        cooldown?: number;
        dmPermission?: boolean;
        guildOnly?: boolean;
        ownerOnly?: boolean;
        permissions?: PermissionsBitField;
        restriction?: string;
    }

    Hierarchy (view full)

    Properties

    authorOnly? clientPermissions? cooldown? dmPermission? @@ -6,4 +6,4 @@ ownerOnly? permissions? restriction? -

    Properties

    Optional authorOnly

    authorOnly?: boolean

    Optional clientPermissions

    clientPermissions?: PermissionsBitField

    Optional cooldown

    cooldown?: number

    Optional dmPermission

    dmPermission?: boolean

    Optional guildOnly

    guildOnly?: boolean

    Optional ownerOnly

    ownerOnly?: boolean

    Optional permissions

    permissions?: PermissionsBitField

    Optional restriction

    restriction?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorOnlyclientPermissionscooldowndmPermissionguildOnlyownerOnlypermissionsrestriction
    \ No newline at end of file +

    Properties

    Optional authorOnly

    authorOnly?: boolean

    Optional clientPermissions

    clientPermissions?: PermissionsBitField

    Optional cooldown

    cooldown?: number

    Optional dmPermission

    dmPermission?: boolean

    Optional guildOnly

    guildOnly?: boolean

    Optional ownerOnly

    ownerOnly?: boolean

    Optional permissions

    permissions?: PermissionsBitField

    Optional restriction

    restriction?: string

    Settings

    Member Visibility

    Theme

    On This Page

    authorOnlyclientPermissionscooldowndmPermissionguildOnlyownerOnlypermissionsrestriction
    \ No newline at end of file diff --git a/interfaces/_buape_lib.EventEmitterLike.html b/interfaces/_buape_lib.EventEmitterLike.html index 51ff7753..354e0cb1 100644 --- a/interfaces/_buape_lib.EventEmitterLike.html +++ b/interfaces/_buape_lib.EventEmitterLike.html @@ -1,4 +1,4 @@ -EventEmitterLike | Buape Utilities - v0.0.0

    Interface EventEmitterLike

    interface EventEmitterLike {
        off: ((...args) => any);
        on: ((...args) => any);
        once: ((...args) => any);
    }

    Properties

    off +EventEmitterLike | Buape Utilities - v0.0.0

    Interface EventEmitterLike

    interface EventEmitterLike {
        off: ((...args) => any);
        on: ((...args) => any);
        once: ((...args) => any);
    }

    Properties

    off on once -

    Properties

    off

    off: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    on

    on: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    once

    once: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    offononce
    \ No newline at end of file +

    Properties

    off

    off: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    on

    on: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    once

    once: ((...args) => any)

    Type declaration

      • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    offononce
    \ No newline at end of file diff --git a/interfaces/_buape_lib.EventOptions.html b/interfaces/_buape_lib.EventOptions.html index e7eadb23..c91d8540 100644 --- a/interfaces/_buape_lib.EventOptions.html +++ b/interfaces/_buape_lib.EventOptions.html @@ -1,4 +1,4 @@ -EventOptions | Buape Utilities - v0.0.0

    Interface EventOptions

    interface EventOptions {
        emitter?: EventEmitterLike;
        name: (keyof ClientEvents) | string & {};
        once?: boolean;
    }

    Properties

    emitter? +EventOptions | Buape Utilities - v0.0.0

    Interface EventOptions

    interface EventOptions {
        emitter?: EventEmitterLike;
        name: (keyof ClientEvents) | string & {};
        once?: boolean;
    }

    Properties

    emitter? name once? -

    Properties

    Optional emitter

    emitter?: EventEmitterLike

    name

    name: (keyof ClientEvents) | string & {}

    Optional once

    once?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    emitternameonce
    \ No newline at end of file +

    Properties

    Optional emitter

    emitter?: EventEmitterLike

    name

    name: (keyof ClientEvents) | string & {}

    Optional once

    once?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    emitternameonce
    \ No newline at end of file diff --git a/interfaces/_buape_lib.LibConfig.html b/interfaces/_buape_lib.LibConfig.html index bd21c9a9..9046b2b7 100644 --- a/interfaces/_buape_lib.LibConfig.html +++ b/interfaces/_buape_lib.LibConfig.html @@ -1,5 +1,5 @@ -LibConfig | Buape Utilities - v0.0.0

    Interface LibConfig

    interface LibConfig {
        accessSettings: AccessSettings;
        clientOptions: ClientOptions;
        prefix?: string;
        supportServer: string;
    }

    Properties

    accessSettings +LibConfig | Buape Utilities - v0.0.0

    Interface LibConfig

    interface LibConfig {
        accessSettings: AccessSettings;
        clientOptions: ClientOptions;
        prefix?: string;
        supportServer: string;
    }

    Properties

    accessSettings clientOptions prefix? supportServer -

    Properties

    accessSettings

    accessSettings: AccessSettings

    clientOptions

    clientOptions: ClientOptions

    Optional prefix

    prefix?: string

    supportServer

    supportServer: string

    Settings

    Member Visibility

    Theme

    On This Page

    accessSettingsclientOptionsprefixsupportServer
    \ No newline at end of file +

    Properties

    accessSettings

    accessSettings: AccessSettings

    clientOptions

    clientOptions: ClientOptions

    Optional prefix

    prefix?: string

    supportServer

    supportServer: string

    Settings

    Member Visibility

    Theme

    On This Page

    accessSettingsclientOptionsprefixsupportServer
    \ No newline at end of file diff --git a/types/_buape_dotperms.Permission.html b/types/_buape_dotperms.Permission.html index a7d23964..4494b8b6 100644 --- a/types/_buape_dotperms.Permission.html +++ b/types/_buape_dotperms.Permission.html @@ -1 +1 @@ -Permission | Buape Utilities - v0.0.0

    Type alias Permission

    Permission: `${string}.*` | `${string}.${string}.*` | `${string}.${string}.${string}` | `${string}.${string}` | "*"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Permission | Buape Utilities - v0.0.0

    Type alias Permission

    Permission: `${string}.*` | `${string}.${string}.*` | `${string}.${string}.${string}` | `${string}.${string}` | "*"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_buape_lib.ButtonOptions.html b/types/_buape_lib.ButtonOptions.html index 102f1984..11ebab14 100644 --- a/types/_buape_lib.ButtonOptions.html +++ b/types/_buape_lib.ButtonOptions.html @@ -1 +1 @@ -ButtonOptions | Buape Utilities - v0.0.0

    Type alias ButtonOptions

    ButtonOptions: BaseComponentOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ButtonOptions | Buape Utilities - v0.0.0

    Type alias ButtonOptions

    ButtonOptions: BaseComponentOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_buape_lib.DropdownOptions.html b/types/_buape_lib.DropdownOptions.html index dfec3e96..69b9d2e9 100644 --- a/types/_buape_lib.DropdownOptions.html +++ b/types/_buape_lib.DropdownOptions.html @@ -1 +1 @@ -DropdownOptions | Buape Utilities - v0.0.0

    Type alias DropdownOptions

    DropdownOptions: BaseComponentOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +DropdownOptions | Buape Utilities - v0.0.0

    Type alias DropdownOptions

    DropdownOptions: BaseComponentOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_buape_lib.PaginatorMessage.html b/types/_buape_lib.PaginatorMessage.html index 1ba66f76..88e8443b 100644 --- a/types/_buape_lib.PaginatorMessage.html +++ b/types/_buape_lib.PaginatorMessage.html @@ -1 +1 @@ -PaginatorMessage | Buape Utilities - v0.0.0

    Type alias PaginatorMessage

    PaginatorMessage: {
        components?: ActionRowBuilder<MessageActionRowComponentBuilder>[];
        content?: string;
        embeds?: APIEmbed[];
        ephemeral?: boolean;
        files?: InteractionReplyOptions["files"];
    }

    Type declaration

    • Optional components?: ActionRowBuilder<MessageActionRowComponentBuilder>[]
    • Optional content?: string
    • Optional embeds?: APIEmbed[]
    • Optional ephemeral?: boolean
    • Optional files?: InteractionReplyOptions["files"]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PaginatorMessage | Buape Utilities - v0.0.0

    Type alias PaginatorMessage

    PaginatorMessage: {
        components?: ActionRowBuilder<MessageActionRowComponentBuilder>[];
        content?: string;
        embeds?: APIEmbed[];
        ephemeral?: boolean;
        files?: InteractionReplyOptions["files"];
    }

    Type declaration

    • Optional components?: ActionRowBuilder<MessageActionRowComponentBuilder>[]
    • Optional content?: string
    • Optional embeds?: APIEmbed[]
    • Optional ephemeral?: boolean
    • Optional files?: InteractionReplyOptions["files"]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_buape_lib.TextCommandOptions.html b/types/_buape_lib.TextCommandOptions.html index 9be785ea..1aab5824 100644 --- a/types/_buape_lib.TextCommandOptions.html +++ b/types/_buape_lib.TextCommandOptions.html @@ -1 +1 @@ -TextCommandOptions | Buape Utilities - v0.0.0

    Type alias TextCommandOptions

    TextCommandOptions: Pick<BaseComponentOptions, "restriction">

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TextCommandOptions | Buape Utilities - v0.0.0

    Type alias TextCommandOptions

    TextCommandOptions: Pick<BaseComponentOptions, "restriction">

    Settings

    Member Visibility

    Theme

    \ No newline at end of file