Permissions & Bitfields
Lunibee provides simple permission checks for everyday bot code while still exposing immutable permission sets when you need more control.
Check a permission
Section titled âCheck a permissionâif (member.permissions.administrator) { console.log("Member is an administrator.");}
if (member.permissions.manageMessages) { console.log("Member can manage messages.");}if (member.permissions.administrator) { console.log("Member is an administrator.");}
if (member.permissions.manageMessages) { console.log("Member can manage messages.");}Check multiple permissions
Section titled âCheck multiple permissionsâUse .has() when all permissions are required:
import { Permission } from "lunibee";
if (member.permissions.has( Permission.kickMembers, Permission.banMembers,)) { console.log("Member can kick and ban.");}import { Permission } from "lunibee";
if (member.permissions.has( Permission.kickMembers, Permission.banMembers,)) { console.log("Member can kick and ban.");}Use .any() when at least one permission is enough:
if (member.permissions.any( Permission.kickMembers, Permission.banMembers,)) { console.log("Member can perform at least one moderation action.");}if (member.permissions.any( Permission.kickMembers, Permission.banMembers,)) { console.log("Member can perform at least one moderation action.");}Build a permission set
Section titled âBuild a permission setâPermissionSet is immutable. Methods return a new set instead of changing the original.
import { PermissionSet, Permission } from "lunibee";
const base = new PermissionSet([ Permission.viewChannel, Permission.sendMessages,]);
const elevated = base.add( Permission.embedLinks, Permission.attachFiles,);
const restricted = elevated.remove(Permission.sendMessages);import { PermissionSet, Permission } from "lunibee";
const base = new PermissionSet([ Permission.viewChannel, Permission.sendMessages,]);
const elevated = base.add( Permission.embedLinks, Permission.attachFiles,);
const restricted = elevated.remove(Permission.sendMessages);Inspect permissions
Section titled âInspect permissionsâconsole.log(elevated.viewChannel); // trueconsole.log(elevated.sendMessages); // trueconsole.log(restricted.sendMessages); // falseconsole.log(elevated.toArray());console.log(elevated.viewChannel); // trueconsole.log(elevated.sendMessages); // trueconsole.log(restricted.sendMessages); // falseconsole.log(elevated.toArray());Permission constants
Section titled âPermission constantsâUse Lunibeeâs Permission constants instead of manually calculating Discord permission bits:
Permission.viewChannelPermission.sendMessagesPermission.manageChannelsPermission.manageMessagesPermission.manageRolesPermission.administratorPermission.viewChannelPermission.sendMessagesPermission.manageChannelsPermission.manageMessagesPermission.manageRolesPermission.administratorThis keeps permission logic readable and avoids duplicating bit-shift calculations throughout your application.
Common permissions
Section titled âCommon permissionsâ| Getter | Meaning |
|---|---|
.viewChannel |
View a channel |
.sendMessages |
Send messages |
.manageMessages |
Manage messages |
.manageChannels |
Manage channels |
.manageRoles |
Manage roles |
.kickMembers |
Kick members |
.banMembers |
Ban members |
.moderateMembers |
Timeout/moderate members |
.connect |
Connect to voice |
.speak |
Speak in voice |
.administrator |
Full administrator permission |
Lunibee exposes the complete Discord permission set through the same camelCase style. Use autocomplete on Permission or member.permissions when you need a less common flag.
Resolving Effective Permissions
Section titled âResolving Effective PermissionsâcomputePermissions() applies Discordâs rules: @everyone and role
permissions, owner and administrator shortcuts, then channel overwrites for
@everyone, the memberâs roles and the member. A member whose timeout
(timedOutUntil) has not ended keeps only View Channel and Read Message History
(owners and administrators are not masked).
import { computePermissions } from "lunibee";
const perms = computePermissions({ guildId, ownerId, memberId, memberRoleIds: member.roleIds, roles: [...guildRoles], overwrites: channel.permissionOverwrites,});perms.has("sendMessages");perms.missing("sendMessages", "embedLinks"); // ["embedLinks"]With the clientâs caches, client.permissionsFor(memberId, channelOrGuildId)
does the lookup for you (a thread uses its parent channelâs overwrites) and
returns null when the guild or member, or a threadâs parent, is not cached.