Skip to main content

Bot

Documentation

Documentation / @discordeno/bot / Bot

Interface: Bot<TProps, TBehavior>

Defined in: bot/src/bot.ts:153

Type Parameters​

TProps​

TProps extends TransformersDesiredProperties = TransformersDesiredProperties

TBehavior​

TBehavior extends DesiredPropertiesBehavior = RemoveKey

Properties​

applicationId​

applicationId: bigint

Defined in: bot/src/bot.ts:160

The application id of the bot. This is usually the same as id but in the case of old bots can be different.

events​

events: Partial<EventHandlers<TProps, TBehavior>>

Defined in: bot/src/bot.ts:166

The event handlers.

gateway​

gateway: GatewayManager

Defined in: bot/src/bot.ts:164

The gateway manager.

handlers​

handlers: GatewayHandlers<TProps, TBehavior>

Defined in: bot/src/bot.ts:176

The handler functions that should handle incoming discord payloads from gateway and call an event.

helpers​

helpers: BotHelpers<TProps, TBehavior>

Defined in: bot/src/bot.ts:177

id​

id: bigint

Defined in: bot/src/bot.ts:158

The id of the bot.

logger​

logger: Pick<typeof logger, "debug" | "info" | "warn" | "error" | "fatal">

Defined in: bot/src/bot.ts:168

A logger utility to make it easy to log nice and useful things in the bot code.

rest​

rest: RestManager

Defined in: bot/src/bot.ts:162

The rest manager.

shutdown()​

shutdown: () => Promise<void>

Defined in: bot/src/bot.ts:181

Shuts down all the bot connections to the gateway.

Returns​

Promise<void>

start()​

start: () => Promise<void>

Defined in: bot/src/bot.ts:179

Start the bot connection to the gateway.

Returns​

Promise<void>

transformers​

transformers: Transformers<TProps, TBehavior> & object

Defined in: bot/src/bot.ts:170

The functions that should transform discord objects to discordeno shaped objects.

Type declaration​

$inferredTypes​

$inferredTypes: object

$inferredTypes.activityInstance​

$inferredTypes.activityInstance: ActivityInstance

$inferredTypes.activityLocation​

$inferredTypes.activityLocation: ActivityLocation

$inferredTypes.attachment​

$inferredTypes.attachment: Attachment

$inferredTypes.avatarDecorationData​

$inferredTypes.avatarDecorationData: AvatarDecorationData

$inferredTypes.channel​

$inferredTypes.channel: Channel

$inferredTypes.collectibles​

$inferredTypes.collectibles: Collectibles

$inferredTypes.component​

$inferredTypes.component: Component

$inferredTypes.defaultReactionEmoji​

$inferredTypes.defaultReactionEmoji: DefaultReactionEmoji

$inferredTypes.emoji​

$inferredTypes.emoji: Emoji

$inferredTypes.entitlement​

$inferredTypes.entitlement: Entitlement

$inferredTypes.forumTag​

$inferredTypes.forumTag: ForumTag

$inferredTypes.guild​

$inferredTypes.guild: Guild

$inferredTypes.guildOnboarding​

$inferredTypes.guildOnboarding: GuildOnboarding

$inferredTypes.guildOnboardingPrompt​

$inferredTypes.guildOnboardingPrompt: GuildOnboardingPrompt

$inferredTypes.guildOnboardingPromptOption​

$inferredTypes.guildOnboardingPromptOption: GuildOnboardingPromptOption

$inferredTypes.incidentsData​

$inferredTypes.incidentsData: IncidentsData

$inferredTypes.interaction​

$inferredTypes.interaction: Interaction

$inferredTypes.interactionCallback​

$inferredTypes.interactionCallback: InteractionCallback

$inferredTypes.interactionCallbackResponse​

$inferredTypes.interactionCallbackResponse: InteractionCallbackResponse

$inferredTypes.interactionResource​

$inferredTypes.interactionResource: InteractionResource

$inferredTypes.invite​

$inferredTypes.invite: Invite

$inferredTypes.inviteStageInstance​

$inferredTypes.inviteStageInstance: InviteStageInstance

$inferredTypes.lobby​

$inferredTypes.lobby: Lobby

$inferredTypes.lobbyMember​

$inferredTypes.lobbyMember: LobbyMember

$inferredTypes.mediaGalleryItem​

$inferredTypes.mediaGalleryItem: MediaGalleryItem

$inferredTypes.member​

$inferredTypes.member: Member

$inferredTypes.message​

$inferredTypes.message: Message

$inferredTypes.messageCall​

$inferredTypes.messageCall: MessageCall

$inferredTypes.messageInteraction​

$inferredTypes.messageInteraction: MessageInteraction

$inferredTypes.messageInteractionMetadata​

$inferredTypes.messageInteractionMetadata: MessageInteractionMetadata

$inferredTypes.messageReference​

$inferredTypes.messageReference: MessageReference

$inferredTypes.messageSnapshot​

$inferredTypes.messageSnapshot: MessageSnapshot

$inferredTypes.nameplate​

$inferredTypes.nameplate: Nameplate

$inferredTypes.poll​

$inferredTypes.poll: Poll

$inferredTypes.pollAnswer​

$inferredTypes.pollAnswer: PollAnswer

$inferredTypes.pollAnswerCount​

$inferredTypes.pollAnswerCount: PollAnswerCount

$inferredTypes.pollMedia​

$inferredTypes.pollMedia: PollMedia

$inferredTypes.pollResult​

$inferredTypes.pollResult: PollResult

$inferredTypes.role​

$inferredTypes.role: Role

$inferredTypes.scheduledEvent​

$inferredTypes.scheduledEvent: ScheduledEvent

$inferredTypes.scheduledEventRecurrenceRule​

$inferredTypes.scheduledEventRecurrenceRule: ScheduledEventRecurrenceRule

$inferredTypes.sku​

$inferredTypes.sku: Sku

$inferredTypes.soundboardSound​

$inferredTypes.soundboardSound: SoundboardSound

$inferredTypes.stageInstance​

$inferredTypes.stageInstance: StageInstance

$inferredTypes.sticker​

$inferredTypes.sticker: Sticker

$inferredTypes.subscription​

$inferredTypes.subscription: Subscription

$inferredTypes.unfurledMediaItem​

$inferredTypes.unfurledMediaItem: UnfurledMediaItem

$inferredTypes.user​

$inferredTypes.user: User

$inferredTypes.voiceState​

$inferredTypes.voiceState: VoiceState

$inferredTypes.webhook​

$inferredTypes.webhook: Webhook