find-namespace-value v1.1.3

Find Namespace Value

Find a value inside an object namespace

example:

const findNamespaceValue = require('find-namespace-value');
const obj = {
    company: {
        name: '1stdibs'
    }
};
const companyName = findNamespaceValue({
    ns: 'company.name',
    parent: obj
});
const companyLocation = findNamespaceValue({
    ns: 'company.location',
    parent: obj,
    fallback: 'New York, NY'
});
const companySecrets = findNamespaceValue({
    ns: 'company.secrets',
    parent: obj
});

console.log(companyName); // => "1stdibs"
console.log(companyLocation); // => "New York, NY"
console.log(companySecrets); // => undefined

By just requiring the module by its name, it will by default give you the transpiled file. If you want to require the es6 version, you must use:

const = findNamespaceValue = require('find-namespace-value/dist/es6');

Keep in mind that that file is not transpiled. If you are not running your code through a transpiler like Babel or Traceur, then this will throw an error in the browser and you should just require the package instead.

testing:

$ npm install
$ npm test

Usage

A single object is passed in as options:

@param {object} options
@param {String} options.ns Period delimited string representing the property to search for (ie. "my.name.space")
@param {Object} [options.parent={}] defaults to the window object as the object to iterate over
@param {*} [options.fallback=undefined] A fallback value if `options.ns` is not found
@param {boolean} [options.clone=false] Clone the returned value if it is an object or an array
@returns {*} Whatever the property value is or whatever is defined in the `options.fallback` param, otherwise `undefined`