Skip to content

PermissionsBitField

Defined in: packages/structures/src/permissions.ts:590

Permissions bitfield alias.

new PermissionsBitField(value?): PermissionsBitField

Defined in: packages/structures/src/permissions.ts:597

Creates a permissions bitfield.

PermissionResolvable = 0n

Initial permission bitfield or array of permissions.

PermissionsBitField

PermissionSet.constructor

readonly bitfield: bigint

Defined in: packages/structures/src/permissions.ts:153

Permission bitfield.

PermissionSet.bitfield


readonly static All: object = Permission

Defined in: packages/structures/src/permissions.ts:594

Permission flags constants.

readonly addReactions: bigint

readonly administrator: bigint

readonly attachFiles: bigint

readonly banMembers: bigint

readonly bypassSlowmode: bigint

readonly changeNickname: bigint

readonly connect: bigint

readonly createEvents: bigint

readonly createGuildExpressions: bigint

readonly createInstantInvite: bigint

readonly createPrivateThreads: bigint

readonly createPublicThreads: bigint

readonly deafenMembers: bigint

readonly embedLinks: bigint

readonly kickMembers: bigint

readonly manageChannels: bigint

readonly manageEvents: bigint

readonly manageGuild: bigint

readonly manageGuildExpressions: bigint

readonly manageMessages: bigint

readonly manageNicknames: bigint

readonly manageRoles: bigint

readonly manageThreads: bigint

readonly manageWebhooks: bigint

readonly mentionEveryone: bigint

readonly moderateMembers: bigint

readonly moveMembers: bigint

readonly muteMembers: bigint

readonly pinMessages: bigint

readonly prioritySpeaker: bigint

readonly readMessageHistory: bigint

readonly requestToSpeak: bigint

readonly sendMessages: bigint

readonly sendMessagesInThreads: bigint

readonly sendPolls: bigint

readonly sendTTSMessages: bigint

readonly sendVoiceMessages: bigint

readonly setVoiceChannelStatus: bigint

readonly speak: bigint

readonly stream: bigint

readonly useApplicationCommands: bigint

readonly useEmbeddedActivities: bigint

readonly useExternalApps: bigint

readonly useExternalEmojis: bigint

readonly useExternalSounds: bigint

readonly useExternalStickers: bigint

readonly useSoundboard: bigint

readonly useVAD: bigint

readonly viewAuditLog: bigint

readonly viewChannel: bigint

readonly viewCreatorMonetizationAnalytics: bigint

readonly viewGuildInsights: bigint


readonly static Flags: object = PermissionFlagsBits

Defined in: packages/structures/src/permissions.ts:592

Permission flags bits enum.

readonly AddReactions: bigint

readonly Administrator: bigint

readonly AttachFiles: bigint

readonly BanMembers: bigint

readonly BypassSlowmode: bigint

readonly ChangeNickname: bigint

readonly Connect: bigint

readonly CreateEvents: bigint

readonly CreateGuildExpressions: bigint

readonly CreateInstantInvite: bigint

readonly CreatePrivateThreads: bigint

readonly CreatePublicThreads: bigint

readonly DeafenMembers: bigint

readonly EmbedLinks: bigint

readonly KickMembers: bigint

readonly ManageChannels: bigint

readonly ManageEvents: bigint

readonly ManageGuild: bigint

readonly ManageGuildExpressions: bigint

readonly ManageMessages: bigint

readonly ManageNicknames: bigint

readonly ManageRoles: bigint

readonly ManageThreads: bigint

readonly ManageWebhooks: bigint

readonly MentionEveryone: bigint

readonly ModerateMembers: bigint

readonly MoveMembers: bigint

readonly MuteMembers: bigint

readonly PinMessages: bigint

readonly PrioritySpeaker: bigint

readonly ReadMessageHistory: bigint

readonly RequestToSpeak: bigint

readonly SendMessages: bigint

readonly SendMessagesInThreads: bigint

readonly SendPolls: bigint

readonly SendTTSMessages: bigint

readonly SendVoiceMessages: bigint

readonly SetVoiceChannelStatus: bigint

readonly Speak: bigint

readonly Stream: bigint

readonly UseApplicationCommands: bigint

readonly UseEmbeddedActivities: bigint

readonly UseExternalApps: bigint

readonly UseExternalEmojis: bigint

readonly UseExternalSounds: bigint

readonly UseExternalStickers: bigint

readonly UseSoundboard: bigint

readonly UseVAD: bigint

readonly ViewAuditLog: bigint

