@eluvio/elv-js-helpers/ModelFactory/defBasicModel.js

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

// noinspection JSValidateTypes
'use strict'
const {BasicModel} = require('objectmodel')

const throwIfUndefined = require('../Validation/throwIfUndefined')

/**
 * Passthrough for `BasicModel()` function from [ObjectModel](http://objectmodel.js.org/)
 * _(Copyright © 2015 Sylvain Pollet-Villard, MIT license)_ with name assignment added.
 *
 * Returns an [ObjectModel](http://objectmodel.js.org/) which will validate that an input is of the specified type(s)
 *
 * @function
 * @category ModelFactory
 * @sig String -> ([Model] | Model) -> (* -> Array | THROW)
 * @param {String} name - the name of the generated Model
 * @param {(Model[] | Model)} def - The type/Model or array of types/Model that are valid for input
 * @returns {Object} Returns an [ObjectModel](http://objectmodel.js.org/) that can be called with an input
 * @example
 *
 * 'use strict'
 * const defBasicModel = require('@eluvio/elv-js-helpers/ModelFactory/defBasicModel')
 *
 * const StringModel = defBasicModel('String', String)
 *
 * StringModel(42)      //=> EXCEPTION: 'expecting String, got Number 42'
 * StringModel('foo')   //=> 'foo'
 *
 */
const defBasicModel = (name, def)=> {
  throwIfUndefined('no basic type supplied', def)
  return BasicModel(def).as(name)
}

module.exports = defBasicModel