mirror of
https://github.com/josdejong/mathjs.git
synced 2025-12-08 19:46:04 +00:00
34 lines
1002 B
JavaScript
34 lines
1002 B
JavaScript
module.exports = function (math) {
|
|
var util = require('../../util/index.js'),
|
|
string = util.string,
|
|
number = util.number,
|
|
|
|
isNumber = number.isNumber;
|
|
|
|
/**
|
|
* Format a value of any type into a string.
|
|
*
|
|
* Usage:
|
|
* math.format(value)
|
|
* math.format(value, precision)
|
|
*
|
|
* Example usage:
|
|
* math.format(2/7); // '0.2857142857142857'
|
|
* math.format(math.pi, 3); // '3.14'
|
|
* math.format(new Complex(2, 3)); // '2 + 3i'
|
|
*
|
|
* @param {*} value Value to be stringified
|
|
* @param {Number} [precision] Precision to be used to stringify numbers.
|
|
* If not provided, the value will not be rounded.
|
|
* @return {String} str
|
|
*/
|
|
math.format = function format (value, precision) {
|
|
var num = arguments.length;
|
|
if (num !== 1 && num !== 2) {
|
|
throw new util.error.ArgumentsError('format', num, 1, 2);
|
|
}
|
|
|
|
return string.format(value, precision);
|
|
};
|
|
};
|