Class Distance

Readonlymeters

km

• get km(): number

  Returns number

miles

• get miles(): number

  Returns number

format

• format(unit: DistanceUnit, decimals?: number): string

  Display string with unit label, e.g. "12.34 mi".

  Parameters

  • unit: DistanceUnit
  • decimals: number = 2

  Returns string

in

• in(unit: DistanceUnit): number

  Numeric value in the chosen unit — the dynamic-unit peer of .km / .miles (for when the unit is a runtime preference).

  Parameters

  • unit: DistanceUnit

  Returns number

Statickm

• km(km: number): Distance

  Parameters

  • km: number

  Returns Distance

Staticmeters

• meters(m: number): Distance

  Parameters

  • m: number

  Returns Distance

Staticmiles

• miles(mi: number): Distance

  Parameters

  • mi: number

  Returns Distance