FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
mathjs/src/function/string/format.js at develop · hwthwt/mathjs · GitHub
hwthwt
/
mathjs
Public
forked from
josdejong/mathjs
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
mathjs
/
src
/
function
/
string
/
format.js
Copy path
More file actions
More file actions
Latest commit
History
History
History
112 lines (110 loc) · 4.91 KB
Breadcrumbs
mathjs
/
src
/
function
/
string
/
format.js
Copy path
File metadata and controls
112 lines (110 loc) · 4.91 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
import
{
format
as
formatString
}
from
'../../utils/string'
import
{
factory
}
from
'../../utils/factory'
const
name
=
'format'
const
dependencies
=
[
'typed'
]
export
const
createFormat
=
/* #__PURE__ */
factory
(
name
,
dependencies
,
(
{
typed
}
)
=>
{
/**
* Format a value of any type into a string.
*
* Syntax:
*
* math.format(value)
* math.format(value, options)
* math.format(value, precision)
* math.format(value, callback)
*
* Where:
*
* - `value: *`
* The value to be formatted
* - `options: Object`
* An object with formatting options. Available options:
* - `notation: string`
* Number notation. Choose from:
* - 'fixed'
* Always use regular number notation.
* For example '123.40' and '14000000'
* - 'exponential'
* Always use exponential notation.
* For example '1.234e+2' and '1.4e+7'
* - 'engineering'
* Always use engineering notation.
* For example '123.4e+0' and '14.0e+6'
* - 'auto' (default)
* Regular number notation for numbers having an absolute value between
* `lower` and `upper` bounds, and uses exponential notation elsewhere.
* Lower bound is included, upper bound is excluded.
* For example '123.4' and '1.4e7'.
* - `precision: number`
* A number between 0 and 16 to round the digits of the number. In case
* of notations 'exponential', 'engineering', and 'auto', `precision`
* defines the total number of significant digits returned.
* In case of notation 'fixed', `precision` defines the number of
* significant digits after the decimal point.
* `precision` is undefined by default.
* - `lowerExp: number`
* Exponent determining the lower boundary for formatting a value with
* an exponent when `notation='auto`. Default value is `-3`.
* - `upperExp: number`
* Exponent determining the upper boundary for formatting a value with
* an exponent when `notation='auto`. Default value is `5`.
* - `fraction: string`. Available values: 'ratio' (default) or 'decimal'.
* For example `format(fraction(1, 3))` will output '1/3' when 'ratio' is
* configured, and will output `0.(3)` when 'decimal' is configured.
* - `callback: function`
* A custom formatting function, invoked for all numeric elements in `value`,
* for example all elements of a matrix, or the real and imaginary
* parts of a complex number. This callback can be used to override the
* built-in numeric notation with any type of formatting. Function `callback`
* is called with `value` as parameter and must return a string.
*
* When `value` is an Object:
*
* - When the object contains a property `format` being a function, this function
* is invoked as `value.format(options)` and the result is returned.
* - When the object has its own `toString` method, this method is invoked
* and the result is returned.
* - In other cases the function will loop over all object properties and
* return JSON object notation like '{"a": 2, "b": 3}'.
*
* When value is a function:
*
* - When the function has a property `syntax`, it returns this
* syntax description.
* - In other cases, a string `'function'` is returned.
*
* Examples:
*
* math.format(6.4) // returns '6.4'
* math.format(1240000) // returns '1.24e6'
* math.format(1/3) // returns '0.3333333333333333'
* math.format(1/3, 3) // returns '0.333'
* math.format(21385, 2) // returns '21000'
* math.format(12e8, {notation: 'fixed'}) // returns '1200000000'
* math.format(2.3, {notation: 'fixed', precision: 4}) // returns '2.3000'
* math.format(52.8, {notation: 'exponential'}) // returns '5.28e+1'
* math.format(12400,{notation: 'engineering'}) // returns '12.400e+3'
* math.format(2000, {lowerExp: -2, upperExp: 2}) // returns '2e+3'
*
* function formatCurrency(value) {
* // return currency notation with two digits:
* return '$' + value.toFixed(2)
*
* // you could also use math.format inside the callback:
* // return '$' + math.format(value, {notation: 'fixed', precision: 2})
* }
* math
.format([2.1, 3, 0.016], formatCurrency
} // returns '[$2.10, $3.00, $0.02]'
*
* See also:
*
* print
*
*
@param
{
*
} value Value to be stringified
*
@param
{
Object | Function | number
} [options] Formatting options
*
@return
{
string
} The formatted value
*/
return
typed
(
name
,
{
any
:
formatString
,
'any, Object | function | number'
:
formatString
}
)
}
)
Back
|
FazBrowse Home
|
New Git URL