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

object-reference

v0.0.4

Published

Resolves objects with values referencing other paths in the same object.

Downloads

92

Readme

CircleCI NPM NPM License Issues

Object reference allows you to build objects that reference themselves.

Get Started

npm install --save object-reference
const resolve = require('object-reference')

const theme = {
  colors: {
    black: '#424242',
    white: '#FFF'
  },
  background: '$.colors.white',
  foreground: '$.colors.black',
  margins: {
    page: '30px'
  }
}

const processedTheme = resolve(theme)
console.log(processedTheme)

// {
//   colors: {
//     black: '#424242',
//     white: '#FFF'
//   },
//   background: '#FFF',
//   foreground: '#424242',
//   margins: {
//     page: '30px'
//   }
// }

Features

  • Uses _.get() from Lodash under the hood.
  • Detects circular references and throws a detailed error message explaining the situation.
  • Resolves nested references (references that reference other references).

Why use this?

I've found the perfect use-case to be defining configuration in a single object, with common variables like colors or sizes at the top of the configuration file, and then specific overrides underneath that reference the variables by default.

This allows the user to have the simplicity of changing a few variables at the top of the document to make a sweeping impact, or getting fine-grained and changing small values toward the bottom of the document.