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

mkobj

v0.2.0

Published

Make creating of objects with conditional properties easier.

Downloads

1

Readme

mkobj


This JavaScript utility allows you to easily create objects with optional (conditional) properties, as this is not very straightforward in JS.

Installation

Install with npm or Yarn:

npm:

npm install --save mkobj

Yarn:

yarn add mkobj

Usage

The simplest way to write optional property in JS is to use ternary operator:

const obj = {
  foo: true ? 'bar' : 'else',
};

Disadvantage of this approach is that you have to specify else value. But in many cases you don't have, or don't want to provide else (default) property value, because this value is specified somewhere else in your code base, or even doesn't exist. mkobj provides way to write optional properties without providing else value.

// MyReactHeader.js
import React, { PropTypes } from 'react';
import mkobj from 'mkobj';

MyReactHeader.propTypes = {
  text: PropTypes.string.isRequired,
  highlighted: PropTypes.bool,
};

export default function MyReactHeader({ text, highlighted }) {
  return (
    <div
      style={mkobj(
        { color: 'blue', fontSize: 25 },
        [ highlighted, 'fontWeight', 600 ],
      )}
    >
      {text}
    </div>
  );
}

First argument of mkobj is destination object. Object in which optional properties will be copied into. In above example this is style object. The arguments after this destination object are optional properties. Optional property is written as array with three elements:

[condition, propertyName, propertyValue]

You can specify any number of these properties, or even none.

You don't have to provide destination object, mkobj will provide empty object for you:

const obj = mkobj(
  [true, 'foo', 'bar'],
  [false, 'bar', 'foo'],
); // { foo: 'bar' }

All properties with falsy condition values are ignored and not copied into destination object.

You can even use mkobj to create empty object instead of object literal.

const obj = mkobj(); // {}

Properties are copied in order, so you can take advantage of that and overwrite property values with latter ones.

const obj = mkobj(
  [true, 'foo', 'bar1'],
  [true, 'foo', 'bar2'],
); // { foo: 'bar2' }

Also you can use shorthand optional properties where condition value is used as property value.

const test = {
  bar1: 8,
  bar2: '',
};

const obj = mkobj(
  [test.bar1, 'foo1'],
  [test.bar2, 'foo2'],
); // { foo1: 8 }