Link Search Menu Expand Document (external link)
Documentation

birb / Exports

birb

Table of contents

Namespaces

Enumerations

Classes

Type Aliases

Variables

Type Aliases

APIGuild

Ƭ APIGuild: Object

Type declaration

Name Type Description
afk_channel_id string | null id of afk channel
afk_timeout number afk timeout in seconds
application_id string | null application id of the guild creator if it is bot-created
approximate_member_count? number approximate number of members in this guild, returned from the GET /guilds/<id> endpoint when with_counts is true
approximate_presence_count? number approximate number of non-offline members in this guild, returned from the GET /guilds/<id> endpoint when with_counts is true
banner string | null banner hash
default_message_notifications GuildMessageNotificationLevel default message notifications level
description string | null the description of a guild
discovery_splash string | null discovery splash hash; only present for guilds with the “DISCOVERABLE” feature
emojis any[] custom guild emojis
explicit_content_filter GuildExplicitContentFilterLevel explicit content filter level
features GuildFeature[] enabled guild features
icon string | null icon hash
id string the guild’s id
max_members? number the maximum number of members for the guild
max_presences? number | null the maximum number of presences for the guild (null is always returned, apart from the largest of guilds)
max_video_channel_users? number the maximum amount of users in a video channel
mfa_level GuildMFALevel required MFA level for the guild
name string guild name (2-100 characters, excluding trailing and leading whitespace)
nsfw_level GuildNSFWLevel guild NSFW level
owner? boolean true if the user is the owner of the guild
owner_id string id of owner
permissions? string total permissions for the user in the guild (excludes overwrites)
preferred_locale string the preferred locale of a Community guild; used in server discovery and notices from Discord, and sent in interactions; defaults to en-US
premium_progress_bar_enabled boolean whether the guild has the boost progress bar enabled
premium_subscription_count? number the number of boosts this guild currently has
premium_tier GuildPremiumTierLevel premium tier (Server Boost level)
public_updates_channel_id string | null the id of the channel where admins and moderators of Community guilds receive notices from Discord
roles any[] roles in the guild
rules_channel_id string | null the id of the channel where Community guilds can display rules and/or guidelines
splash string | null splash hash
stickers? any[] custom guild stickers
system_channel_flags number system channel flags
system_channel_id string | null the id of the channel where guild notices such as welcome messages and boost events are posted
vanity_url_code string | null the vanity url code for the guild
verification_level GuildVerificationLevel verification level required for the guild
welcome_screen? any the welcome screen of a Community guild, shown to new members, returned in an Invite’s guild object
widget_channel_id string | null the channel id that the widget will generate an invite to, or null if set to no invite
widget_enabled? boolean true if the server widget is enabled

Defined in

src/classes/api/types/APIGuild.ts:1

APIGuildMember

Ƭ APIGuildMember: Object

Type declaration

Name Type
avatar? string | null
communication_disabled_until? string | null
deaf boolean
joined_at string
mute boolean
nick? string | null
pending? boolean
premium_since? string | null
roles string[]

Defined in

src/classes/api/types/APIGuildMember.ts:3

APIGuildMemberWithUser

Ƭ APIGuildMemberWithUser: APIGuildMember & { user: APIUser }

Defined in

src/classes/api/types/APIGuildMember.ts:15

APIGuildPartial

Ƭ APIGuildPartial: Object

Type declaration

Name Type
id string
unavailable? boolean

Defined in

src/classes/api/types/APIGuild.ts:160

APIResponse

Ƭ APIResponse<Type>: Object

Type parameters

Name Type
Type any

Type declaration

Name Type
json Type
status number

Defined in

src/classes/api/APIEndpoint.ts:143

APIUser

Ƭ APIUser: Object

Type declaration

Name Type
avatar string | null
banner? string | null
bot? boolean
discriminator string
email? string | null
flags? number
id string
locale? string
mfa_enabled? boolean
premium_type? UserNitroType
public_flags? number
system? boolean
username string
verified? boolean

Defined in

src/classes/api/types/APIUser.ts:1

AllowedMentionsOptions

Ƭ AllowedMentionsOptions: Object

Type declaration

Name Type
parse? MessageMentionTypes[]
repliedUser? boolean
roles? string[]
users? string[]

Defined in

src/classes/Birb.ts:173

Awaitable

Ƭ Awaitable<T>: Promise<T> | T

Type parameters

Name
T

Defined in

src/utils/types.ts:1

BirbEvent

Ƭ BirbEvent: "ready" | "guild created" | "guild updated" | "guild becomes unavailable" | "guild deleted" | "gateway connection established" | "gateway heartbeat sent" | "gateway heartbeat ack received" | "gateway packet sent" | "gateway packet received"

Defined in

src/classes/Birb.ts:180

BirbOptions

Ƭ BirbOptions: Object

Type declaration

Name Type
allowedMentions? AllowedMentionsOptions
debug? boolean
intents IntentsResolvable[]

Defined in

src/classes/Birb.ts:167

BitResolvable

Ƭ BitResolvable<Flags>: Flags | bigint

Type parameters

Name
Flags

Defined in

src/classes/bitfields/Bitfield.ts:3

GetGuildParams

Ƭ GetGuildParams: Object

Type declaration

Name Type
guildId string
withCounts? boolean

Defined in

src/classes/api/endpoints/GetGuildRequest.ts:7

GuildEditOptions

Ƭ GuildEditOptions: Object

Type declaration

