fetch-prop/index.js

A handy utility for defensively extracting props from objects

const Assert = require('assert')
const { AssertionError } = Assert


function fetchProp(obj, prop_or_props, assertType = x => {}) {
  Assert(null != obj && typeof obj === 'object',
    'The "obj" argument must be an object')

  Assert(assertType instanceof Function,
    'The "assertType" argument must be a function')


  const props = Array.isArray(prop_or_props)
    ? prop_or_props
    : [prop_or_props]


  const x = props.reduce((o, prop) => {
    if (!(typeof o === 'object' && prop in o)) {
      throw new MissingPropError(`${propName(props)}`)
    }

    return o[prop]
  }, obj)


  const is_ok = assertType(x)

  if (typeof is_ok === 'boolean' && !is_ok) {
    throw new AssertionError({
      message: `prop ${propName(props)} failed the assertion`
    })
  }


  return x
}


function propName(props) {
  return props.map(p => `"${p}"`).join('.')
}


class MissingPropError extends Error {
  constructor(...args) {
    super(...args)
    this.name = 'MissingPropError'
  }
}


module.exports = { fetchProp, MissingPropError, AssertionError }