parseUnit

API / publicodes / parseUnit

function parseUnit(string, getUnitKey): Unit

Defined in: packages/core/src/units.ts:23

Experimental

Parse a unit string into a Unit object

Parameters

ParameterTypeDescription
stringstringThe unit string to parse
getUnitKeygetUnitKey(@experimental DO NOT USE): A function to normalize the unit string

Returns

Unit

The parsed unit object

Example

parseUnit('m/s2')
// returns { numerators: ['m'], denominators: ['s', 's'] }