Skip to content

barbarbar338/perman.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

10 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

stars license supportServer forks issues

Logo

Perman.JS

๐Ÿ”‘ Permission management made easy
Get support ยป

Report Bug ยท Request Feature ยท Webpage

๐Ÿ”‘ Perman

Permission management made easy

๐Ÿ“ฆ Installation

  • Using yarn: yarn add perman
  • Using npm: npm i perman

๐Ÿค“ Usage

import { Perman } from "perman";

const perman = Perman.from(["user", "verified", "admin"]);

const user = perman.serialize(["user"]);
const verified = perman.serialize(["user", "verified"]);
const admin = perman.serialize(["user", "admin"]);

user.has("user"); // true
user.has("admin"); // false;
verified.has("verified"); // true;
verified.has("admin"); // false;
admin.has("admin"); // true;

// add permissions
user.has("verified"); // false;
user = user.add("verified");
user.has("verified"); // true;

// remove permissions
verified.has("verified"); // true;
verified = verified.remove("verified");
verified.has("verified"); // false;

๐Ÿ“„ License

Copyright ยฉ 2022 BarฤฑลŸ DEMฤฐRCฤฐ.

Distributed under the GPL-3.0 License. See LICENSE for more information.

๐Ÿงฆ Contributing

Fell free to use GitHub's features.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/my-feature)
  3. Run prettier (npm run format)
  4. Commit your Changes (git commit -m 'my awesome feature my-feature')
  5. Push to the Branch (git push origin feature/my-feature)
  6. Open a Pull Request

๐Ÿ”ฅ Show your support

Give a โญ๏ธ if this project helped you!

๐Ÿ“ž Contact