readonly ViewChannel: bigint

readonly ViewCreatorMonetizationAnalytics: bigint

readonly ViewGuildInsights: bigint

get addReactions(): boolean

Defined in: packages/structures/src/permissions.ts:217

boolean

PermissionSet.addReactions


get administrator(): boolean

Defined in: packages/structures/src/permissions.ts:200

boolean

PermissionSet.administrator


get attachFiles(): boolean

Defined in: packages/structures/src/permissions.ts:266

boolean

PermissionSet.attachFiles


get banMembers(): boolean

Defined in: packages/structures/src/permissions.ts:195

boolean

PermissionSet.banMembers


get bypassSlowmode(): boolean

Defined in: packages/structures/src/permissions.ts:465

boolean

PermissionSet.bypassSlowmode


get changeNickname(): boolean

Defined in: packages/structures/src/permissions.ts:320

boolean

PermissionSet.changeNickname


get connect(): boolean

Defined in: packages/structures/src/permissions.ts:295

boolean

PermissionSet.connect


get createEvents(): boolean

Defined in: packages/structures/src/permissions.ts:427

boolean

PermissionSet.createEvents


get createGuildExpressions(): boolean

Defined in: packages/structures/src/permissions.ts:421

boolean

PermissionSet.createGuildExpressions


get createInstantInvite(): boolean

Defined in: packages/structures/src/permissions.ts:184

boolean

PermissionSet.createInstantInvite


get createPrivateThreads(): boolean

Defined in: packages/structures/src/permissions.ts:379

boolean

PermissionSet.createPrivateThreads


get createPublicThreads(): boolean

Defined in: packages/structures/src/permissions.ts:373

boolean

PermissionSet.createPublicThreads


get deafenMembers(): boolean

Defined in: packages/structures/src/permissions.ts:306

boolean

PermissionSet.deafenMembers


get embedLinks(): boolean

Defined in: packages/structures/src/permissions.ts:261

boolean

PermissionSet.embedLinks


get kickMembers(): boolean

Defined in: packages/structures/src/permissions.ts:190

boolean

PermissionSet.kickMembers


get manageChannels(): boolean

Defined in: packages/structures/src/permissions.ts:206

boolean

PermissionSet.manageChannels


get manageEvents(): boolean

Defined in: packages/structures/src/permissions.ts:361

boolean

PermissionSet.manageEvents


get manageGuild(): boolean

Defined in: packages/structures/src/permissions.ts:212

boolean

PermissionSet.manageGuild


get manageGuildExpressions(): boolean

Defined in: packages/structures/src/permissions.ts:343

boolean

PermissionSet.manageGuildExpressions


get manageMessages(): boolean

Defined in: packages/structures/src/permissions.ts:255

boolean

PermissionSet.manageMessages


get manageNicknames(): boolean

Defined in: packages/structures/src/permissions.ts:326

boolean

PermissionSet.manageNicknames


get manageRoles(): boolean

Defined in: packages/structures/src/permissions.ts:332

boolean

PermissionSet.manageRoles


get manageThreads(): boolean

Defined in: packages/structures/src/permissions.ts:367

boolean

PermissionSet.manageThreads


get manageWebhooks(): boolean

Defined in: packages/structures/src/permissions.ts:337

boolean

PermissionSet.manageWebhooks


get mentionEveryone(): boolean

Defined in: packages/structures/src/permissions.ts:277

boolean

PermissionSet.mentionEveryone


get moderateMembers(): boolean

Defined in: packages/structures/src/permissions.ts:403

boolean

PermissionSet.moderateMembers


get moveMembers(): boolean

Defined in: packages/structures/src/permissions.ts:312

boolean

PermissionSet.moveMembers


get muteMembers(): boolean

Defined in: packages/structures/src/permissions.ts:301

boolean

PermissionSet.muteMembers


get pinMessages(): boolean

Defined in: packages/structures/src/permissions.ts:460

boolean

PermissionSet.pinMessages


get prioritySpeaker(): boolean

Defined in: packages/structures/src/permissions.ts:229

boolean

PermissionSet.prioritySpeaker


get readMessageHistory(): boolean

Defined in: packages/structures/src/permissions.ts:271

boolean

PermissionSet.readMessageHistory


get requestToSpeak(): boolean

Defined in: packages/structures/src/permissions.ts:355

boolean

PermissionSet.requestToSpeak


get sendMessages(): boolean

Defined in: packages/structures/src/permissions.ts:243

boolean

PermissionSet.sendMessages