Name Type
afkChannelId? string | null
afkTimeout? 60 | 300 | 900 | 1800 | 3600
boostProgressBarEnabled? boolean
defaultMessageNotificationsLevel? GuildMessageNotificationLevel
description? string | null
explicitContentFilterLevel? GuildExplicitContentFilterLevel
features? GuildFeature[]
name? string
ownerId? string
preferredLocale? string
publicUpdatesChannelId? string | null
rulesChannelId? string | null
systemChannelFlags? SystemChannelFlagsResolvable[]
systemChannelId? string | null
verificationLevel? GuildVerificationLevel

Defined in

src/classes/Guild.ts:432

GuildFeature

Ƭ GuildFeature: "ANIMATED_BANNER" | "ANIMATED_ICON" | "AUTO_MODERATION" | "BANNER" | "COMMUNITY" | "DISCOVERABLE" | "FEATURABLE" | "INVITE_SPLASH" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MONETIZATION_ENABLED" | "MORE_STICKERS" | "NEWS" | "PARTNERED" | "PREVIEW_ENABLED" | "PRIVATE_THREADS" | "ROLE_ICONS" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "WELCOME_SCREEN_ENABLED"

Defined in

src/classes/api/types/APIGuild.ts:203

IntentsResolvable

Ƭ IntentsResolvable: BitResolvable<IntentsString>

Defined in

src/classes/bitfields/Intents.ts:4

IntentsString

Ƭ IntentsString: keyof typeof IntentFlag

Defined in

src/classes/bitfields/Intents.ts:3

MessageMentionTypes

Ƭ MessageMentionTypes: "users" | "roles" | "everyone"

Defined in

src/utils/types.ts:2

ModifyGuildParams

Ƭ ModifyGuildParams: Object

Type declaration

Name Type
guildId string

Defined in

src/classes/api/endpoints/ModifyGuildRequest.ts:11

ModifyGuildRequestBody

Ƭ ModifyGuildRequestBody: Object

Type declaration

Name Type
afk_channel_id? string | null
afk_timeout? number
default_message_notifications? GuildMessageNotificationLevel
description? string | null
explicit_content_filter? GuildExplicitContentFilterLevel
features? GuildFeature[]
name? string
owner_id? string
preferred_locale? string
premium_progress_bar_enabled? boolean
public_updates_channel_id? string | null
rules_channel_id? string | null
system_channel_flags? bigint
system_channel_id? string | null
verification_level? GuildVerificationLevel

Defined in

src/classes/api/endpoints/ModifyGuildRequest.ts:15

SystemChannelFlagsResolvable

Ƭ SystemChannelFlagsResolvable: BitResolvable<SystemChannelFlagsString>

Defined in

src/classes/bitfields/SystemChannelFlags.ts:4

SystemChannelFlagsString

Ƭ SystemChannelFlagsString: keyof typeof SystemChannelFlag

Defined in

src/classes/bitfields/SystemChannelFlags.ts:3

UserFlagsResolvable

Ƭ UserFlagsResolvable: BitResolvable<UserFlagsString>

Defined in

src/classes/bitfields/UserFlags.ts:4

UserFlagsString

Ƭ UserFlagsString: keyof typeof UserFlag

Defined in

src/classes/bitfields/UserFlags.ts:3

Variables

IntentFlag

• Const IntentFlag: Object

Type declaration

Name Type
AUTO_MODERATION_CONFIGURATION bigint
AUTO_MODERATION_EXECUTION bigint
DIRECT_MESSAGES bigint
DIRECT_MESSAGE_REACTIONS bigint
DIRECT_MESSAGE_TYPING bigint
GUILDS bigint
GUILD_BANS bigint
GUILD_EMOJIS_AND_STICKERS bigint
GUILD_INTEGRATIONS bigint
GUILD_INVITES bigint
GUILD_MEMBERS bigint
GUILD_MESSAGES bigint
GUILD_MESSAGE_REACTIONS bigint
GUILD_MESSAGE_TYPING bigint
GUILD_PRESENCES bigint
GUILD_SCHEDULED_EVENTS bigint
GUILD_VOICE_STATES bigint
GUILD_WEBHOOKS bigint
MESSAGE_CONTENT bigint

Defined in

src/classes/bitfields/Intents.ts:5

SystemChannelFlag

• Const SystemChannelFlag: Object

Type declaration

Name Type
SUPPRESS_GUILD_REMINDER_NOTIFICATIONS bigint
SUPPRESS_JOIN_NOTIFICATIONS bigint
SUPPRESS_JOIN_NOTIFICATION_REPLIES bigint
SUPPRESS_PREMIUM_SUBSCRIPTIONS bigint

Defined in

src/classes/bitfields/SystemChannelFlags.ts:6

UserFlag

• Const UserFlag: Object

Type declaration

Name Type Description
BOT_HTTP_INTERACTIONS bigint A bot that uses only HTTP interactions and is shown in the online member list
BUG_HUNTER_LEVEL_1 bigint Bug Hunter Level 1
BUG_HUNTER_LEVEL_2 bigint Bug Hunter Level 2
CERTIFIED_MODERATOR bigint Discord Certified Moderator
HYPESQUAD bigint HypeSquad Events Member
HYPESQUAD_ONLINE_HOUSE_BALANCE bigint House Balance Member
HYPESQUAD_ONLINE_HOUSE_BRAVERY bigint House Bravery Member
HYPESQUAD_ONLINE_HOUSE_BRILLIANCE bigint House Brilliance Member
NITRO_EARLY_SUPPORTER bigint Early Nitro Supporter
PARTNER bigint Partnered Server Owner
STAFF bigint Discord Employee or Staff Member
TEAM_PSEUDO_USER bigint The user is actually a team
VERIFIED_BOT bigint Verified Bot
VERIFIED_BOT_DEVELOPER bigint Early Verified Bot Developer

Defined in

src/classes/bitfields/UserFlags.ts:5