Enode — API Reference
Preparing search index...
core/src/use-units
Units
Type Alias Units
type
Units
=
{
format
:
(
value
:
number
,
dimension
:
string
|
null
|
undefined
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedMeasurement
;
formatLoad
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedLoad
;
formatMetric
:
(
value
:
number
,
metric
:
MetricReturnDto
|
null
|
undefined
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedMeasurement
;
fromDisplay
:
(
displayValue
:
number
,
dimension
:
string
|
null
|
undefined
,
)
=>
number
;
name
:
(
dimension
:
string
|
null
|
undefined
)
=>
string
|
null
;
parseLoad
:
(
raw
:
string
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
)
=>
number
|
null
;
roundLoadToBar
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
)
=>
number
;
symbol
:
(
dimension
:
string
|
null
|
undefined
)
=>
string
|
null
;
system
:
UnitSystem
;
toDisplay
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
,
)
=>
number
;
}
Index
Properties
format
format
Load
format
Metric
from
Display
name
parse
Load
round
Load
To
Bar
symbol
system
to
Display
Properties
format
format
:
(
value
:
number
,
dimension
:
string
|
null
|
undefined
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedMeasurement
format
Load
formatLoad
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedLoad
format
Metric
formatMetric
:
(
value
:
number
,
metric
:
MetricReturnDto
|
null
|
undefined
,
options
?:
Omit
<
FormatOptions
,
"system"
>
,
)
=>
FormattedMeasurement
from
Display
fromDisplay
:
(
displayValue
:
number
,
dimension
:
string
|
null
|
undefined
,
)
=>
number
name
name
:
(
dimension
:
string
|
null
|
undefined
)
=>
string
|
null
parse
Load
parseLoad
:
(
raw
:
string
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
)
=>
number
|
null
round
Load
To
Bar
roundLoadToBar
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
,
ctx
:
LoadContextShape
,
)
=>
number
symbol
symbol
:
(
dimension
:
string
|
null
|
undefined
)
=>
string
|
null
system
system
:
UnitSystem
to
Display
toDisplay
:
(
storedValue
:
number
,
dimension
:
string
|
null
|
undefined
)
=>
number
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
format
format
Load
format
Metric
from
Display
name
parse
Load
round
Load
To
Bar
symbol
system
to
Display
Enode — API Reference
Loading...