get sendMessagesInThreads(): boolean

Defined in: packages/structures/src/permissions.ts:391

boolean

PermissionSet.sendMessagesInThreads


get sendPolls(): boolean

Defined in: packages/structures/src/permissions.ts:445

boolean

PermissionSet.sendPolls


get sendTTSMessages(): boolean

Defined in: packages/structures/src/permissions.ts:249

boolean

PermissionSet.sendTTSMessages


get sendVoiceMessages(): boolean

Defined in: packages/structures/src/permissions.ts:439

boolean

PermissionSet.sendVoiceMessages


get setVoiceChannelStatus(): boolean

Defined in: packages/structures/src/permissions.ts:454

boolean

PermissionSet.setVoiceChannelStatus


get speak(): boolean

Defined in: packages/structures/src/permissions.ts:298

boolean

PermissionSet.speak


get stream(): boolean

Defined in: packages/structures/src/permissions.ts:235

boolean

PermissionSet.stream


get useApplicationCommands(): boolean

Defined in: packages/structures/src/permissions.ts:349

boolean

PermissionSet.useApplicationCommands


get useEmbeddedActivities(): boolean

Defined in: packages/structures/src/permissions.ts:397

boolean

PermissionSet.useEmbeddedActivities


get useExternalApps(): boolean

Defined in: packages/structures/src/permissions.ts:448

boolean

PermissionSet.useExternalApps


get useExternalEmojis(): boolean

Defined in: packages/structures/src/permissions.ts:283

boolean

PermissionSet.useExternalEmojis


get useExternalSounds(): boolean

Defined in: packages/structures/src/permissions.ts:433

boolean

PermissionSet.useExternalSounds


get useExternalStickers(): boolean

Defined in: packages/structures/src/permissions.ts:385

boolean

PermissionSet.useExternalStickers


get useSoundboard(): boolean

Defined in: packages/structures/src/permissions.ts:415

boolean

PermissionSet.useSoundboard


get useVAD(): boolean

Defined in: packages/structures/src/permissions.ts:317

boolean

PermissionSet.useVAD


get viewAuditLog(): boolean

Defined in: packages/structures/src/permissions.ts:223

boolean

PermissionSet.viewAuditLog


get viewChannel(): boolean

Defined in: packages/structures/src/permissions.ts:238

boolean

PermissionSet.viewChannel


get viewCreatorMonetizationAnalytics(): boolean

Defined in: packages/structures/src/permissions.ts:409

boolean

PermissionSet.viewCreatorMonetizationAnalytics


get viewGuildInsights(): boolean

Defined in: packages/structures/src/permissions.ts:289

boolean

PermissionSet.viewGuildInsights

add(…permissions): PermissionSet

Defined in: packages/structures/src/permissions.ts:509

Returns a new set with permissions added.

…PermissionResolvable[]

Permission names or raw bits.

PermissionSet

A new permission set.

PermissionSet.add


any(…permissions): boolean

Defined in: packages/structures/src/permissions.ts:488

Checks whether any supplied permission is present (OR).

…PermissionResolvable[]

Permission names or raw bits.

boolean

True when at least one requested permission is present.

PermissionSet.any


equals(other): boolean

Defined in: packages/structures/src/permissions.ts:529

Checks equality with another permission set or raw bitfield.

string | number | bigint | PermissionSet

Permission set or raw bitfield.

boolean

True when both values are equal.

PermissionSet.equals


has(…permissions): boolean

Defined in: packages/structures/src/permissions.ts:473

Checks whether all supplied permissions are present (AND).

…PermissionResolvable[]

Permission names or raw bits.

boolean

True when every requested permission is present.

PermissionSet.has


missing(…permissions): PermissionName[]

Defined in: packages/structures/src/permissions.ts:503

Returns the known permission names from permissions that this set lacks.

…PermissionResolvable[]

Permission names or raw bits.

PermissionName[]

PermissionSet.missing


remove(…permissions): PermissionSet

Defined in: packages/structures/src/permissions.ts:519

Returns a new set with permissions removed.

…PermissionResolvable[]

Permission names or raw bits.

PermissionSet

A new permission set.

PermissionSet.remove


toArray(): PermissionName[]

Defined in: packages/structures/src/permissions.ts:544

Returns known permission names contained in this set.

PermissionName[]

Names of all enabled known permissions.

PermissionSet.toArray


toString(): string

Defined in: packages/structures/src/permissions.ts:539

Returns the decimal permission representation.

string

Decimal permission bitfield.

PermissionSet.toString