type-enforcer/src/checks/isNumber.js

Type enforcement library for javascript

import { isNumber } from 'lodash';
import { buildCheckWithCoerce } from './checks';

/**
 * Check if a value is a [number]{@link https://lodash.com/docs/#isNumber}
 *
 * @example
 * ``` javascript
 * import { isNumber } from 'type-enforcer';
 *
 * isNumber(3.14159);
 * // => true
 *
 * isNumber('3.14159');
 * // => false
 *
 * isNumber('3.14159', true);
 * // => true
 * ```
 *
 * @function isNumber
 *
 * @arg {*} value
 * @arg {Boolean} [coerce=false] - If true then see if the value can be coerced into a Number
 *
 * @returns {Boolean}
 */
export default buildCheckWithCoerce(isNumber, (value) => !isNaN(value));