Skip to main content

Interface: Unit<F>

Defined in: src/sdk/math/NumberUnit.ts:691

A unit of measurement.

Extended by

Type Parameters

Type Parameter
F extends string

Properties

family

readonly family: F

Defined in: src/sdk/math/NumberUnit.ts:693

This unit's family.


name

readonly name: string

Defined in: src/sdk/math/NumberUnit.ts:696

This unit's name.

Methods

canConvert()

canConvert(otherUnit): boolean

Defined in: src/sdk/math/NumberUnit.ts:703

Checks whether conversions between this unit and another unit are possible.

Parameters

ParameterTypeDescription
otherUnitUnit<string>The other unit.

Returns

boolean

Whether conversions between this unit and another unit are possible.


convertFrom()

convertFrom(value, fromUnit): number

Defined in: src/sdk/math/NumberUnit.ts:721

Converts a value of another unit to this unit.

Parameters

ParameterTypeDescription
valuenumberThe value to convert.
fromUnitUnit<F>The unit from which to convert.

Returns

number

The converted value.

Throws

Error if attempting an invalid conversion.


convertTo()

convertTo(value, toUnit): number

Defined in: src/sdk/math/NumberUnit.ts:712

Converts a value of this unit to another unit.

Parameters

ParameterTypeDescription
valuenumberThe value to convert.
toUnitUnit<F>The unit to which to convert.

Returns

number

The converted value.

Throws

Error if attempting an invalid conversion.


createNumber()

createNumber(value): NumberUnit<F, Unit<F>>

Defined in: src/sdk/math/NumberUnit.ts:728

Creates a NumberUnit with a specified initial value of this unit type.

Parameters

ParameterTypeDescription
valuenumberThe numeric value of the new NumberUnit.

Returns

NumberUnit<F, Unit<F>>

A NumberUnit of this unit type.


equals()

equals(other): boolean

Defined in: src/sdk/math/NumberUnit.ts:736

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

ParameterTypeDescription
otherUnit<string>The other unit to which to compare.

Returns

boolean

Whether this unit is equal to the comparison.