Class AccelerationUnit
Hierarchy-Diagram
Legend
class
Hierarchy
- DerivedUnit
- AccelerationUnit
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Acceleration Unit(name?: string, options?: UnitOptions): AccelerationUnit -
Parameters
-
Optionalname: stringUnit name
-
Optionaloptions: UnitOptionsUnit options
Returns AccelerationUnit
-
Properties
Static Readonly GRAVITATIONAL_
Static Readonly METER_
Static Protected Readonly UNITS
Static Protected Readonly UNIT_
UNIT_
Static Readonly UNKNOWN
Accessors
aliases
- get aliases(): string[]
-
Unit aliases
Returns
Alias names as array
Returns string[]
base
- get baseName(): string
-
Returns string
definitions
- get definitions(): UnitDefinition[]
-
Returns UnitDefinition[]
name
- get name(): string
-
Unit name
Returns
Name
Returns string
- set name(name: string): void
-
Parameters
-
name: string
Returns void
-
prefix
- get prefixType(): UnitPrefixType
-
Returns UnitPrefixType
Protected prefixes
- get prefixes(): UnitPrefix[]
-
Returns UnitPrefix[]
Methods
add
- add
Unit(unit: Unit, power: number): DerivedUnit -
Parameters
-
unit: Unit
-
power: number
Returns DerivedUnit
-
convert
- convert<T>(value: T, target: string | Unit): T
-
Convert a value in the current unit to a target unit
Returns
Converted unit
Type Parameters
-
T extends UnitValueType
Parameters
-
value: T
Value to convert
-
target: string | Unit
Target unit
Returns T
-
create
- create
Base Definition(): UnitFunctionDefinition<any, any> -
Get or create a definition from this unit to the base
Returns
Definition to base
Returns UnitFunctionDefinition<any, any>
create
- create
Definition(targetUnit: Unit): UnitFunctionDefinition<any, any> -
Parameters
-
targetUnit: Unit
Returns UnitFunctionDefinition<any, any>
-
Protected find
specifier
- specifier(prefix: UnitPrefix): AccelerationUnit
-
Get the unit specifier
Returns
Unit with specifier
Parameters
-
prefix: UnitPrefix
Unit prefix
Returns AccelerationUnit
-
swap
- swap(subunits: Unit[], options?: UnitOptions): DerivedUnit
-
Parameters
-
subunits: Unit[]
-
Optionaloptions: UnitOptions
Returns DerivedUnit
-
Static convert
- convert<T>(value: T, from: string | Unit, to: string | Unit): T
-
Convert a value from a specific unit to a target unit
Returns
Converted unit
Type Parameters
-
T extends UnitValueType
Returns T
-
Static find
Static fromJSON
- fromJSON<T>(json: any): T
-
Get a unit from JSON
Returns
Unit if found
Type Parameters
-
T extends Unit<T>
Parameters
-
json: any
JSON object
Returns T
-
Create a new unit