Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.76 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.76 KB

view on npm npm module downloads Build Status Dependency Status js-standard-style

object-get

Access nested property values at any depth with a simple expression.

Example

const objectGet = require('object-get')

const colour = objectGet(mammal, 'fur.appearance.colour')
const text = objectGet(el, 'children[2].children[1].children[1].textContent')

Helps avoid long logical expressions like:

const colour = mammal && mammal.fur && mammal.fur.appearance && mammal.fur.appearance.colour

objectGet(object, expression) ⇒ *

Returns the value at the given property.

Kind: Exported function

Param Type Description
object object the input object
expression string the property accessor expression.

Example

> objectGet({ animal: 'cow' }, 'animal')
'cow'

> objectGet({ animal: { mood: 'lazy' } }, 'animal')
{ mood: 'lazy' }

> objectGet({ animal: { mood: 'lazy' } }, 'animal.mood')
'lazy'

> objectGet({ animal: { mood: 'lazy' } }, 'animal.email')
undefined

© 2015-16 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.