Type Definitions
BadgeData
- Object
Name | Type | Description |
---|---|---|
emoji | String | The emoji |
id | String | The id of the emoji |
name | String | The name of the emoji |
url | String | The url of the emoji |
- Source
BaseComponentData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the base component |
enabled | Boolean | If the base component is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the base component (default: []) |
userPermissions | Array. | The permissions required for the user to execute the base component (default: []) |
category | String | The category of the base component (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the base component in seconds (default: 5) |
customId | String | The custom id of the base component |
defer | Boolean | If the base component should be deferred (default: true) |
dirname | String | The dirname of the base component (Will be set automatically) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the base component is an experiment (default: { required: false, id: null }) |
location | String | The location of the base component (Will be set automatically) |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the base component is available in (default: ALL) |
devOnly | Boolean | If the base component can only be executed by developers (default: false) |
guildOnly | Boolean | If the base component can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the base component can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the base component can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the base component can only be executed in NSFW channels (default: false) |
BaseInteractionData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the base interaction |
nameLocalizations | LocalizationMap | The localization names of the base interaction |
enabled | Boolean | If the base interaction is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the base interaction (default: []) |
userPermissions | Array. | The permissions required for the user to execute the base interaction (default: []) |
defaultMemberPermissions | Array. | The permissions required for the member to be able to use / see the base interaction (default: []) |
deployEnabled | Boolean | If the base interaction is enabled for deploying (default: false) |
dmEnabled | Boolean | If the base interaction is enabled for deloying in dms (default: true) |
category | String | The category of the base interaction (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the base interaction in seconds (default: 5) |
defer | Boolean | If the base interaction should be deferred (default: true) |
dirname | String | The dirname of the base interaction (Will be set automatically) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the base interaction is an experiment (default: { required: false, id: null }) |
id | Snowflake | The id of the base interaction |
location | String | The location of the base interaction (Will be set automatically) |
type | ApplicationCommandType | The type of the base interaction (Only required for context interactions: "Message" or "User") |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the base interaction is available in (default: ALL) |
devOnly | Boolean | If the base interaction can only be executed by developers (default: false) |
guildOnly | Boolean | If the base interaction can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the base interaction can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the base interaction can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the base interaction can only be executed in NSFW channels (default: false) |
BaseTicketManagerOptions
- Object
Name | Type | Description |
---|---|---|
staffRoles | Array. | The IDs of the staff roles |
storage | String | The json file to save the tickets to |
ButtonInteractionData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the button interaction |
enabled | Boolean | If the button interaction is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the button interaction (default: []) |
userPermissions | Array. | The permissions required for the user to execute the button interaction (default: []) |
category | String | The category of the button interaction (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the button interaction in seconds (default: 5) |
customId | String | The custom id of the button interaction |
defer | Boolean | If the button interaction should be deferred (default: true) |
dirname | String | The dirname of the button interaction (Will be set automatically) |
disabled | Boolean | If the button is disabled (default: false) |
emoji | APIMessageComponentEmoji | The emoji of the button |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the button interaction is an experiment (default: { required: false, id: null }) |
label | String | The label of the button |
location | String | The location of the button interaction (Will be set automatically) |
style | ButtonStyle | The style of the button (default: Success) |
url | URL | The url of the button |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the button interaction is available in (default: ALL) |
devOnly | Boolean | If the button interaction can only be executed by developers (default: false) |
guildOnly | Boolean | If the button interaction can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the button interaction can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the button interaction can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the button interaction can only be executed in NSFW channels (default: false) |
CaptchaOptions
- Object
Name | Type | Attributes | Description |
---|---|---|---|
height | Number | <nullable> | The height of the captcha (default: 250) |
length | Number | <nullable> | The length of the captcha (default: 6) |
value | String | <nullable> | The value of the captcha if not provided it will be generated randomly |
width | Number | <nullable> | The width of the captcha (default: 400) ⚠️ Do only change if you know what you do! ⚠️ |
- Source
ContextInteractionData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the context interaction |
nameLocalizations | LocalizationMap | The localization names of the context interaction |
enabled | Boolean | If the context interaction is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the context interaction (default: []) |
userPermissions | Array. | The permissions required for the user to execute the context interaction (default: []) |
deployEnabled | Boolean | If the context interaction is enabled for deploying (default: false) |
dmEnabled | Boolean | If the context interaction is enabled for deloying in dms (default: true) |
category | String | The category of the context interaction (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the context interaction in seconds (default: 5) |
defer | Boolean | If the context interaction should be deferred (default: true) |
dirname | String | The dirname of the context interaction (Will be set automatically) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the context interaction is an experiment (default: { required: false, id: null }) |
id | Snowflake | The id of the context interaction |
location | String | The location of the context interaction (Will be set automatically) |
type | ApplicationCommandType | The type of the base interaction (Only required for context interactions: "Message" or "User") |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the context interaction is available in (default: ALL) |
devOnly | Boolean | If the context interaction can only be executed by developers (default: false) |
guildOnly | Boolean | If the context interaction can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the context interaction can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the context interaction can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the context interaction can only be executed in NSFW channels (default: false) |
EmojiData
- Object
Name | Type | Description |
---|---|---|
emoji | String | The emoji |
id | String | The id of the emoji |
name | String | The name of the emoji |
url | String | The url of the emoji |
- Source
EmojiData
The data of all emojis
- Object
Name | Type | Description |
---|---|---|
emoji | String | The emoji |
id | String | The id of the emoji |
name | String | The name of the emoji |
url | String | The url of the emoji |
- Source
EventData
- Object
Name | Type | Description |
---|---|---|
enabled | Boolean | If the event is enabled for loading. (default: true) |
name | String | The name of the event. |
once | Boolean | If the event should only be triggered once. (default: false) |
location | String | The location of the event (Will be set automatically) |
- Source
EventManagerOptions
- Object
Name | Type | Description |
---|---|---|
locationEvents | String | The location of the events |
- Source
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the base component |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the base interaction |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the button interaction |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the context interaction |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the modal interaction |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the select menu interaction |
id | Number | The id of the experiment |
ExperimentData
- Object
Name | Type | Description |
---|---|---|
required | Boolean | If the experiment is required to execute the slash command |
id | Number | The id of the experiment |
IncidentData
- Object
Name | Type | Description |
---|---|---|
id | String | The id of the incident |
lastUpdate | String | The last update of the incident |
messageId | Snowflake | The id of the message of the incident |
resolved | Boolean | If the incident is resolved |
IncidentDataRaw
- Object
Name | Type | Description |
---|---|---|
components | Array. | The components of the incident |
created_at | String | The creation date of the incident |
id | String | The id of the incident |
impact | String | The impact of the incident |
incident_updates | Array. | The updates of the incident |
monitoring_at | String | The monitoring date of the incident |
name | String | The name of the incident |
page_id | String | The id of the status page |
resolved_at | String | The resolved date of the incident |
shortlink | String | The link of the incident |
started_at | String | The start date of the incident |
status | String | The status of the incident |
updated_at | String | The last update of the incident |
IncidentDataRawComponent
- Object
Name | Type | Description |
---|---|---|
created_at | String | The creation date of the component |
description | String | The description of the component |
group | Boolean | If the component is a group |
group_id | String | | The id of the group of the component |
id | String | The id of the component |
name | String | The name of the component |
only_show_if_degraded | Boolean | If the component is only shown if degraded |
page_id | String | The id of the status page |
position | Number | The position of the component |
showcase | Boolean | If the component is in the showcase |
start_date | String | | The start date of the component |
status | String | The status of the component |
updated_at | String | The last update of the component |
IncidentDataRawComponentUpdate
- Object
Name | Type | Description |
---|---|---|
code | String | The code of the component update |
name | String | The name of the component update |
new_status | String | The new status of the component update |
old_status | String | The old status of the component update |
IncidentDataRawUpdate
- Object
Name | Type | Description |
---|---|---|
affected_components | Array. | The affected components of the update |
body | String | The body of the update |
created_at | String | The creation date of the update |
custom_tweet | String | | The custom tweet of the update |
deliver_notifications | Boolean | If the update should be delivered to the users |
display_at | String | The display date of the update |
id | String | The id of the incident update |
incident_id | String | The id of the incident |
status | String | The status of the incident update |
tweet_id | String | | The id of the tweet of the update |
update_at | String | The date of the incident update |
InteractionManagerOptions
- Object
Name | Type | Attributes | Description |
---|---|---|---|
guildIDs | Array. | The ids of the guild the commands should be deployed to | |
locationButtonInteractions | String | <nullable> | The location of the button interactions |
locationContextInteractions | String | <nullable> | The location of the context interactions |
locationModalInteractions | String | <nullable> | The location of the modal interactions |
locationSelectMenuInteractions | String | <nullable> | The location of the select menu interactions |
locationSlashCommands | String | <nullable> | The location of the slash commands |
LoadAllOptions
- Object
Name | Type | Attributes | Description |
---|---|---|---|
folderName | String | <optional> | The name of the folder |
translationDir | String | <optional> | The location of the translations |
namespaces | Array | <optional> | The namespaces |
LogData
- Object
Name | Type | Description |
---|---|---|
consoleString | String | The string that should be logged to the console |
webhookString | String | The string that should be logged to a webhook |
- Source
LoggerIcons
- Object
Name | Type | Description |
---|---|---|
debug | String | (Default: "⚒") |
error | String | (Default: "🛑") |
fail | String | (Default: "❌") |
info | String | (Default: "ℹ") |
success | String | (Default: "✅") |
warn | String | (Default: "⚠") |
- Source
LoggerOptions
- Object
Name | Type | Attributes | Description |
---|---|---|---|
icons | LoggerIcons | <nullable> | The icons which the logger uses |
name | String | The name of the logger | |
sentryOptions | NodeOptions | <nullable> | The options for the Sentry client |
webhooks | Array. | An array of webhook clients, the messages should be sent to |
- Source
ModalInteractionData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the modal interaction |
enabled | Boolean | If the modal interaction is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the modal interaction (default: []) |
userPermissions | Array. | The permissions required for the user to execute the modal interaction (default: []) |
category | String | The category of the modal interaction (Will be set automatically. default: "Other") |
components | Array. | The components of the modal |
cooldown | Number | The cooldown of the modal interaction in seconds (default: 5) |
customId | String | The custom id of the modal interaction |
defer | Boolean | If the modal interaction should be deferred (default: true) |
dirname | String | The dirname of the modal interaction (Will be set automatically) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the modal interaction is an experiment (default: { required: false, id: null }) |
location | String | The location of the modal interaction (Will be set automatically) |
title | String | The title of the modal |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the modal interaction is available in (default: ALL) |
devOnly | Boolean | If the modal interaction can only be executed by developers (default: false) |
guildOnly | Boolean | If the modal interaction can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the modal interaction can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the modal interaction can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the modal interaction can only be executed in NSFW channels (default: false) |
PartnerData
The data of all partners
- Object
Name | Type | Attributes | Description |
---|---|---|---|
name | String | The name of the partner | |
longDescription | TranslationData | The long description of the partner | |
shortDescription | TranslationData | The short description of the partner | |
emoji | EmojiData | The emoji of the partner | |
owner | String | The owner id of the partner | |
type | TranslationData | The type of the partner | |
bannerURL | String | <nullable> | The banner URL of the partner |
iconURL | String | The icon URL of the partner | |
discordURL | String | <nullable> | The discord URL of the partner |
instagramURL | String | <nullable> | The instagram URL of the partner |
twitterURL | String | <nullable> | The twitter URL of the partner |
websiteURL | String | <nullable> | The website URL of the partner |
- Source
SelectMenuInteractionData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the select menu interaction |
enabled | Boolean | If the select menu interaction is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the select menu interaction (default: []) |
userPermissions | Array. | The permissions required for the user to execute the select menu interaction (default: []) |
category | String | The category of the select menu interaction (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the select menu interaction in seconds (default: 5) |
customId | String | The custom id of the select menu interaction |
defer | Boolean | If the select menu interaction should be deferred (default: true) |
dirname | String | The dirname of the select menu interaction (Will be set automatically) |
disabled | Boolean | If the select menu is disabled (default: false) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the select menu interaction is an experiment (default: { required: false, id: null }) |
location | String | The location of the select menu interaction (Will be set automatically) |
maxValues | Number | The maximum amount of values the user can choose from the select menu (default: 1) |
minValues | Number | The minimum amount of values the user can choose from the select menu (default: 1) |
options | Array. | The options of the select menu |
placeholder | String | The placeholder of the select menu |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the select menu interaction is available in (default: ALL) |
devOnly | Boolean | If the select menu interaction can only be executed by developers (default: false) |
guildOnly | Boolean | If the select menu interaction can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the select menu interaction can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the select menu interaction can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the select menu interaction can only be executed in NSFW channels (default: false) |
SlashCommandData
- Object
Name | Type | Description |
---|---|---|
name | String | The name of the slash command |
nameLocalizations | LocalizationMap | The localization names of the slash command |
description | String | The description of the slash command |
descriptionLocalizations | LocalizationMap | The localization descriptions of the slash command |
usage | String | The usage of the slash command |
enabled | Boolean | If the slash command is enabled (default: false) |
clientPermissions | Array. | The permissions required for the client to execute the slash command (default: []) |
userPermissions | Array. | The permissions required for the user to execute the slash command (default: []) |
deployEnabled | Boolean | If the slash command is enabled for deploying (default: false) |
dmEnabled | Boolean | If the slash command is enabled for deloying in dms (default: true) |
options | Array. | The options of the slash command |
category | String | The category of the slash command (Will be set automatically. default: "Other") |
cooldown | Number | The cooldown of the slash command in seconds (default: 5) |
defaultEnabled | Boolean | If the slash command is enabled by default (default: false) |
defer | Boolean | If the slash command should be deferred (default: true) |
dirname | String | The dirname of the slash command (Will be set automatically) |
ephemeral | Boolean | If the response is ephemeral (default: false) |
experiment | ExperimentData | If the slash command is an experiment (default: { required: false, id: null }) |
hidden | Boolean | If the slash command should be hidden in the list (default: false) |
id | Snowflake | The id of the slash command |
location | String | The location of the slash command (Will be set automatically) |
betaOnly | Boolean | If the command is only available in beta (default: false) |
channelOnly | Array. | An array of all channel types the slash command is available in (default: ALL) |
devOnly | Boolean | If the slash command can only be executed by developers (default: false) |
guildOnly | Boolean | If the slash command can only be executed in guilds (default: true) |
ownerOnly | Boolean | If the slash command can only be executed by the owner of the bot (default: true) |
premiumOnly | Boolean | If the slash command can only be executed by guilds who have premium perks (default: false) |
nsfw | Boolean | If the slash command can only be executed in NSFW channels (default: false) |
StatusPageCheckerOptions
- Object
Name | Type | Description |
---|---|---|
checkInterval | Number | The time in ms the checker should check (default: 60000) |
colors | StatusPageCheckerOptionsColors | The colors of the embeds |
storage | String | The json file to save the incidents to |
url | String | The URL of the status page you want to monitore |
webhook | WebhookClient | webhook client |
StatusPageCheckerOptionsColors
- Object
Name | Type | Description |
---|---|---|
BLACK | String | (default: #000000) |
GREEN | String | (default: #51f34d) |
ORANGE | String | (default: #fcb22d) |
RED | String | (default: #fe6b61) |
YELLOW | String | (default: #ffde22) |
TextTicketManagerOptions
- Object
Name | Type | Description |
---|---|---|
channelTopic | String | The topic of the ticket channel |
closedParentId | Snowflake | The id of the closed tickte category (default: #parentId) |
parentId | Snowflake | The id of the ticket category |
staffRoles | Array. | The IDs of the staff roles |
storage | String | The json file to save the tickets to |
TicketDataRaw
- Object
Name | Type | Description |
---|---|---|
channelId | Snowflake | The id of the ticket channel or thread |
guildId | Snowflake | The id of the guild |
number | Number | The number of the ticket |
participants | Array. | The array with all ids of participants |
status | TicketDataStatus | The status of the ticket |
type | TicketDataType | The type of the ticket |
userId | Snowflake | The id of the user |
TicketDataRaw
- Object
Name | Type | Description |
---|---|---|
channelId | Snowflake | The id of the ticket channel or thread |
guildId | Snowflake | The id of the guild |
number | Number | The number of the ticket |
participants | Array. | The array with all ids of participants |
status | TicketDataStatus | The status of the ticket |
type | TicketDataType | The type of the ticket |
userId | Snowflake | The id of the user |
TicketDataRaw
- Object
Name | Type | Description |
---|---|---|
channelId | Snowflake | The id of the ticket channel or thread |
guildId | Snowflake | The id of the guild |
number | Number | The number of the ticket |
participants | Array. | The array with all ids of participants |
status | TicketDataStatus | The status of the ticket |
type | TicketDataType | The type of the ticket |
userId | Snowflake | The id of the user |
- Source
TicketDataStatus
- "CLOSED"
- "DELETED"
- "OPEN"
- String
TicketDataStatus
- "CLOSED"
- "DELETED"
- "OPEN"
- String
- Source
TicketDataType
- "CHANNEL"
- String
TicketDataType
- "CHANNEL"
- String
- Source
TranslateOptions
- Object
Name | Type | Attributes | Description |
---|---|---|---|
language | String | <optional> | The language |
TranslationData
The data of all translations
- Object
Name | Type | Description |
---|---|---|
language | String | The language of the string |
- Source
TranslationManagerOptions
- Object
Name | Type | Description |
---|---|---|
defaultLanguage | String | The default language to use if no language is specified. |
i18nextOptions | i18next. | Additional options to pass to i18next. |
locationTranslations | String | The location of the translations |