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-auger

v1.0.1

Published

Safely get or set values in nested objects and arrays.

Downloads

9

Readme

Object Auger

Build Status Current npm package version

Safely get or set values in nested objects and arrays.

Installation

npm install --save object-auger

Usage

See the tests for more examples. Passing

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

let haystack = {};

haystack = auger.set(haystack, ['a', 'b', 'c', 0], 'needle');
// => { a: { b: { c: ['needle'] } } }

auger.has(haystack, ['a', 'b', 'c']);
// => true

auger.get(haystack, ['a', 'b', 'c', 0]);
// => 'needle'

auger.get(haystack, ['a', 'b', 'c', 1], 'no needle here');
// => 'no needle here'

auger.has(object, path)

Safely check if a value exists in an object. Returns a boolean.

object

Type: object or array

Object to look for a value in.

path

Type: array

Path to the value.

auger.get(object, path, defaultValue)

Safely retrieve a value from an object. Returns the retrieved value or the defaultValue if the it cannot be found.

object

Type: object or array

Object to retrieve a value from.

path

Type: array

Path to the value.

default

Type: any Default: undefined

Default value. (Optional)

auger.set(object, path, value)

Safely set a value in an object. Returns the new object.

object

Type: object or array

Object to set a value in.

path

Type: array

Path to where the value will be set.

value

Type: any

Value to set at the path.

Why?

There are tons of other libraries that have similar functionality (notably dot-prop and lodash). While these packages are great, they can cause confusion when working with arrays in a nested object.

Trying to set an object with a number as the key in lodash will result in an array:

const _ = require('lodash');

_.set({}, ['a', '0'], 'b');
// => { a: [ 'b' ] }
// Expected => { a: { '0': 'b' } }

_.set({}, ['a', 0], 'b');
// => { a: [ 'b' ] }
// Expected => { a: [ 'b' ] }

Using the same dot path syntax with lodash and dot-prop will result in different outcomes:

const _ = require('lodash');
const dotProp = require('dot-prop');

_.set({}, 'a.0', 'b');
// => { a: [ 'b' ] }

dotProp.set({}, 'a.0', 'b');
// => { a: { '0': 'b' } }

With the dot path syntax, it's hard to tell if you're working with an array index number or an object property key. Dot path also makes it difficult to dynamically build up the path.

With object-auger, you can set the value and know exactly what the outcome will be:

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

auger.set({}, ['a', '0'], 'b');
// => { a: { '0': 'b' } }

auger.set({}, ['a', 0], 'b');
// => { a: [ 'b' ] }

License

This project is licensed under the MIT License - see the LICENSE file for details