A utility class for interacting with Discord server permissions. This is essentially a wrapper around BigInt.

Note: each instance is immutable and can't be changed, add/remove operations etc does not change the current instance but instead returns a new instance with the changes applied

Constructors

Properties

value: bigint
AddReactions: Permissions = ...
Administrator: Permissions = ...
AttachFiles: Permissions = ...
BanMembers: Permissions = ...
ChangeNickname: Permissions = ...
Connect: Permissions = ...
CreateInstantInvite: Permissions = ...
CreatePrivateThreads: Permissions = ...
CreatePublicThreads: Permissions = ...
DeafenMembers: Permissions = ...
EmbedLinks: Permissions = ...
KickMembers: Permissions = ...
ManageChannels: Permissions = ...
ManageEmojisAndStickers: Permissions = ...
ManageEvents: Permissions = ...
ManageGuild: Permissions = ...
ManageMessages: Permissions = ...
ManageNicknames: Permissions = ...
ManageRoles: Permissions = ...
ManageThreads: Permissions = ...
ManageWebhooks: Permissions = ...
MentionEveryone: Permissions = ...
ModerateMembers: Permissions = ...
MoveMembers: Permissions = ...
MuteMembers: Permissions = ...
PrioritySpeaker: Permissions = ...
ReadMessageHistory: Permissions = ...
RequestToSpeak: Permissions = ...
SendMessages: Permissions = ...
SendMessagesInThreads: Permissions = ...
SendTtsMessages: Permissions = ...
Speak: Permissions = ...
Stream: Permissions = ...
UseApplicationCommands: Permissions = ...
UseEmbeddedActivities: Permissions = ...
UseExternalEmojis: Permissions = ...
UseExternalStickers: Permissions = ...
UseVAD: Permissions = ...
ViewAuditLog: Permissions = ...
ViewChannel: Permissions = ...
ViewGuildInsights: Permissions = ...

Accessors

  • get rawAll(): bigint
  • Returns bigint

    All the Discord permissions as a single bit.

Methods

  • Returns a new set of permissions with the provided permissions added on to the current ones

    Parameters

    Returns Permissions

    The resulting permissions.

  • Parameters

    Returns boolean

    True if the current value has all of the given permissions.

  • Parameters

    Returns boolean

    True if the current value has any of the given permissions.

  • Returns a new set of permissions with the provided permissions removed

    Parameters

    Returns Permissions

    The resulting permissions.

  • Returns string[]

    The current permissions value as an array of strings.

  • Returns string

    The string value of the permissions.

  • Returns {
        [key: string]: bigint;
    }

    An object containing all Discord permissions.

    • [key: string]: bigint
  • A static method for resolving permissions from strings, numbers and bigints.

    Parameters

    Returns bigint

    The resolved bits.

Generated using TypeDoc