npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-permissions

v1.0.0

Published

A simple lightweight and typesafe bitwise permissions library built around enums. Makes it impossible (assuming you have typecheck) to accidentally use the wrong enum when checking permissions. Zero runtime dependencies!

Downloads

1

Readme

ts-permissions

A simple lightweight and typesafe bitwise permissions library built around enums. Makes it impossible (assuming you have typecheck) to accidentally use the wrong enum when checking permissions. Zero runtime dependencies!

// If you use the wrong enum, you'll get a TypeError!
userperms.has(APITokenPermissions.Flags.ListProjects);
//            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//            Argument of type 'ApiTokenPermissions.ListProjects' is not assignable to parameter of type 'UserPermissions'

Installation

npm install --save ts-permissions

Usage

Start by creating an Enum that stores all the flags you want:

enum EUserPermissions {
  Administrator,
  View,
  Edit
};

enum EAPITokenPermissions {
  ListProjects,
  // etc
}

Then import the package and create the updated Permissions class by using the helper function createPermissionsClass:

// you can then create a permissions class using the helper
import { createPermissionsClass } from "ts-permissions";

export const UserPermissions = createPermissionsClass(EUserPermissions);
export const APITokenPermissions = createPermissionsClass(EAPITokenPermissions);

This will create a class that has the Enum stored in a static Flags parameter.

// and now you can create instances like this:
const userperms = UserPermissions.from(0);

// or like this
const userperms = UserPermissions.from([
  UserPermissions.Flags.Administrator
]);

// or with the new keyword
const userperms = new UserPermissions(0);

Lastly, you can use the .has, .add, .remove to check or modify the permissions. Use .toBits() to get the final bigint.

// and you can modify like this:
userperms.add(UserPermissions.Flags.Administrator);
userperms.remove(UserPermissions.Flags.Administrator);

// and you can check for permissions like this
userperms.has(UserPermissions.Flags.Administrator);
userperms.has([UserPermissions.Flags.View, UserPermissions.Flags.Edit]); 

// and if you use the wrong enum, you'll get a typeerror!
userperms.has(APITokenPermissions.Flags.ListProjects);
//            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//            Argument of type 'EApiTokenPermissions.ListProjects' is not assignable to parameter of type 'EUserPermissions'

// then to save the bits into your DB,
userperms.toBits(); // returns bigint