@itwin/core-quantity 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/cjs/Formatter/FormatEnums.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormatEnums.js","sourceRoot":"","sources":["../../../src/Formatter/FormatEnums.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA6D;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,eAAe,GAAG,8JAA8J,CAAC;AAE9L,gBAAgB;AAChB,QAAe,CAAC,CAAC,4BAA4B,CAAC,YAAoB;IAChE,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,uBAAe,CAAC,CAAC;IAClD,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,mCAAmC;QACpE,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;YAC5B,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;;YAEpC,MAAM;QACR,KAAK,IAAI,CAAC,CAAC;KACZ;AACH,CAAC;AAXD,oEAWC;AACD,YAAY;AACZ,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,iEAAmB,CAAA;IACnB,mDAAmD;IACnD,6DAAiB,CAAA;IACjB,6FAA6F;IAC7F,mEAAoB,CAAA;IACpB,iDAAiD;IACjD,yDAAe,CAAA;IACf,iEAAiE;IACjE,uEAAsB,CAAA;IACtB,kDAAkD;IAClD,kEAAoB,CAAA;IACpB,2DAA2D;IAC3D,gEAAmB,CAAA;IACnB,uCAAuC;IACvC,kEAAoB,CAAA;IACpB,4CAA4C;IAC5C,yEAAuB,CAAA;IACvB,6CAA6C;IAC7C,yEAAwB,CAAA;IACxB,8IAA8I;IAC9I,iFAA4B,CAAA;AAC9B,CAAC,EAtBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAsBvB;AAED;WACW;AACX,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,+DAAS,CAAA;IACT,oEAAY,CAAA;IACZ,wEAAc,CAAA;IACd,wEAAc,CAAA;IACd,iGAA2B,CAAA;IAC3B,2FAAwB,CAAA;AAC1B,CAAC,EAVW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAU9B;AAED;WACW;AACX,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,sDAAQ,CAAA;IACR,4DAAW,CAAA;IACX,4DAAW,CAAA;AACb,CAAC,EAdW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAc3B;AAED;YACY;AACZ,IAAY,UASX;AATD,WAAY,UAAU;IACpB,iCAAiC;IACjC,iDAAO,CAAA;IACP,oCAAoC;IACpC,uDAAU,CAAA;IACV,sCAAsC;IACtC,uDAAU,CAAA;IACV,8CAA8C;IAC9C,iDAAO,CAAA;AACT,CAAC,EATW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QASrB;AAED;WACW;AACX,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yDAAyD;IACzD,+DAAU,CAAA;IACV,sDAAsD;IACtD,uEAAc,CAAA;AAChB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED;WACW;AACX,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uDAAuD;IACvD,uDAAM,CAAA;IACN,mDAAmD;IACnD,mEAAY,CAAA;IACZ,oEAAoE;IACpE,+DAAU,CAAA;IACV,2IAA2I;IAC3I,iFAAmB,CAAA;AACrB,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAED,6BAA6B;AAE7B,eAAe;AAEf,SAAgB,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,cAAc,CAAC,cAAc,CAAC;QAC5D;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;KAC9H;AACH,CAAC;AAPD,kDAOC;AAED,eAAe;AACf,SAAgB,sBAAsB,CAAC,cAA8B;IACnE,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC1F,CAAC;AAFD,wDAEC;AAED,eAAe;AACf,SAAgB,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC;QAC5C,KAAK,cAAc,CAAC,CAAC,OAAO,cAAc,CAAC,YAAY,CAAC;QACxD,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,qBAAqB,CAAC,CAAC,OAAO,cAAc,CAAC,mBAAmB,CAAC;QACtE;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;KAC9H;AACH,CAAC;AATD,kDASC;AAED,cAAc;AACd,SAAgB,sBAAsB,CAAC,QAAwB;IAC7D,QAAQ,QAAQ,EAAE;QAChB,KAAK,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,qBAAqB,CAAC;QACtE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;QAC5C,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC;QACxD,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACrD;AACH,CAAC;AAPD,wDAOC;AAED,cAAc;AACd,SAAgB,gBAAgB,CAAC,kBAA0B,EAAE,UAAkB;IAC7E,QAAQ,kBAAkB,CAAC,WAAW,EAAE,EAAE;QACxC,KAAK,aAAa,CAAC,CAAC,OAAO,YAAY,CAAC,WAAW,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC;QAC1D,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC;QAChD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,cAAc,CAAC,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC;QACtD,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,sBAAsB,CAAC,CAAC,OAAO,YAAY,CAAC,oBAAoB,CAAC;QACtE;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,2CAA2C,CAAC,CAAC;KAC5H;AACH,CAAC;AAfD,4CAeC;AAED,YAAY;AACZ,SAAgB,cAAc,CAAC,KAAmB;IAChD,QAAQ,KAAK,EAAE;QACb,KAAK,YAAY,CAAC,WAAW;YAC3B,OAAO,aAAa,CAAC;QACvB,KAAK,YAAY,CAAC,cAAc;YAC9B,OAAO,gBAAgB,CAAC;QAC1B,KAAK,YAAY,CAAC,SAAS;YACzB,OAAO,WAAW,CAAC;QACrB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,YAAY;YAC5B,OAAO,cAAc,CAAC;QACxB,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,oBAAoB,CAAC;QACvC;YACE,OAAO,sBAAsB,CAAC;KACjC;AACH,CAAC;AAxBD,wCAwBC;AAED,cAAc;AACd,SAAgB,mBAAmB,CAAC,kBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,EAAU,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC,WAAW;QAC9E,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,KAAK,YAAY,CAAC,cAAc;QACpF,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACzC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,SAAS;QAC1E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC,YAAY;QAChF,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,YAAY,CAAC,oBAAoB;QAChG,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/C,OAAO,eAAe,CAAC;AACzB,CAAC;AAvBD,kDAuBC;AAED,gBAAgB;AAChB,SAAgB,eAAe,CAAC,WAAmB,EAAE,UAAkB;IACrE,QAAQ,WAAW,CAAC,WAAW,EAAE,EAAE;QACjC,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,mCAAmC,CAAC,CAAC;KACpH;AACH,CAAC;AATD,0CASC;AAED,eAAe;AACf,SAAgB,kBAAkB,CAAC,IAAgB;IACjD,QAAQ,IAAI,EAAE;QACZ,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACjD;AACH,CAAC;AAPD,gDAOC;AAED,gBAAgB;AAChB,SAAgB,qBAAqB,CAAC,gBAAwB,EAAE,UAAkB;IAChF,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAlBD,sDAkBC;AAED,4HAA4H;AAC5H,SAAgB,wBAAwB,CAAC,gBAAwB,EAAE,UAAkB;IACnF,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC;QACzC,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,qBAAqB,CAAC;QAC3D,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,kBAAkB,CAAC;QACxD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAdD,4DAcC;AAED,iJAAiJ;AACjJ,SAAgB,cAAc,CAAC,SAAiB,EAAE,IAAgB,EAAE,UAAkB;IACpF,QAAQ,IAAI,EAAE,EAAE,2DAA2D;QACzE,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,UAAU,CAAC,OAAO;YACrB,OAAO,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtD,KAAK,UAAU,CAAC,UAAU;YACxB,OAAO,wBAAwB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACzD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAXD,wCAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Quantity\r\n */\r\n\r\nimport { QuantityError, QuantityStatus } from \"../Exception\";\r\n\r\n/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)\r\n * provided in serialized formats as well as the full name of an [[OverrideFormat]].\r\n *\r\n * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`\r\n *\r\n * Explanation of the regex:\r\n * - ([\\w.:]+)\r\n *   - Grabs the format full name\r\n * - (\\(([^\\)]+)\\))?\r\n *   - Grabs the precision part with and without the `()`.\r\n *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)\r\n * - (\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?\r\n *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`\r\n *   - Grabs the unit name and label including the `[]`\r\n *   - Grabs the unit name, `|` and label separately\r\n * @internal\r\n */\r\nexport const formatStringRgx = /([\\w.:]+)(\\(([^\\)]+)\\))?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?/;\r\n\r\n/** @internal */\r\nexport function* getItemNamesFromFormatString(formatString: string): Iterable<string> {\r\n  const match = formatString.split(formatStringRgx);\r\n  yield match[1]; // the Format Name\r\n  let index = 4;\r\n  while (index < match.length - 1) { // index 0 and 21 are empty strings\r\n    if (match[index] !== undefined)\r\n      yield match[index + 1]; // Unit Name\r\n    else\r\n      break;\r\n    index += 4;\r\n  }\r\n}\r\n/** @beta */\r\nexport enum FormatTraits {\r\n  Uninitialized = 0x0,\r\n  /** Show trailing zeroes to requested precision. */\r\n  TrailZeroes = 0x1,\r\n  /** Indicates that the fractional part of the number is required when the fraction is zero */\r\n  KeepSingleZero = 0x2,\r\n  /** Zero magnitude returns blank display value */\r\n  ZeroEmpty = 0x4,\r\n  /** Show decimal point when value to right of decimal is empty */\r\n  KeepDecimalPoint = 0x8,\r\n  /** Use the rounding factor. Not yet supported  */\r\n  ApplyRounding = 0x10,\r\n  /** Show a dash between whole value and fractional value */\r\n  FractionDash = 0x20,\r\n  /** Append the quantity's unit label */\r\n  ShowUnitLabel = 0x40,\r\n  /** Prepend unit label. Not yet supported */\r\n  PrependUnitLabel = 0x80,\r\n  /** show a grouping in each group of 1000. */\r\n  Use1000Separator = 0x100,\r\n  /** Indicates that if an exponent value is positive to not include a `+`. By default a sign, `+` or `-`, is always shown. Not yet supported */\r\n  ExponentOnlyNegative = 0x200,\r\n}\r\n\r\n/** Precision for Fractional formatted value types. Range from Whole (1/1) through 1/256.\r\n * @beta */\r\nexport enum FractionalPrecision {\r\n  One = 1,\r\n  Two = 2,\r\n  Four = 4,\r\n  Eight = 8,\r\n  Sixteen = 16,\r\n  ThirtyTwo = 32,\r\n  SixtyFour = 64,\r\n  OneHundredTwentyEight = 128,\r\n  TwoHundredFiftySix = 256,\r\n}\r\n\r\n/** Precision for Decimal, Scientific, and Station formatted value types. Range from 1/(10^0) through 1/(10^12).\r\n * @beta */\r\nexport enum DecimalPrecision {\r\n  Zero = 0,\r\n  One = 1,\r\n  Two = 2,\r\n  Three = 3,\r\n  Four = 4,\r\n  Five = 5,\r\n  Six = 6,\r\n  Seven = 7,\r\n  Eight = 8,\r\n  Nine = 9,\r\n  Ten = 10,\r\n  Eleven = 11,\r\n  Twelve = 12,\r\n}\r\n\r\n/** Supported format types\r\n *  @beta */\r\nexport enum FormatType {\r\n  /** Decimal display (ie 2.125) */\r\n  Decimal,\r\n  /** Fractional display (ie 2-1/8) */\r\n  Fractional,\r\n  /** Scientific Notation (ie 1.04e3) */\r\n  Scientific,\r\n  /** Civil Engineering Stationing (ie 1+00). */\r\n  Station,\r\n}\r\n\r\n/** required if type is scientific\r\n * @beta */\r\nexport enum ScientificType {\r\n  /** Non-zero value left of decimal point (ie 1.2345e3) */\r\n  Normalized,\r\n  /** Zero value left of decimal point (ie 0.12345e4) */\r\n  ZeroNormalized,\r\n}\r\n\r\n/** Determines how the sign of values are displayed\r\n * @beta */\r\nexport enum ShowSignOption {\r\n  /** Never show a sign even if the value is negative. */\r\n  NoSign,\r\n  /** Only show a sign when the value is negative. */\r\n  OnlyNegative,\r\n  /** Always show a sign whether the value is positive or negative. */\r\n  SignAlways,\r\n  /** Only show a sign when the value is negative but use parentheses instead of a negative sign. For example, -10 is formatted as `(10)`. */\r\n  NegativeParentheses,\r\n}\r\n\r\n// parse and toString methods\r\n\r\n/**  @beta   */\r\n\r\nexport function parseScientificType(scientificType: string, formatName: string): ScientificType {\r\n  switch (scientificType.toLowerCase()) {\r\n    case \"normalized\": return ScientificType.Normalized;\r\n    case \"zeronormalized\": return ScientificType.ZeroNormalized;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'scientificType' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta   */\r\nexport function scientificTypeToString(scientificType: ScientificType): string {\r\n  return (scientificType === ScientificType.Normalized) ? \"Normalized\" : \"ZeroNormalized\";\r\n}\r\n\r\n/** @beta    */\r\nexport function parseShowSignOption(showSignOption: string, formatName: string): ShowSignOption {\r\n  switch (showSignOption.toLowerCase()) {\r\n    case \"nosign\": return ShowSignOption.NoSign;\r\n    case \"onlynegative\": return ShowSignOption.OnlyNegative;\r\n    case \"signalways\": return ShowSignOption.SignAlways;\r\n    case \"negativeparentheses\": return ShowSignOption.NegativeParentheses;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'showSignOption' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function showSignOptionToString(showSign: ShowSignOption): string {\r\n  switch (showSign) {\r\n    case ShowSignOption.NegativeParentheses: return \"NegativeParentheses\";\r\n    case ShowSignOption.NoSign: return \"NoSign\";\r\n    case ShowSignOption.OnlyNegative: return \"OnlyNegative\";\r\n    case ShowSignOption.SignAlways: return \"SignAlways\";\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function parseFormatTrait(formatTraitsString: string, formatName: string): FormatTraits {\r\n  switch (formatTraitsString.toLowerCase()) {\r\n    case \"trailzeroes\": return FormatTraits.TrailZeroes;\r\n    case \"keepsinglezero\": return FormatTraits.KeepSingleZero;\r\n    case \"zeroempty\": return FormatTraits.ZeroEmpty;\r\n    case \"keepdecimalpoint\": return FormatTraits.KeepDecimalPoint;\r\n    case \"applyrounding\": return FormatTraits.ApplyRounding;\r\n    case \"fractiondash\": return FormatTraits.FractionDash;\r\n    case \"showunitlabel\": return FormatTraits.ShowUnitLabel;\r\n    case \"prependunitlabel\": return FormatTraits.PrependUnitLabel;\r\n    case \"use1000separator\": return FormatTraits.Use1000Separator;\r\n    case \"exponentonlynegative\": return FormatTraits.ExponentOnlyNegative;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'formatTraits' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport function getTraitString(trait: FormatTraits) {\r\n  switch (trait) {\r\n    case FormatTraits.TrailZeroes:\r\n      return \"trailZeroes\";\r\n    case FormatTraits.KeepSingleZero:\r\n      return \"keepSingleZero\";\r\n    case FormatTraits.ZeroEmpty:\r\n      return \"zeroEmpty\";\r\n    case FormatTraits.KeepDecimalPoint:\r\n      return \"keepDecimalPoint\";\r\n    case FormatTraits.ApplyRounding:\r\n      return \"applyRounding\";\r\n    case FormatTraits.FractionDash:\r\n      return \"fractionDash\";\r\n    case FormatTraits.ShowUnitLabel:\r\n      return \"showUnitLabel\";\r\n    case FormatTraits.PrependUnitLabel:\r\n      return \"prependUnitLabel\";\r\n    case FormatTraits.Use1000Separator:\r\n      return \"use1000Separator\";\r\n    case FormatTraits.ExponentOnlyNegative:\r\n    default:\r\n      return \"exponentOnlyNegative\";\r\n  }\r\n}\r\n\r\n/**  @beta  */\r\nexport function formatTraitsToArray(currentFormatTrait: FormatTraits): string[] {\r\n  const formatTraitsArr = Array<string>();\r\n  if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)\r\n    formatTraitsArr.push(\"TrailZeroes\");\r\n  if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)\r\n    formatTraitsArr.push(\"KeepSingleZero\");\r\n  if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)\r\n    formatTraitsArr.push(\"ZeroEmpty\");\r\n  if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)\r\n    formatTraitsArr.push(\"KeepDecimalPoint\");\r\n  if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)\r\n    formatTraitsArr.push(\"ApplyRounding\");\r\n  if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)\r\n    formatTraitsArr.push(\"FractionDash\");\r\n  if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)\r\n    formatTraitsArr.push(\"ShowUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)\r\n    formatTraitsArr.push(\"PrependUnitLabel\");\r\n  if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)\r\n    formatTraitsArr.push(\"Use1000Separator\");\r\n  if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)\r\n    formatTraitsArr.push(\"ExponentOnlyNegative\");\r\n  return formatTraitsArr;\r\n}\r\n\r\n/**  @beta    */\r\nexport function parseFormatType(jsonObjType: string, formatName: string): FormatType {\r\n  switch (jsonObjType.toLowerCase()) {\r\n    case \"decimal\": return FormatType.Decimal;\r\n    case \"scientific\": return FormatType.Scientific;\r\n    case \"station\": return FormatType.Station;\r\n    case \"fractional\": return FormatType.Fractional;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'type' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta    */\r\nexport function formatTypeToString(type: FormatType): string {\r\n  switch (type) {\r\n    case FormatType.Decimal: return \"Decimal\";\r\n    case FormatType.Scientific: return \"Scientific\";\r\n    case FormatType.Station: return \"Station\";\r\n    case FormatType.Fractional: return \"Fractional\";\r\n  }\r\n}\r\n\r\n/**  @beta    */\r\nexport function parseDecimalPrecision(jsonObjPrecision: number, formatName: string): DecimalPrecision {\r\n  switch (jsonObjPrecision) {\r\n    case 0: return DecimalPrecision.Zero;\r\n    case 1: return DecimalPrecision.One;\r\n    case 2: return DecimalPrecision.Two;\r\n    case 3: return DecimalPrecision.Three;\r\n    case 4: return DecimalPrecision.Four;\r\n    case 5: return DecimalPrecision.Five;\r\n    case 6: return DecimalPrecision.Six;\r\n    case 7: return DecimalPrecision.Seven;\r\n    case 8: return DecimalPrecision.Eight;\r\n    case 9: return DecimalPrecision.Nine;\r\n    case 10: return DecimalPrecision.Ten;\r\n    case 11: return DecimalPrecision.Eleven;\r\n    case 12: return DecimalPrecision.Twelve;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n\r\n/**  @beta validates the input value, that is typically extracted for persisted JSON data, is a valid FractionalPrecision */\r\nexport function parseFractionalPrecision(jsonObjPrecision: number, formatName: string): FractionalPrecision {\r\n  switch (jsonObjPrecision) {\r\n    case 1: return FractionalPrecision.One;\r\n    case 2: return FractionalPrecision.Two;\r\n    case 4: return FractionalPrecision.Four;\r\n    case 8: return FractionalPrecision.Eight;\r\n    case 16: return FractionalPrecision.Sixteen;\r\n    case 32: return FractionalPrecision.ThirtyTwo;\r\n    case 64: return FractionalPrecision.SixtyFour;\r\n    case 128: return FractionalPrecision.OneHundredTwentyEight;\r\n    case 256: return FractionalPrecision.TwoHundredFiftySix;\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n\r\n/** @beta  validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision or FractionalPrecision. */\r\nexport function parsePrecision(precision: number, type: FormatType, formatName: string): DecimalPrecision | FractionalPrecision {\r\n  switch (type) { // type must be decimal, fractional, scientific, or station\r\n    case FormatType.Decimal:\r\n    case FormatType.Scientific:\r\n    case FormatType.Station:\r\n      return parseDecimalPrecision(precision, formatName);\r\n    case FormatType.Fractional:\r\n      return parseFractionalPrecision(precision, formatName);\r\n    default:\r\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FormatEnums.js","sourceRoot":"","sources":["../../../src/Formatter/FormatEnums.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA6D;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,eAAe,GAAG,8JAA8J,CAAC;AAE9L,gBAAgB;AAChB,QAAe,CAAC,CAAC,4BAA4B,CAAC,YAAoB;IAChE,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,uBAAe,CAAC,CAAC;IAClD,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,mCAAmC;QACpE,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;YAC5B,MAAM,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;;YAEpC,MAAM;QACR,KAAK,IAAI,CAAC,CAAC;KACZ;AACH,CAAC;AAXD,oEAWC;AACD,YAAY;AACZ,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,iEAAmB,CAAA;IACnB,mDAAmD;IACnD,6DAAiB,CAAA;IACjB,6FAA6F;IAC7F,mEAAoB,CAAA;IACpB,iDAAiD;IACjD,yDAAe,CAAA;IACf,iEAAiE;IACjE,uEAAsB,CAAA;IACtB,kDAAkD;IAClD,kEAAoB,CAAA;IACpB,2DAA2D;IAC3D,gEAAmB,CAAA;IACnB,uCAAuC;IACvC,kEAAoB,CAAA;IACpB,4CAA4C;IAC5C,yEAAuB,CAAA;IACvB,6CAA6C;IAC7C,yEAAwB,CAAA;IACxB,8IAA8I;IAC9I,iFAA4B,CAAA;AAC9B,CAAC,EAtBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAsBvB;AAED;WACW;AACX,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,6DAAQ,CAAA;IACR,+DAAS,CAAA;IACT,oEAAY,CAAA;IACZ,wEAAc,CAAA;IACd,wEAAc,CAAA;IACd,iGAA2B,CAAA;IAC3B,2FAAwB,CAAA;AAC1B,CAAC,EAVW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAU9B;AAED;WACW;AACX,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,qDAAO,CAAA;IACP,yDAAS,CAAA;IACT,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,sDAAQ,CAAA;IACR,4DAAW,CAAA;IACX,4DAAW,CAAA;AACb,CAAC,EAdW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAc3B;AAED;YACY;AACZ,IAAY,UASX;AATD,WAAY,UAAU;IACpB,iCAAiC;IACjC,iDAAO,CAAA;IACP,oCAAoC;IACpC,uDAAU,CAAA;IACV,sCAAsC;IACtC,uDAAU,CAAA;IACV,8CAA8C;IAC9C,iDAAO,CAAA;AACT,CAAC,EATW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QASrB;AAED;WACW;AACX,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yDAAyD;IACzD,+DAAU,CAAA;IACV,sDAAsD;IACtD,uEAAc,CAAA;AAChB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED;WACW;AACX,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uDAAuD;IACvD,uDAAM,CAAA;IACN,mDAAmD;IACnD,mEAAY,CAAA;IACZ,oEAAoE;IACpE,+DAAU,CAAA;IACV,2IAA2I;IAC3I,iFAAmB,CAAA;AACrB,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAED,6BAA6B;AAE7B,eAAe;AAEf,SAAgB,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,cAAc,CAAC,cAAc,CAAC;QAC5D;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;KAC9H;AACH,CAAC;AAPD,kDAOC;AAED,eAAe;AACf,SAAgB,sBAAsB,CAAC,cAA8B;IACnE,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC1F,CAAC;AAFD,wDAEC;AAED,eAAe;AACf,SAAgB,mBAAmB,CAAC,cAAsB,EAAE,UAAkB;IAC5E,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE;QACpC,KAAK,QAAQ,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC;QAC5C,KAAK,cAAc,CAAC,CAAC,OAAO,cAAc,CAAC,YAAY,CAAC;QACxD,KAAK,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC,UAAU,CAAC;QACpD,KAAK,qBAAqB,CAAC,CAAC,OAAO,cAAc,CAAC,mBAAmB,CAAC;QACtE;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,6CAA6C,CAAC,CAAC;KAC9H;AACH,CAAC;AATD,kDASC;AAED,cAAc;AACd,SAAgB,sBAAsB,CAAC,QAAwB;IAC7D,QAAQ,QAAQ,EAAE;QAChB,KAAK,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,qBAAqB,CAAC;QACtE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;QAC5C,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,cAAc,CAAC;QACxD,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACrD;AACH,CAAC;AAPD,wDAOC;AAED,cAAc;AACd,SAAgB,gBAAgB,CAAC,kBAA0B,EAAE,UAAkB;IAC7E,QAAQ,kBAAkB,CAAC,WAAW,EAAE,EAAE;QACxC,KAAK,aAAa,CAAC,CAAC,OAAO,YAAY,CAAC,WAAW,CAAC;QACpD,KAAK,gBAAgB,CAAC,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC;QAC1D,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC;QAChD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,cAAc,CAAC,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC;QACtD,KAAK,eAAe,CAAC,CAAC,OAAO,YAAY,CAAC,aAAa,CAAC;QACxD,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,kBAAkB,CAAC,CAAC,OAAO,YAAY,CAAC,gBAAgB,CAAC;QAC9D,KAAK,sBAAsB,CAAC,CAAC,OAAO,YAAY,CAAC,oBAAoB,CAAC;QACtE;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,2CAA2C,CAAC,CAAC;KAC5H;AACH,CAAC;AAfD,4CAeC;AAED,YAAY;AACZ,SAAgB,cAAc,CAAC,KAAmB;IAChD,QAAQ,KAAK,EAAE;QACb,KAAK,YAAY,CAAC,WAAW;YAC3B,OAAO,aAAa,CAAC;QACvB,KAAK,YAAY,CAAC,cAAc;YAC9B,OAAO,gBAAgB,CAAC;QAC1B,KAAK,YAAY,CAAC,SAAS;YACzB,OAAO,WAAW,CAAC;QACrB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,YAAY;YAC5B,OAAO,cAAc,CAAC;QACxB,KAAK,YAAY,CAAC,aAAa;YAC7B,OAAO,eAAe,CAAC;QACzB,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,gBAAgB;YAChC,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY,CAAC,oBAAoB,CAAC;QACvC;YACE,OAAO,sBAAsB,CAAC;KACjC;AACH,CAAC;AAxBD,wCAwBC;AAED,cAAc;AACd,SAAgB,mBAAmB,CAAC,kBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,EAAU,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC,WAAW;QAC9E,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,KAAK,YAAY,CAAC,cAAc;QACpF,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACzC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,SAAS;QAC1E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC,YAAY;QAChF,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,KAAK,YAAY,CAAC,aAAa;QAClF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,gBAAgB,CAAC,KAAK,YAAY,CAAC,gBAAgB;QACxF,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3C,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,YAAY,CAAC,oBAAoB;QAChG,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC/C,OAAO,eAAe,CAAC;AACzB,CAAC;AAvBD,kDAuBC;AAED,gBAAgB;AAChB,SAAgB,eAAe,CAAC,WAAmB,EAAE,UAAkB;IACrE,QAAQ,WAAW,CAAC,WAAW,EAAE,EAAE;QACjC,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD,KAAK,SAAS,CAAC,CAAC,OAAO,UAAU,CAAC,OAAO,CAAC;QAC1C,KAAK,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;QAChD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,mCAAmC,CAAC,CAAC;KACpH;AACH,CAAC;AATD,0CASC;AAED,eAAe;AACf,SAAgB,kBAAkB,CAAC,IAAgB;IACjD,QAAQ,IAAI,EAAE;QACZ,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;QAChD,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;QAC1C,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,YAAY,CAAC;KACjD;AACH,CAAC;AAPD,gDAOC;AAED,gBAAgB;AAChB,SAAgB,qBAAqB,CAAC,gBAAwB,EAAE,UAAkB;IAChF,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,KAAK,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,OAAO,gBAAgB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC;QACxC;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAlBD,sDAkBC;AAED,4HAA4H;AAC5H,SAAgB,wBAAwB,CAAC,gBAAwB,EAAE,UAAkB;IACnF,QAAQ,gBAAgB,EAAE;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,GAAG,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC;QACzC,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,EAAE,CAAC,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC;QAC9C,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,qBAAqB,CAAC;QAC3D,KAAK,GAAG,CAAC,CAAC,OAAO,mBAAmB,CAAC,kBAAkB,CAAC;QACxD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAdD,4DAcC;AAED,iJAAiJ;AACjJ,SAAgB,cAAc,CAAC,SAAiB,EAAE,IAAgB,EAAE,UAAkB;IACpF,QAAQ,IAAI,EAAE,EAAE,2DAA2D;QACzE,KAAK,UAAU,CAAC,OAAO,CAAC;QACxB,KAAK,UAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,UAAU,CAAC,OAAO;YACrB,OAAO,qBAAqB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtD,KAAK,UAAU,CAAC,UAAU;YACxB,OAAO,wBAAwB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACzD;YACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,cAAc,UAAU,wCAAwC,CAAC,CAAC;KACzH;AACH,CAAC;AAXD,wCAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Quantity\n */\n\nimport { QuantityError, QuantityStatus } from \"../Exception\";\n\n/** The regular expression to parse [format strings]($docs/bis/ec/kindofquantity.md#format-string)\n * provided in serialized formats as well as the full name of an [[OverrideFormat]].\n *\n * `formatName(precision)[unitName|unitLabel][unitName|unitLabel][unitName|unitLabel][unitName|unitLabel]`\n *\n * Explanation of the regex:\n * - ([\\w.:]+)\n *   - Grabs the format full name\n * - (\\(([^\\)]+)\\))?\n *   - Grabs the precision part with and without the `()`.\n *   - The parentheses are needed to validate the entire string.  (TODO: Need to check if this is true)\n * - (\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?\n *   - 4 of these make up the rest of the regex, none of them are required so each end in `?`\n *   - Grabs the unit name and label including the `[]`\n *   - Grabs the unit name, `|` and label separately\n * @internal\n */\nexport const formatStringRgx = /([\\w.:]+)(\\(([^\\)]+)\\))?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?(\\[([^\\|\\]]+)([\\|])?([^\\]]+)?\\])?/;\n\n/** @internal */\nexport function* getItemNamesFromFormatString(formatString: string): Iterable<string> {\n  const match = formatString.split(formatStringRgx);\n  yield match[1]; // the Format Name\n  let index = 4;\n  while (index < match.length - 1) { // index 0 and 21 are empty strings\n    if (match[index] !== undefined)\n      yield match[index + 1]; // Unit Name\n    else\n      break;\n    index += 4;\n  }\n}\n/** @beta */\nexport enum FormatTraits {\n  Uninitialized = 0x0,\n  /** Show trailing zeroes to requested precision. */\n  TrailZeroes = 0x1,\n  /** Indicates that the fractional part of the number is required when the fraction is zero */\n  KeepSingleZero = 0x2,\n  /** Zero magnitude returns blank display value */\n  ZeroEmpty = 0x4,\n  /** Show decimal point when value to right of decimal is empty */\n  KeepDecimalPoint = 0x8,\n  /** Use the rounding factor. Not yet supported  */\n  ApplyRounding = 0x10,\n  /** Show a dash between whole value and fractional value */\n  FractionDash = 0x20,\n  /** Append the quantity's unit label */\n  ShowUnitLabel = 0x40,\n  /** Prepend unit label. Not yet supported */\n  PrependUnitLabel = 0x80,\n  /** show a grouping in each group of 1000. */\n  Use1000Separator = 0x100,\n  /** Indicates that if an exponent value is positive to not include a `+`. By default a sign, `+` or `-`, is always shown. Not yet supported */\n  ExponentOnlyNegative = 0x200,\n}\n\n/** Precision for Fractional formatted value types. Range from Whole (1/1) through 1/256.\n * @beta */\nexport enum FractionalPrecision {\n  One = 1,\n  Two = 2,\n  Four = 4,\n  Eight = 8,\n  Sixteen = 16,\n  ThirtyTwo = 32,\n  SixtyFour = 64,\n  OneHundredTwentyEight = 128,\n  TwoHundredFiftySix = 256,\n}\n\n/** Precision for Decimal, Scientific, and Station formatted value types. Range from 1/(10^0) through 1/(10^12).\n * @beta */\nexport enum DecimalPrecision {\n  Zero = 0,\n  One = 1,\n  Two = 2,\n  Three = 3,\n  Four = 4,\n  Five = 5,\n  Six = 6,\n  Seven = 7,\n  Eight = 8,\n  Nine = 9,\n  Ten = 10,\n  Eleven = 11,\n  Twelve = 12,\n}\n\n/** Supported format types\n *  @beta */\nexport enum FormatType {\n  /** Decimal display (ie 2.125) */\n  Decimal,\n  /** Fractional display (ie 2-1/8) */\n  Fractional,\n  /** Scientific Notation (ie 1.04e3) */\n  Scientific,\n  /** Civil Engineering Stationing (ie 1+00). */\n  Station,\n}\n\n/** required if type is scientific\n * @beta */\nexport enum ScientificType {\n  /** Non-zero value left of decimal point (ie 1.2345e3) */\n  Normalized,\n  /** Zero value left of decimal point (ie 0.12345e4) */\n  ZeroNormalized,\n}\n\n/** Determines how the sign of values are displayed\n * @beta */\nexport enum ShowSignOption {\n  /** Never show a sign even if the value is negative. */\n  NoSign,\n  /** Only show a sign when the value is negative. */\n  OnlyNegative,\n  /** Always show a sign whether the value is positive or negative. */\n  SignAlways,\n  /** Only show a sign when the value is negative but use parentheses instead of a negative sign. For example, -10 is formatted as `(10)`. */\n  NegativeParentheses,\n}\n\n// parse and toString methods\n\n/**  @beta   */\n\nexport function parseScientificType(scientificType: string, formatName: string): ScientificType {\n  switch (scientificType.toLowerCase()) {\n    case \"normalized\": return ScientificType.Normalized;\n    case \"zeronormalized\": return ScientificType.ZeroNormalized;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'scientificType' attribute.`);\n  }\n}\n\n/**  @beta   */\nexport function scientificTypeToString(scientificType: ScientificType): string {\n  return (scientificType === ScientificType.Normalized) ? \"Normalized\" : \"ZeroNormalized\";\n}\n\n/** @beta    */\nexport function parseShowSignOption(showSignOption: string, formatName: string): ShowSignOption {\n  switch (showSignOption.toLowerCase()) {\n    case \"nosign\": return ShowSignOption.NoSign;\n    case \"onlynegative\": return ShowSignOption.OnlyNegative;\n    case \"signalways\": return ShowSignOption.SignAlways;\n    case \"negativeparentheses\": return ShowSignOption.NegativeParentheses;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'showSignOption' attribute.`);\n  }\n}\n\n/**  @beta  */\nexport function showSignOptionToString(showSign: ShowSignOption): string {\n  switch (showSign) {\n    case ShowSignOption.NegativeParentheses: return \"NegativeParentheses\";\n    case ShowSignOption.NoSign: return \"NoSign\";\n    case ShowSignOption.OnlyNegative: return \"OnlyNegative\";\n    case ShowSignOption.SignAlways: return \"SignAlways\";\n  }\n}\n\n/**  @beta  */\nexport function parseFormatTrait(formatTraitsString: string, formatName: string): FormatTraits {\n  switch (formatTraitsString.toLowerCase()) {\n    case \"trailzeroes\": return FormatTraits.TrailZeroes;\n    case \"keepsinglezero\": return FormatTraits.KeepSingleZero;\n    case \"zeroempty\": return FormatTraits.ZeroEmpty;\n    case \"keepdecimalpoint\": return FormatTraits.KeepDecimalPoint;\n    case \"applyrounding\": return FormatTraits.ApplyRounding;\n    case \"fractiondash\": return FormatTraits.FractionDash;\n    case \"showunitlabel\": return FormatTraits.ShowUnitLabel;\n    case \"prependunitlabel\": return FormatTraits.PrependUnitLabel;\n    case \"use1000separator\": return FormatTraits.Use1000Separator;\n    case \"exponentonlynegative\": return FormatTraits.ExponentOnlyNegative;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'formatTraits' attribute.`);\n  }\n}\n\n/** @beta */\nexport function getTraitString(trait: FormatTraits) {\n  switch (trait) {\n    case FormatTraits.TrailZeroes:\n      return \"trailZeroes\";\n    case FormatTraits.KeepSingleZero:\n      return \"keepSingleZero\";\n    case FormatTraits.ZeroEmpty:\n      return \"zeroEmpty\";\n    case FormatTraits.KeepDecimalPoint:\n      return \"keepDecimalPoint\";\n    case FormatTraits.ApplyRounding:\n      return \"applyRounding\";\n    case FormatTraits.FractionDash:\n      return \"fractionDash\";\n    case FormatTraits.ShowUnitLabel:\n      return \"showUnitLabel\";\n    case FormatTraits.PrependUnitLabel:\n      return \"prependUnitLabel\";\n    case FormatTraits.Use1000Separator:\n      return \"use1000Separator\";\n    case FormatTraits.ExponentOnlyNegative:\n    default:\n      return \"exponentOnlyNegative\";\n  }\n}\n\n/**  @beta  */\nexport function formatTraitsToArray(currentFormatTrait: FormatTraits): string[] {\n  const formatTraitsArr = Array<string>();\n  if ((currentFormatTrait & FormatTraits.TrailZeroes) === FormatTraits.TrailZeroes)\n    formatTraitsArr.push(\"TrailZeroes\");\n  if ((currentFormatTrait & FormatTraits.KeepSingleZero) === FormatTraits.KeepSingleZero)\n    formatTraitsArr.push(\"KeepSingleZero\");\n  if ((currentFormatTrait & FormatTraits.ZeroEmpty) === FormatTraits.ZeroEmpty)\n    formatTraitsArr.push(\"ZeroEmpty\");\n  if ((currentFormatTrait & FormatTraits.KeepDecimalPoint) === FormatTraits.KeepDecimalPoint)\n    formatTraitsArr.push(\"KeepDecimalPoint\");\n  if ((currentFormatTrait & FormatTraits.ApplyRounding) === FormatTraits.ApplyRounding)\n    formatTraitsArr.push(\"ApplyRounding\");\n  if ((currentFormatTrait & FormatTraits.FractionDash) === FormatTraits.FractionDash)\n    formatTraitsArr.push(\"FractionDash\");\n  if ((currentFormatTrait & FormatTraits.ShowUnitLabel) === FormatTraits.ShowUnitLabel)\n    formatTraitsArr.push(\"ShowUnitLabel\");\n  if ((currentFormatTrait & FormatTraits.PrependUnitLabel) === FormatTraits.PrependUnitLabel)\n    formatTraitsArr.push(\"PrependUnitLabel\");\n  if ((currentFormatTrait & FormatTraits.Use1000Separator) === FormatTraits.Use1000Separator)\n    formatTraitsArr.push(\"Use1000Separator\");\n  if ((currentFormatTrait & FormatTraits.ExponentOnlyNegative) === FormatTraits.ExponentOnlyNegative)\n    formatTraitsArr.push(\"ExponentOnlyNegative\");\n  return formatTraitsArr;\n}\n\n/**  @beta    */\nexport function parseFormatType(jsonObjType: string, formatName: string): FormatType {\n  switch (jsonObjType.toLowerCase()) {\n    case \"decimal\": return FormatType.Decimal;\n    case \"scientific\": return FormatType.Scientific;\n    case \"station\": return FormatType.Station;\n    case \"fractional\": return FormatType.Fractional;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'type' attribute.`);\n  }\n}\n\n/** @beta    */\nexport function formatTypeToString(type: FormatType): string {\n  switch (type) {\n    case FormatType.Decimal: return \"Decimal\";\n    case FormatType.Scientific: return \"Scientific\";\n    case FormatType.Station: return \"Station\";\n    case FormatType.Fractional: return \"Fractional\";\n  }\n}\n\n/**  @beta    */\nexport function parseDecimalPrecision(jsonObjPrecision: number, formatName: string): DecimalPrecision {\n  switch (jsonObjPrecision) {\n    case 0: return DecimalPrecision.Zero;\n    case 1: return DecimalPrecision.One;\n    case 2: return DecimalPrecision.Two;\n    case 3: return DecimalPrecision.Three;\n    case 4: return DecimalPrecision.Four;\n    case 5: return DecimalPrecision.Five;\n    case 6: return DecimalPrecision.Six;\n    case 7: return DecimalPrecision.Seven;\n    case 8: return DecimalPrecision.Eight;\n    case 9: return DecimalPrecision.Nine;\n    case 10: return DecimalPrecision.Ten;\n    case 11: return DecimalPrecision.Eleven;\n    case 12: return DecimalPrecision.Twelve;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n\n/**  @beta validates the input value, that is typically extracted for persisted JSON data, is a valid FractionalPrecision */\nexport function parseFractionalPrecision(jsonObjPrecision: number, formatName: string): FractionalPrecision {\n  switch (jsonObjPrecision) {\n    case 1: return FractionalPrecision.One;\n    case 2: return FractionalPrecision.Two;\n    case 4: return FractionalPrecision.Four;\n    case 8: return FractionalPrecision.Eight;\n    case 16: return FractionalPrecision.Sixteen;\n    case 32: return FractionalPrecision.ThirtyTwo;\n    case 64: return FractionalPrecision.SixtyFour;\n    case 128: return FractionalPrecision.OneHundredTwentyEight;\n    case 256: return FractionalPrecision.TwoHundredFiftySix;\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n\n/** @beta  validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision or FractionalPrecision. */\nexport function parsePrecision(precision: number, type: FormatType, formatName: string): DecimalPrecision | FractionalPrecision {\n  switch (type) { // type must be decimal, fractional, scientific, or station\n    case FormatType.Decimal:\n    case FormatType.Scientific:\n    case FormatType.Station:\n      return parseDecimalPrecision(precision, formatName);\n    case FormatType.Fractional:\n      return parseFractionalPrecision(precision, formatName);\n    default:\n      throw new QuantityError(QuantityStatus.InvalidJson, `The Format ${formatName} has an invalid 'precision' attribute.`);\n  }\n}\n"]}

