object-boolean-combinations

Consumes a defaults object with booleans, generates all possible variations of it

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:

npm i object-boolean-combinations

If you need a legacy version which works with require, use version 4.1.0

Quick Take

import { strict as assert } from "assert";
import { combinations } from "object-boolean-combinations";

assert.deepEqual(
  combinations({
    a: true,
    b: false,
    c: true,
  }),
  [
    { a: false, b: false, c: false },
    { a: true, b: false, c: false },
    { a: false, b: true, c: false },
    { a: true, b: true, c: false },
    { a: false, b: false, c: true },
    { a: true, b: false, c: true },
    { a: false, b: true, c: true },
    { a: true, b: true, c: true },
  ]
);
// you get 2^n plain objects in an array

Documentation

Please visit codsen.com for a full description of the API and examples.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License

codsen