Class Unit

constructor

• new Unit(name?: string, options?: UnitOptions): Unit

  Create a new unit

  Parameters

  • Optionalname: string

    Unit name

  • Optionaloptions: UnitOptions

    Unit options

  Returns Unit

Static ReadonlyUNKNOWN

aliases

• get aliases(): string[]

  Unit aliases

  Returns string[]

  Alias names as array

baseName

• get baseName(): string

  Returns string

definitions

• get definitions(): UnitDefinition[]

  Returns UnitDefinition[]

name

• get name(): string

  Unit name

  Returns string

  Name

• set name(name: string): void

  Parameters

  • name: string

  Returns void

prefixType

• get prefixType(): UnitPrefixType

  Returns UnitPrefixType

convert

• convert<T extends UnitValueType>(value: T, target: string | Unit): T

  Convert a value in the current unit to a target unit

  Type Parameters

  • T extends UnitValueType

  Parameters

  • value: T

    Value to convert

  • target: string | Unit

    Target unit

  Returns T

  Converted unit

createBaseDefinition

• createBaseDefinition(): UnitFunctionDefinition<any, any>

  Get or create a definition from this unit to the base

  Returns UnitFunctionDefinition<any, any>

  Definition to base

createDefinition

• createDefinition(targetUnit: Unit): UnitFunctionDefinition<any, any>

  Parameters

  • targetUnit: Unit

  Returns UnitFunctionDefinition<any, any>

specifier

• specifier(prefix: UnitPrefix): this

  Get the unit specifier

  Parameters

  • prefix: UnitPrefix

    Unit prefix

  Returns this

  Unit with specifier

Staticconvert

• convert<T extends UnitValueType>(
      value: T,
      from: string | Unit,
      to: string | Unit,
  ): T

  Convert a value from a specific unit to a target unit

  Type Parameters

  • T extends UnitValueType

  Parameters

  • value: T

    Value to convert

  • from: string | Unit

    Source unit

  • to: string | Unit

    Target unit

  Returns T

  Converted unit

StaticfindByName

• findByName(name: string, baseName?: string): Unit

  Find a unit by its name

  Parameters

  • name: string

    Unit name

  • OptionalbaseName: string

    Optional base name to specific result

  Returns Unit

  Unit if found

StaticfromJSON

• fromJSON<T extends Unit>(json: any): T

  Get a unit from JSON

  Type Parameters

  • T extends Unit

  Parameters

  • json: any

    JSON object

  Returns T

  Unit if found

StaticregisterUnit

• registerUnit(unit: Unit, override?: boolean): Unit

  Register a new unit

  Parameters

  • unit: Unit

    Unit to register

  • override: boolean = false

    Override an existing unit with the same name

  Returns Unit

  Registered unit