package/lib/cjs/Formatter/Formatter.d.ts

@@ -1,45 +1,45 @@
-/** @packageDocumentation
- * @module Quantity
- */
-import { FormatterSpec } from "./FormatterSpec";
-/** A helper class that contains methods used to format quantity values based on a format that are defined via the Format class.
- * @beta
- */
-export declare class Formatter {
-    private static FPV_MINTHRESHOLD;
-    private static isNegligible;
-    /** Return floating point value rounded by specific rounding factor.
-     *  @param value    Value to be rounded.
-     *  @param roundTo  Rounding factor.
-     */
-    private static roundDouble;
-    /** Generate a formatted text string integer value insert 1000 separators if appropriate.
-     *  @param wholePart    Integer value to be formatted.
-     */
-    private static integerPartToText;
-    /** Trim trailing "0" from the text that represent the fractional part of a floating point value.
-     *  @param strVal   The value string.
-     */
-    private static trimTrailingZeroes;
-    /** Format a quantity value into a composite format such as ft-in or deg-min-sec.
-     *  @param compositeValue   The value for this part of the composite
-     *  @param isLastPart       If false the composite value should be a whole value, if true then the value should be formatted as a floating point value.
-     *  @param label            Label for this part of the composite. This will be either the default unit label or a custom label specified the format specification.
-     */
-    private static formatCompositePart;
-    /** Format a quantity value into a composite format such as ft-in or deg-min-sec.
-     *  @param magnitude   quantity value
-     *  @param fromUnit    quantity unit
-     */
-    private static formatComposite;
-    /** Format a quantity value into a single text string. Imitate how formatting done by server method NumericFormatSpec::FormatDouble.
-     *  @param magnitude   quantity value
-     */
-    private static formatMagnitude;
-    /** Format a quantity value into a single text string based on the current format specification of this class.
-     *  @param magnitude   defines the value to spec.format.
-     *  @param spec      A FormatterSpec object the defines specification for the magnitude and unit conversions for the formatter.
-     */
-    static formatQuantity(magnitude: number, spec: FormatterSpec): string;
-}
+/** @packageDocumentation
+ * @module Quantity
+ */
+import { FormatterSpec } from "./FormatterSpec";
+/** A helper class that contains methods used to format quantity values based on a format that are defined via the Format class.
+ * @beta
+ */
+export declare class Formatter {
+    private static FPV_MINTHRESHOLD;
+    private static isNegligible;
+    /** Return floating point value rounded by specific rounding factor.
+     *  @param value    Value to be rounded.
+     *  @param roundTo  Rounding factor.
+     */
+    private static roundDouble;
+    /** Generate a formatted text string integer value insert 1000 separators if appropriate.
+     *  @param wholePart    Integer value to be formatted.
+     */
+    private static integerPartToText;
+    /** Trim trailing "0" from the text that represent the fractional part of a floating point value.
+     *  @param strVal   The value string.
+     */
+    private static trimTrailingZeroes;
+    /** Format a quantity value into a composite format such as ft-in or deg-min-sec.
+     *  @param compositeValue   The value for this part of the composite
+     *  @param isLastPart       If false the composite value should be a whole value, if true then the value should be formatted as a floating point value.
+     *  @param label            Label for this part of the composite. This will be either the default unit label or a custom label specified the format specification.
+     */
+    private static formatCompositePart;
+    /** Format a quantity value into a composite format such as ft-in or deg-min-sec.
+     *  @param magnitude   quantity value
+     *  @param fromUnit    quantity unit
+     */
+    private static formatComposite;
+    /** Format a quantity value into a single text string. Imitate how formatting done by server method NumericFormatSpec::FormatDouble.
+     *  @param magnitude   quantity value
+     */
+    private static formatMagnitude;
+    /** Format a quantity value into a single text string based on the current format specification of this class.
+     *  @param magnitude   defines the value to spec.format.
+     *  @param spec      A FormatterSpec object the defines specification for the magnitude and unit conversions for the formatter.
+     */
+    static formatQuantity(magnitude: number, spec: FormatterSpec): string;
+}
 //# sourceMappingURL=Formatter.d.ts.map