flagon | tiny utility to make using bitwise operations

flagon is a JavaScript library. flagon has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can install using 'npm i flagon' or download it from GitHub, npm.

A tiny utility to make using bitwise operations readable by mere mortals. Drink up!. Use either a chaining API flag(A).method(B).method(B).value() or access the raw functions via flag.method(A,B). Bitwise operations are very powerful and concise. But exactly because they are so powerful, they are often used in security critical situations. By making the operations more readable it is less likely the developer will unintentionally permit access to restricted data or operations. I developed this utility for validating user and organizations permissions in a REST API. For simpler use cases, you may prefer to stick to using the underlying bitwise operations. This utility is trying to infer the purpose of the operation in the context of your application. It is likely this guess may be incorrect, and if so I'd be happy to alias the function names to anything reasonable. Here is an example where you may be using Binary OR to merge permissions. And you may want to check if a GUEST can MODIFY. And you may want to temporarily grant access to MODIFY to a GUEST user. All of the examples seek to demonstrate that the operations purpose is more important than the underlying binary flags. The flags themselves are uninteresting, but they facilitate expansion of your permission model without altering other aspects of your application (e.g. your DB Schema). Usage: flagon.merge(A,B) or flagon(A).merge(B).value(). Equivalent Operation: A | B. Merges all true flags that share a column in two binary sequences. Usage: flagon.contains(A,B) or flagon(A).contains(B). Equivalent Operation: B == 0 || ((A & B) == B). Does a bit mask contain every true value of another bit mask?. Note contains will automatically unwrap a wrapped value. Usage: flagon.toggle(A,B) or flagon(A).toggle(B).value(). Equivalent Operation: (A ^ B). Flips every bit of the object that has a different true value to the subject. Usage: flagon(A).toString() or flagon(A) + "". Outputs a binary represenation of a number as a string. Note, Javascript has similar functionality by providing a radix to a Number toString. You can still access this functionality via flagon by simply calling toString(2) on the outputted value. Outputs the number value A that was wrapped by calling flagon(A). Useful for extracting the number value after performing a chained operation. Wraps a value so you can call a series of operations. Access the raw value by calling value() or access a binary representation by calling toString(). I don't really like chaining, it doesn't work well with composition. But I added chaining when writing the library to help me get my head around the operations. One benefit of chaining, is it becomes quite clear which argument is the object, and which is the subject. In your actual application code I don't see it being that useful, but I also don't see any need for removing it when the whole script is ~20 lines of code. I didn't need it for my use case, YAGNI. PR's welcome though. In this readme there are often chained equalities e.g.