Search value in object by concatened string of keys of nested objects.

searchDepthValue.js

/**
 * Search value in object by concatened string of keys of nested objects.
 *
 * @example
 *
 * Find street name from object:
 *
 * const obj = {
 *   address: {
 *     district: {
 *       street: {
 *         name: 'Gustave Rapin'
 *       }
 *     }
 *   }
 * }
 *
 * Using this search parameter:
 *
 * "address.district.street.nome"
 *
 * @param {object} input - Object on which search will occur.
 * @param {string} search  - Concatenated string of object keys.
 * @param {string} divider - Divider used on 'search' concatenation.
 * @param {*} [defaultValue=null] - What must be return if not found.
 */
function searchDepthValue(
  input,
  search,
  divider = '.',
  defaultValue = null,
) {
  const keys = search.split(divider)
  let result
  let pointer = input

  keys.forEach((key) => {
    if (pointer[key]) {
      result = pointer[key]
      pointer = result
    } else {
      result = defaultValue
    }
  })

  return result
}