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

bin-perm-gen

v1.0.5

Published

Generate binary permutations with customizable formats and filters. Lightweight, zero-dependency, and efficient for handling large inputs using ES6 generators.

Downloads

186

Readme

⚡ Binary Permutations Generator

A fast, zero-dependency generator for creating binary permutations with customizable format and filtering options. The use of ES6 generators allows this package to handle large values of n efficiently. Permutations are generated on-the-fly, ensuring low memory usage and smooth high performance.

🚀 Features

  • Zero dependencies – simple and lightweight.
  • Flexible format options – return results as booleans, numbers, or strings.
  • Efficient ES6 generator for large n – handles big inputs smoothly, yielding permutations one-by-one.
  • Custom filters – control how many true values appear in results.

🛠️ Installation

npm install bin-perm-gen

📖 Usage

import getBinaryPermutations from 'binary-perm-gen';

// Basic usage with default options
const generator = getBinaryPermutations(3);
for (const permutation of generator) {
  console.log(permutation);
}
// Output:
// [ false, false, false ]
// [ false, false, true ]
// [ false, true, false ]
// ...

// Using options
const generatorWithOptions = getBinaryPermutations(4, { format: 'string', minOnes: 2 });
for (const permutation of generatorWithOptions) {
  console.log(permutation);
}
// Output:
// '0011'
// '0101'
// '0110'
// '1001'
// ...

// Convert to array, recommended only for small n parameter
const generatedArray = [...getBinaryPermutations(4)];

Command Line Interface (CLI)

You can also use it via the command line:

npx bin-perm-gen 3
# [
#   [ false, false, false ],
#   [ false, false, true ],
#   [ false, true, false ],
# ...

🔧 API

getBinaryPermutations(n: number, options?: Options): Generator<string | number[] | boolean[]>

Generates all binary permutations for n bits, allowing customization through the options parameter.

  • n (number): The number of bits (must be a non-negative integer).
  • options (optional):
    • format ('boolean' | 'string' | 'number'): The output format. Defaults to 'boolean'.
    • minOnes (number): Minimum number of ones (true values) in the result. Defaults to 0.
    • maxOnes (number): Maximum number of ones (true values) in the result. Defaults to n.