Home

Home || Documentation || Get Started || Support Server

About

PermissionsJS is a JavaScript library created to manage permissions. You can create users, permissions, and roles. With multiple ways to store data, you can easily choose how to store your data.

Installation

Installation is easy!

$ npm i permissions

I don’t think you needed me for that, though.

Configuration

At the moment you can’t configure anything, but it will come soon!

Usage

For advanced usage please visit our documentation. The following is just for quick reference.

Declaring Permissions Requirement

const permissions = require('permissions');

Adding Permissions

const permissionsToAdd = ["a", "b"];
const permissionsFile = 'permissions.json';
permissions.savePermissions(permissionsToAdd, permissionsFile);

Adding Users

/*
    DO NOT CONFUSE .newUser(); and new User(); THE LATTER WILL CAUSE ERRORS!!
*/
let userID = "7818"; //id MUST be a string!!
let usersFile = './users.json';
let permissions = ["a", "b"]; //in this case a single * permission will work
let roles = []; //roles are coming soon!!
permissions.newUser(userID, usersFile, permissions, roles);

Loading Permissions/Users

/*
    LOADING PERMISSIONS AND USERS IS CRUCIAL
*/
permissions.loadPermissions(permissionsFile);
permissions.loadUsers(usersFile);

Check for Users Permission to Do X

    // make sure users are loaded!!
    can = permissions.hasPermission(userID, 'a')) //returns true