@eluvio/elv-js-helpers/build/Model/NumZeroToOneModel.js

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

'use strict'
const defBoundedNumModel = require('../ModelFactory/defBoundedNumModel')

/**
 * An [ObjectModel](http://objectmodel.js.org/) which validates that an input is:
 *
 *  * A [Javascript Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
 *  * Is between zero and one, inclusive
 *
 * If input passes validations, will return the input
 *
 * Throws an exception if passed in an invalid value.
 *
 * @class
 * @category Model
 * @sig * -> Number | THROW
 * @param {*} - The input to validate
 * @returns {Number} The validated input
 * @example
 *
 * 'use strict'
 * const NumZeroToOneModel = require('@eluvio/elv-js-helpers/Model/NumZeroToOneModel')
 *
 * NumZeroToOneModel(0)     //=> 0
 *
 * NumZeroToOneModel(0.5)   //=> 0.5
 *
 * NumZeroToOneModel(1)     //=> 1
 *
 * NumZeroToOneModel(42)    //=> EXCEPTION: 'Value must be >= 0 and <= 1 (got: 42)'
 *
 * NumZeroToOneModel('foo') //=> EXCEPTION: 'expecting Number, got String "foo"'
 *
 */
const NumZeroToOneModel = defBoundedNumModel(
  'NumberZeroToOne',
  0,
  1,
  true,
  true
)

module.exports = NumZeroToOneModel