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

retrieve-object-child

v1.0.1

Published

Retrieves object children

Downloads

2

Readme

retrieve-object-child (NodeJS)

Build Status

Retrieve child objects from an object.

Installation

First get the package from NPM

npm install retrieve-object-child

And now simply require it in your application

var retrieveChild = require('retrieve-object-child');

Api

/**
 * @param  {Object} object
 * @param  {string|array} position - Key or an array containing keys.
 * @param  {boolean} insert - Create the child object if it doesn't exist.
 * @param  {boolean} throwConflicts - Throw an error if there are conflicts.
 * @return {Object|undefined} - The child object or undefined if none was found.
 */
function retrieveChild(object, position, insert, throwConflicts)

Usage

First up is the most basic format of usage of this function with all the default parameters:

object.customNested = {};
object.customNested.deeper = {};

var child = retrieveChild(object, ['customNested', 'deeper']);
child === object.customNested.deeper

It will return undefined when the child does not exist

var child = retrieveChild(object, 'non_existent');
child === undefined

or when there's a conflict

object.customNested = "not an object";

var child = retrieveChild(object, ['customNested', 'deeper']);
child === undefined

insert enabled

Retrieving existing objects works the same way, but when trying to access an unexisting object path, it will build one recursively.

object = {};
var child = retrieveChild(object, ['customNested', 'deeper'], true);
child === object.customNested.deeper

or will override all children when there's a conflict.

object.customNested = "not an object";

var child = retrieveChild(object, ['customNested', 'deeper'], true);
child === object.customNested.deeper

throwConflict enabled

An error will be thrown whenever there's a conflict instead of falling back on the default behavior.

object.customNested = "some primitive type like a string";

try {
  retrieveChild(object, ['customNested', 'deeper'], false, true);
} catch (e) {
  e.message === 'Conflict detected at key customNested on position 0'
  e.key === 'customNested'
  e.index === 0
}

As you can see, you can find out exactly where a conflict has been detected.

Test

grunt test

License

MIT.