Interface: CompoundableUnit<F>
A unit type that can be compounded.
Type parameters
| Name | Type |
|---|---|
F | extends string |
Hierarchy
Unit<F>↳
CompoundableUnit
Implemented by
Properties
family
• Readonly family: F
This unit's family.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:692
name
• Readonly name: string
This unit's name.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:695
scaleFactor
• Readonly scaleFactor: number
The relative linear scale of this unit compared to the standard unit of the same family.
Defined in
src/sdk/math/NumberUnit.ts:743
Methods
canConvert
▸ canConvert(otherUnit): boolean
Checks whether conversions between this unit and another unit are possible.
Parameters
| Name | Type | Description |
|---|---|---|
otherUnit | Unit<string> | The other unit. |
Returns
boolean
Whether conversions between this unit and another unit are possible.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:702
convertFrom
▸ convertFrom(value, fromUnit): number
Converts a value of another unit to this unit.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The value to convert. |
fromUnit | Unit<F> | The unit from which to convert. |
Returns
number
The converted value.
Throws
Error if attempting an invalid conversion.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:720
convertTo
▸ convertTo(value, toUnit): number
Converts a value of this unit to another unit.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The value to convert. |
toUnit | Unit<F> | The unit to which to convert. |
Returns
number
The converted value.
Throws
Error if attempting an invalid conversion.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:711
createNumber
▸ createNumber(value): NumberUnit<F, CompoundableUnit<F>>
Creates a NumberUnit with a specified initial value of this unit type.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The numeric value of the new NumberUnit. |
Returns
NumberUnit<F, CompoundableUnit<F>>
A NumberUnit of this unit type.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:727
equals
▸ equals(other): boolean
Checks whether this unit is equal to another unit. Returns true if and only if the other unit belongs to the same family and has the same name as this unit.
Parameters
| Name | Type | Description |
|---|---|---|
other | Unit<string> | The other unit to which to compare. |
Returns
boolean
Whether this unit is equal to the comparison.
Inherited from
Defined in
src/sdk/math/NumberUnit.ts:735