omnibelt/dot-path-or.js

  1. const useWith = require('ramda/src/useWith');
  2. const identity = require('ramda/src/identity');
  3. const pathOr = require('ramda/src/pathOr');
  4. const split = require('ramda/src/split');
  6. /**
  7.  * If the given, non-null object has a value at the given dot-separated path, returns the
  8.  * value at that path. Otherwise returns the provided default value. Path can be composed
  9.  * of any combination of prop names and/or array indices.
  10.  *
  11.  * @see dotPath
  12.  *
  13.  * @signature a -> String -> Object<a> -> a
  14.  *
  15.  * @example
  16.  *   dotPathOr('N/A', 'a.b', { a: { b: 1 } }); // => 1
  17.  *   dotPathOr('N/A', 'invalid.key', { a: 1 }); // => 'N/A'
  18.  *   dotPathOr('N/A', 'a.b.0', { a: { b: [1, 2, 3] } }); // => 1
  19.  *   dotPathOr('N/A', 'a.b.0', { a: { b: 'not an arrray' } }); // => 'N/A'
  20.  */
  21. const dotPathOr = useWith(pathOr, [identity, split('.'), identity]);
  23. module.exports = dotPathOr;