Class TimeUnit

constructor

• new TimeUnit(name?, options?): TimeUnit

• Create a new unit

  Parameters

  • Optional name: string

    Unit name
  • Optional options: UnitOptions

    Unit options

  Returns TimeUnit

Static Readonly UNKNOWN

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): void

• Parameters

  • name: string

  Returns void

prefixType

• get prefixType(): UnitPrefixType

• Returns UnitPrefixType

convert

• convert<T>(value, target): 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): UnitFunctionDefinition<any, any>

• Parameters

  • targetUnit: Unit

  Returns UnitFunctionDefinition<any, any>

specifier

• specifier(prefix): this

• Get the unit specifier

  Parameters

  • prefix: UnitPrefix

    Unit prefix

  Returns this

  Unit with specifier

Static convert

• convert<T>(value, from, to): 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

Static findByName

• findByName(name, baseName?): Unit

• Find a unit by its name

  Parameters

  • name: string

    Unit name
  • Optional baseName: string

    Optional base name to specific result

  Returns Unit

  Unit if found

Static fromJSON

• fromJSON<T>(json): T

• Get a unit from JSON

  Type Parameters

  • T extends Unit

  Parameters

  • json: any

    JSON object

  Returns T

  Unit if found

Static registerUnit

• registerUnit(unit, override?): 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