Manage bitewise flags wisely
Built with ❤️🔥 by @dubisdev
FlaggyJS is a lightweight TypeScript library for managing bitwise flags. Powerful and efficient binary flags managing for permission systems, feature toggles, or any use-case.
// 1. Import the library import { useFlags } from "flaggyjs"; // 2. Define your flags const { flags, FlagsContainer } = useFlags(["AMAZING", "SIMPLE", "BORING"] as const); // 3. Create as many containers as you need const flaggy = new FlagsContainer(); const documentation = new FlagsContainer([flags.SIMPLE, flags.BORING]); // Initialize with flags 🚀 // 4. Start working with fully Typed flags flaggy.addFlag(flags.AMAZING); // Add one flag 🚩 flaggy.addFlags(flags.SIMPLE, flags.BORING); // or many flags at once 🚄 flaggy.removeFlag(flags.BORING); // Flaggy is not boring! 🎉 // 🔒 FlaggyJS is type safe // v Argument of type "Too Long" is not assignable... // Fails type checking documentation.addFlag("Too Long") // ⚠️ Error! => Invalid flag provided // Also on runtime // 5. Evaluate your flags when needed console.log(flaggy.hasFlag(flags.AMAZING)); // true console.log(documentation.hasFlag(flags.SIMPLE)); // true console.log(flaggy.hasFlag(flags.BORING)); // false console.log(flags) // { // AMAZING: "AMAZING", // SIMPLE: "SIMPLE", // BORING: "BORING" // }- 🔒 Type-safe flag management without Enums.
- 🤏 Zero dependencies - No extra packages are used.
- 🧙♂️ Bitwise operations: Efficiently manage flags with bitwise operations under the hood.
- 🔎 Validation: Ensures invalid flags are caught early.
- 💎 Immutable flag definitions: Prevent accidental changes to the flag definitions.
npm install flaggyjs-
hasFlag(flag: FlagId): booleanChecks if a flag is currently set. -
addFlag(flag: FlagId): voidAdds a flag to the current set. -
removeFlag(flag: FlagId): voidRemoves a flag from the current set. -
addFlags(...flags: FlagId[]): voidAdds multiple flags at once.
The package uses Vitest for testing. To run the tests:
bun run testThe package uses tsc for building TypeScript into JavaScript:
bun run build