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

detonate-object

v0.1.2

Published

Generate object copies combinatorially

Downloads

3

Readme

detonate-object

Build Status

Generates objects from an object with $each declarations in a combinatorial manner.

Has nothing to do with destroying objects.

Not particularly fast, but aims to be correct and unsurprising. Comparable to a naïve implementation with an incrementing variation offset.

Relies on language features available in Node from v6 on.

Install

$ yarn add detonate-object
# or
$ npm install --save detonate-object

Usage

const detonate = require('detonate-object');

// We return an iterator from detonate. If you want an array, pass it to `Array.from`.
const iter = detonate({
  $each: [{
    browserName: 'safari',
    platform: 'macOS',
    version: {$each: [10, 11]}
  }, {
    browserName: {$each: ['firefox', 'chrome']},
    version: {$each: ['latest', 'latest-1']}
  }],
  platform: {$each: ['linux', 'macOS', 'windows']},
  build: 14
});

for (const obj of iter) {
  // loops over the following objects, in no particular order:
  { platform: 'linux',   browserName: 'chrome',  version: 'latest',   build: 14}
  { platform: 'linux',   browserName: 'chrome',  version: 'latest-1', build: 14}
  { platform: 'linux',   browserName: 'firefox', version: 'latest',   build: 14}
  { platform: 'linux',   browserName: 'firefox', version: 'latest-1', build: 14}
  { platform: 'macOS',   browserName: 'chrome',  version: 'latest',   build: 14}
  { platform: 'macOS',   browserName: 'chrome',  version: 'latest-1', build: 14}
  { platform: 'macOS',   browserName: 'firefox', version: 'latest',   build: 14}
  { platform: 'macOS',   browserName: 'firefox', version: 'latest-1', build: 14}
  { platform: 'macOS',   browserName: 'safari',  version: 10,         build: 14}
  { platform: 'macOS',   browserName: 'safari',  version: 11,         build: 14}
  { platform: 'windows', browserName: 'chrome',  version: 'latest',   build: 14}
  { platform: 'windows', browserName: 'chrome',  version: 'latest-1', build: 14}
  { platform: 'windows', browserName: 'firefox', version: 'latest',   build: 14}
  { platform: 'windows', browserName: 'firefox', version: 'latest-1', build: 14}
}

Merge conflicts

detonate-object does guarantees that fields will be taken first from a top-level $each declaration, and then from the body.

detonate({
  {$each: [{name: 'abc'}]},
  name: 'def'
});
// From the above, detonate-object will only produce this:
// {name: 'abc'}
// It will not produce this:
// {name: 'def'}

Custom iterables

We can also use custom iterables:

function* generator() {
  yield 'hello';
  yield 'world';
}

const iterable = {
  [Symbol.iterator]() {
    return generator();
  }
};

Array.from(detonate({
  msg: {$each: iterable},
  extra: 'data'
}));
// => [
//   {msg: 'hello', extra: 'data'},
//   {msg: 'world', extra: 'data'}
// ]