@philiprehberger/bit-flags

Type-safe bitwise flag operations for permissions, features, and options.

Installation

npm install @philiprehberger/bit-flags

Usage

import { defineFlags } from '@philiprehberger/bit-flags';

const permissions = defineFlags({
  read: 1,
  write: 2,
  execute: 4,
});

let flags = permissions.set(0, 'read', 'write'); // 3
permissions.has(flags, 'read'); // true
permissions.has(flags, 'execute'); // false

flags = permissions.toggle(flags, 'execute'); // 7
permissions.toArray(flags); // ['read', 'write', 'execute']

API

defineFlags<F>(definition: F): FlagSet<F>

Creates a type-safe flag set from a record of flag names to bit values.

FlagSet<F>

• has(flags, flag) — Check if a flag is set
• set(flags, ...flagNames) — Set one or more flags
• unset(flags, ...flagNames) — Unset one or more flags
• toggle(flags, flag) — Toggle a flag on/off
• toArray(flags) — Get active flag names as an array
• fromArray(flagNames) — Combine flag names into a number
• all — All flags combined
• none — Zero value

Development

npm install
npm run build
npm test

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT