Interstellar Tools

Appearance

Documentation / @interstellar-tools/equations / normalizeDistanceUnit

Function: normalizeDistanceUnit() ​

ts
function normalizeDistanceUnit(u: string): DistanceUnitType;

Defined in: helpers/normalize-distance-unit.ts:94

Normalize a distance unit string into a canonical DistanceUnitType.

  • Trims surrounding whitespace.
  • Accepts canonical symbols ('km', 'au', 'ly', 'kpc', ...) and aliases ('AU', 'kilometres', 'light-years', 'parsecs', ...), using NORMALIZE_DISTANCE_UNIT as the single source of truth.
  • Case-sensitive: 'Parsecs' is rejected; use 'parsecs' or 'pc'.

Parameters ​

ParameterTypeDescription
ustringThe input unit string. Leading/trailing whitespace is ignored.

Returns ​

DistanceUnitType

The canonical DistanceUnitType.

Throws ​

If u is not a known unit or alias.

Example ​

ts
normalizeDistanceUnit('AU'); // 'au'
normalizeDistanceUnit(' light-years '); // 'ly'
normalizeDistanceUnit('kiloparsecs'); // 'kpc'
normalizeDistanceUnit('Mpc'); // 'Mpc' (already canonical)