Skip to content

Instantly share code, notes, and snippets.

Created April 6, 2012 17:40
  • Star 53 You must be signed in to star a gist
  • Fork 10 You must be signed in to fork a gist
Star You must be signed in to star a gist
What would you like to do?
Get a nested object property by passing a dot notation string as the property name
* A function to take a string written in dot notation style, and use it to
* find a nested object property inside of an object.
* Useful in a plugin or module that accepts a JSON array of objects, but
* you want to let the user specify where to find various bits of data
* inside of each custom object instead of forcing a standardized
* property list.
* @param String nested A dot notation style parameter reference (ie "urls.small")
* @param Object object (optional) The object to search
* @return the value of the property in question
function getProperty( propertyName, object ) {
var parts = propertyName.split( "." ),
length = parts.length,
property = object || this;
for ( i = 0; i < length; i++ ) {
property = property[parts[i]];
return property;
Copy link

DavChi commented Apr 21, 2020

@mp2468 Based on this, we could use regex to handle both dot notation and bracket notation path.

const getDescendantProp = (obj, path) => {
  const arr = path.split(/[.[]['"]?/);
  let o = obj;
  while (arr.length && o) {
    o = o[arr.shift().replace(/['"]?]$/, '')];
  return o;

Copy link

kissu commented Jan 7, 2021

A functional answer might be (es2015 just because):

const getDescendantProp = (obj, path) => (
    path.split('.').reduce((acc, part) => acc && acc[part], obj)

Damn man, it doesn't even error if the path is not valid (no optional chaining needed), L33T. Thanks ! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment