@eluvio/elv-js-helpers/Model/PositiveFracStrModel.js

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

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

/**
 * An [ObjectModel](http://objectmodel.js.org/) which validates that an input is:
 *
 *  * A [Javascript String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
 *  * Is in the form 'x' or 'x/y' where x and y are positive integers
 *
 * If input passes validations, will return the input
 *
 * Throws an exception if passed in an invalid value.
 *
 * @class
 * @category Model
 * @sig * -> * | THROW
 * @param {*} - The input to validate
 * @returns {Number} The validated input
 * @example
 *
 * 'use strict'
 * const PositiveFracStrModel = require('@eluvio/elv-js-helpers/Model/PositiveFracStrModel')
 *
 * PositiveFracStrModel('42')    //=> '42'
 *
 * PositiveFracStrModel('0')     //=> EXCEPTION: 'Value must be > 0 (got: "0")'
 *
 * PositiveFracStrModel('42/2')  //=> '42/2'
 *
 * PositiveFracStrModel('foo')   //=> EXCEPTION: 'Value must be a string in the form of a whole number or a fraction (got: "foo")'
 *
 */
const PositiveFracStrModel = defBoundedFracStrModel(
  'PositiveFractionString',
  '0',
  null,
  false,
  null
)

module.exports = PositiveFracStrModel