mathjs/src/function/utils/hasNumericValue.js at develop · SteveJM/mathjs · GitHub

44 lines (42 loc) · 1.55 KB

import { factory } from '../../utils/factory.js'

const name = 'hasNumericValue'

const dependencies = ['typed', 'isNumeric']

export const createHasNumericValue = /* #__PURE__ */ factory(name, dependencies, ({ typed, isNumeric }) => {

/**

* Test whether a value is an numeric value.

* In case of a string, true is returned if the string contains a numeric value.

* Syntax:

* math.hasNumericValue(x)

* Examples:

* math.hasNumericValue(2) // returns true

* math.hasNumericValue('2') // returns true

* math.isNumeric('2') // returns false

* math.hasNumericValue(0) // returns true

* math.hasNumericValue(math.bignumber(500)) // returns true

* math.hasNumericValue(math.fraction(4)) // returns true

* math.hasNumericValue(math.complex('2-4i') // returns false

* math.hasNumericValue([2.3, 'foo', false]) // returns [true, false, true]

* See also:

* isZero, isPositive, isNegative, isInteger, isNumeric

* @param {*} x Value to be tested

* @return {boolean} Returns true when `x` is a `number`, `BigNumber`,

* `Fraction`, `Boolean`, or a `String` containing number. Returns false for other types.

* Throws an error in case of unknown types.

return typed(name, {

string: function (x) {

return x.trim().length > 0 && !isNaN(Number(x))

any: function (x) {

return isNumeric(x)

}

})

Expand file tree