getProperty

Safely get a nested property value.

Usage

import { getProperty } from 'js-cool'

Signature

function getProperty(obj: any, path: string, defaultValue?: any): any

Parameters

Parameter	Type	Description
obj	any	Source object
path	string	Property path (e.g. 'a.b.c')
defaultValue	any	Default if not found

Returns

any - The property value or default.

Examples

const obj = { a: { b: { c: 1 } } }

getProperty(obj, 'a.b.c') // 1
getProperty(obj, 'a.b.d', 'default') // 'default'
getProperty(obj, 'x.y.z') // undefined

Related

• setProperty - Set nested property