PermissionsUtil

Index

Constructors

• constructor

Properties

• bitfield
• perms
• resolveBitFields
• resolveBitFlags

Accessors

• flags

Methods

• add
• has
• missing
• remove
• toArray
• all
• overwriteFor
• permissionsFor
• resolveBits
• resolveFlags

Constructors

constructor

• new PermissionsUtil(perms?: PermissionsResolvable): PermissionsUtil

• Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable	= ...	Permissions to resolve

  Returns PermissionsUtil

Properties

bitfield

bitfield: bigint

Bitfield of the permissions

readonlyperms

perms: PermissionsResolvable = ...

Permissions to resolve

resolveBitFields

resolveBitFields: (perms: PermissionsResolvable) => bigint = ...

PermissionsUtil.resolveBits but as an instance method. This is me just being lazy really

---

Type declaration

• • (perms: PermissionsResolvable): bigint

  • Parameters

    Name	Type	Default	Description
    perms	PermissionsResolvable

    Returns bigint

resolveBitFlags

resolveBitFlags: (bits: bigint) => (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[] = ...

PermissionsUtil.resolveFlags but as an instance method.

---

Type declaration

• • (bits: bigint): (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

  • Parameters

    Name	Type	Default	Description
    bits	bigint

    Returns (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

Accessors

flags

• get flags(): (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

• Flags of the permissions

  ---

  Returns (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

Methods

add

• add(perms: PermissionsResolvable): PermissionsUtil

• Add the permissions bits

  ---

  Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable

  Returns PermissionsUtil

has

• has(perms: PermissionsResolvable): boolean

• Check if it contains the given permissions

  ---

  Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable

  Returns boolean

missing

• missing(perms: PermissionsResolvable): (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

• Permissions that are missing from the passed permission resolvable

  ---

  Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable

  Returns (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

  The missing permissions

remove

• remove(perms: PermissionsResolvable): PermissionsUtil

• Remove the permissions bits

  ---

  Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable

  Returns PermissionsUtil

toArray

• toArray(): (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

• Returns permissions flags of this bitfield

  ---

  Returns (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

staticall

• all(): PermissionsUtil

• Returns util instance having all permissions

  ---

  Returns PermissionsUtil

staticoverwriteFor

• overwriteFor(userOrRole: APIRole | APIGuildMember, channel: APITextChannel | APIGuildForumChannel | APIGuildVoiceChannel | APIGuildStageVoiceChannel | APINewsChannel, guild: APIGuild): PermissionsUtil

• Get opermissions overwrites for a user or role in a channel including guild level and channel overrides

  ---

  Parameters

  Name	Type	Default	Description
  userOrRole	APIRole | APIGuildMember
  channel	APITextChannel | APIGuildForumChannel | APIGuildVoiceChannel | APIGuildStageVoiceChannel | APINewsChannel
  guild	APIGuild

  Returns PermissionsUtil

staticpermissionsFor

• permissionsFor(memberOrRole: APIRole | APIGuildMember, guild: APIGuild): PermissionsUtil

• Get permissions for a guild member based on their roles

  ---

  Parameters

  Name	Type	Default	Description
  memberOrRole	APIRole | APIGuildMember
  guild	APIGuild

  Returns PermissionsUtil

staticresolveBits

• resolveBits(perms: PermissionsResolvable): bigint

• Resolves given permission resolvable to bitfield

  ---

  Parameters

  Name	Type	Default	Description
  perms	PermissionsResolvable

  Returns bigint

  Returns the resolved bitfield

staticresolveFlags

• resolveFlags(bits: bigint): (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

• ---

  Parameters

  Name	Type	Default	Description
  bits	bigint

  Returns (Administrator | Connect | Speak | AddReactions | AttachFiles | BanMembers | ChangeNickname | CreateInstantInvite | CreatePrivateThreads | CreatePublicThreads | DeafenMembers | EmbedLinks | KickMembers | ManageChannels | ManageEmojisAndStickers | ManageGuildExpressions | ManageEvents | ManageGuild | ManageMessages | ManageNicknames | ManageRoles | ManageThreads | ManageWebhooks | MentionEveryone | ModerateMembers | MoveMembers | MuteMembers | PrioritySpeaker | ReadMessageHistory | RequestToSpeak | SendMessages | SendMessagesInThreads | SendTTSMessages | Stream | UseApplicationCommands | UseEmbeddedActivities | UseExternalEmojis | UseExternalStickers | UseVAD | ViewAuditLog | ViewChannel | ViewGuildInsights | ViewCreatorMonetizationAnalytics | UseSoundboard | CreateGuildExpressions | CreateEvents | UseExternalSounds | SendVoiceMessages | SendPolls | UseExternalApps | PinMessages | BypassSlowmode)[]

  Returns string representation of the permissions