discord-permission-helper

Discord Permission Helper

This npm package provides a simple implementation for converting and checking Discord permission bitfields.

Installation

npm i discord-permission-helper

Example usage

import { PermissionConverter } from 'discord-permission-helper';

// Create a PermissionConverter instance
const permissionConverter = new PermissionConverter();

// Convert a permission bitfield to an array of permission names
const permissionBitfield = '2199023255552n';
const convertedPermissions = permissionConverter.convertPermission({
  hash: permissionBitfield,
  json: false
});

console.log(convertedPermissions);
// Output: ['VIEW_CREATOR_MONETIZATION_ANALYTICS']

// Check if a specific permission is granted in a bitfield
const hasPermission = permissionConverter.checkPermission('KICK_MEMBERS', permissionBitfield);

console.log(hasPermission);
// Output: false

// Convert permissions to JSON string
const jsonPermissions = permissionConverter.convertPermission({
  hash: permissionBitfield,
  json: true
});

console.log(jsonPermissions);
// Output: '["VIEW_CREATOR_MONETIZATION_ANALYTICS"]'

License

MIT