@eluvio/elv-js-helpers/Boolean/passesObjValCheck.js

A collection of Javascript helper functions used by several Eluvio libraries.

'use strict'
const curry = require('../Functional/curry')
const isObject = require('../Boolean/isObject')

const _objBadVal = require('../Validation/objBadVal')

/**
 * Returns
 * * `true` if the input is an object and all the object's values are valid instances of the specified Model OR **the input is not a Javascript object**
 * * `false` if **the input IS a Javascript object** AND has a value that violates specified Model
 *
 * Intended for use in an [ObjectModel assertion](http://objectmodel.js.org/#doc-assertions).
 *
 * Note that `true` is returned for non-object inputs.
 *
 * If called with fewer than 2 arguments, will return a [partially applied function](https://mostly-adequate.gitbook.io/mostly-adequate-guide/ch04)
 *
 * @function
 * @curried
 * @category Boolean
 * @sig Model -> * -> Boolean
 * @param {Model} valueModel - the Model to check values against
 * @param {*} obj - The item to check
 * @returns {Boolean}
 * @example
 *
 * 'use strict'
 * const passesObjValCheck = require('@eluvio/elv-js-helpers/Boolean/passesObjValCheck')
 *
 * const NonBlankStrModel = require('@eluvio/elv-js-helpers/Model/NonBlankStrModel')
 *
 * passesObjValCheck(NonBlankStrModel, {foo: ' '})   //=> false
 *
 * passesObjValCheck(NonBlankStrModel, {foo: 'bar'}) //=> true
 *
 * // value not a non-blank string:
 * passesObjValCheck(NonBlankStrModel, {foo: 42})    //=> false
 *
 * // test input not an object, check skipped:
 * passesObjValCheck(NonBlankStrModel, 3)            //=> true
 *
 * // function is curried: call with fewer params to obtain a narrower function
 *
 * const allValsNonBlankString = passesObjValCheck(NonBlankStrModel)
 *
 * allValsNonBlankString({foo: ' '})                 //=> false
 *
 * allValsNonBlankString({foo: 'bar'})               //=> true
 *
 * // value not a non-blank string:
 * allValsNonBlankString({foo: 42})                  //=> false
 *
 * // test input not an object, check skipped:
 * allValsNonBlankString(3)                          //=> true
 */
const passesObjValCheck = curry(
  (valueModel, obj) =>
    !(isObject(obj) && _objBadVal(valueModel, obj) !== undefined)
)
module.exports = passesObjValCheck