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

package/lib/esm/Formatter/Interfaces.js

@@ -1,14 +1,14 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Quantity
- */
-/** CustomFormatProps type guard.
- * @beta
- */
-export const isCustomFormatProps = (item) => {
-    return item.custom !== undefined;
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Quantity
+ */
+/** CustomFormatProps type guard.
+ * @beta
+ */
+export const isCustomFormatProps = (item) => {
+    return item.custom !== undefined;
+};
 //# sourceMappingURL=Interfaces.js.map

package/lib/esm/Formatter/Interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAsCH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,CAAC","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 { UnitProps } from \"../Interfaces\";\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\n\n/** This interface defines the persistence format for describing the formatting of quantity values.\n * @beta\n */\nexport interface FormatProps {\n  readonly type: string;\n  readonly precision?: number;\n  readonly roundFactor?: number;\n  readonly minWidth?: number;\n  readonly showSignOption?: string;\n  readonly formatTraits?: string | string[];\n  readonly decimalSeparator?: string;\n  readonly thousandSeparator?: string;\n  readonly uomSeparator?: string;\n  readonly scientificType?: string; // conditionally required\n  readonly stationOffsetSize?: number; // conditionally required\n  readonly stationSeparator?: string;\n  readonly composite?: {\n    readonly spacer?: string;\n    readonly includeZero?: boolean; // not currently used in Native formatter\n    readonly units: Array<{\n      readonly name: string;\n      readonly label?: string;\n    }>;\n  };\n}\n\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\n * @beta\n */\nexport interface CustomFormatProps extends FormatProps {\n  readonly custom: any;\n}\n\n/** CustomFormatProps type guard.\n * @beta\n */\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\n  return (item as CustomFormatProps).custom !== undefined;\n};\n\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\n * @beta\n */\nexport interface CloneUnit {\n  unit?: UnitProps;\n  label?: string;\n}\n\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\n * @beta\n */\nexport interface CloneOptions {\n  /** allows composite formats to be converted to only show primary unit */\n  showOnlyPrimaryUnit?: boolean;\n  /** allow format traits to be set */\n  traits?: FormatTraits;\n  /** allows new FormatType to be specified */\n  type?: FormatType;\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\n  precision?: DecimalPrecision | FractionalPrecision;\n  /** allows primary unit and label to be specified */\n  primaryUnit?: CloneUnit;\n}\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/Formatter/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAsCH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAA6B,EAAE;IAClF,OAAQ,IAA0B,CAAC,MAAM,KAAK,SAAS,CAAC;AAC1D,CAAC,CAAC","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 { UnitProps } from \"../Interfaces\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision } from \"./FormatEnums\";\r\n\r\n/** This interface defines the persistence format for describing the formatting of quantity values.\r\n * @beta\r\n */\r\nexport interface FormatProps {\r\n  readonly type: string;\r\n  readonly precision?: number;\r\n  readonly roundFactor?: number;\r\n  readonly minWidth?: number;\r\n  readonly showSignOption?: string;\r\n  readonly formatTraits?: string | string[];\r\n  readonly decimalSeparator?: string;\r\n  readonly thousandSeparator?: string;\r\n  readonly uomSeparator?: string;\r\n  readonly scientificType?: string; // conditionally required\r\n  readonly stationOffsetSize?: number; // conditionally required\r\n  readonly stationSeparator?: string;\r\n  readonly composite?: {\r\n    readonly spacer?: string;\r\n    readonly includeZero?: boolean; // not currently used in Native formatter\r\n    readonly units: Array<{\r\n      readonly name: string;\r\n      readonly label?: string;\r\n    }>;\r\n  };\r\n}\r\n\r\n/** This interface is used when supporting Custom Formatters that need more than the standard set of properties.\r\n * @beta\r\n */\r\nexport interface CustomFormatProps extends FormatProps {\r\n  readonly custom: any;\r\n}\r\n\r\n/** CustomFormatProps type guard.\r\n * @beta\r\n */\r\nexport const isCustomFormatProps = (item: FormatProps): item is CustomFormatProps => {\r\n  return (item as CustomFormatProps).custom !== undefined;\r\n};\r\n\r\n/** CloneFormat defines unit and label specification if primary unit is to be set during clone.\r\n * @beta\r\n */\r\nexport interface CloneUnit {\r\n  unit?: UnitProps;\r\n  label?: string;\r\n}\r\n\r\n/** CloneOptions that define modifications that can be made during the cloning of a Format.\r\n * @beta\r\n */\r\nexport interface CloneOptions {\r\n  /** allows composite formats to be converted to only show primary unit */\r\n  showOnlyPrimaryUnit?: boolean;\r\n  /** allow format traits to be set */\r\n  traits?: FormatTraits;\r\n  /** allows new FormatType to be specified */\r\n  type?: FormatType;\r\n  /** allows precision to be set, this will throw if value is not valid for FormatType */\r\n  precision?: DecimalPrecision | FractionalPrecision;\r\n  /** allows primary unit and label to be specified */\r\n  primaryUnit?: CloneUnit;\r\n}\r\n"]}

package/lib/esm/Interfaces.d.ts

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module Quantity
- */
-/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.
- * @beta
- */
-export interface AlternateUnitLabelsProvider {
-    getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;
-}
-/** This interface provides basic information about a Unit that is return from a UnitProvider. This info
- * uniquely identifies a unit by its name.
- * @beta
- */
-export interface UnitProps {
-    /** Unique name for unit. */
-    readonly name: string;
-    /** Default label for unit. */
-    readonly label: string;
-    /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */
-    readonly phenomenon: string;
-    /** This is set to true if the Unit is known by the UnitsProvider. */
-    readonly isValid: boolean;
-    /** Unique system name. Example "Units.USCUSTOM"," Units.METRIC", "Units.USSURVEY", "Units.IMPERIAL" */
-    readonly system: string;
-}
-/** This interface defines the required properties of a Quantity.
- * @beta
- */
-export interface QuantityProps {
-    readonly magnitude: number;
-    readonly unit: UnitProps;
-    readonly isValid: boolean;
-}
-/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.
- * @beta
- */
-export interface UnitConversionSpec {
-    /** Unit name that was used to locate the unit by the Unit Provider */
-    name: string;
-    /** The default label that is used to display unit */
-    label: string;
-    /** Unit system name, used to when finding preferred parse unit */
-    system: string;
-    /** the information necessary to convert the unit to a specific display unit */
-    conversion: UnitConversion;
-    /** Labels that may be used to represent the unit in a string that is to be parsed. */
-    parseLabels?: string[];
-}
-/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet
- * or from Celsius to Fahrenheit.
- * @beta
- */
-export interface UnitConversion {
-    factor: number;
-    offset: number;
-}
-/** Interface that defines potential parse units that may be found in user's string input of a quantity value.
- * @beta
- */
-export interface PotentialParseUnit {
-    unitName: string;
-    altLabels?: string[];
-}
-/**
- * This interface defines extra properties to be associated with Units from Units Schema by name
- * @alpha
- */
-export interface UnitExtraData {
-    readonly name: string;
-    readonly altDisplayLabels: string[];
-}
-/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.
- * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.
- * @beta
- */
-export interface UnitsProvider {
-    findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;
-    getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;
-    findUnitByName(unitName: string): Promise<UnitProps>;
-    getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversion>;
-}
-/**
- * Used to uniquely identify a unit system.
- * @beta
- */
-export declare type UnitSystemKey = "metric" | "imperial" | "usCustomary" | "usSurvey";
+/** @packageDocumentation
+ * @module Quantity
+ */
+/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.
+ * @beta
+ */
+export interface AlternateUnitLabelsProvider {
+    getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;
+}
+/** This interface provides basic information about a Unit that is return from a UnitProvider. This info
+ * uniquely identifies a unit by its name.
+ * @beta
+ */
+export interface UnitProps {
+    /** Unique name for unit. */
+    readonly name: string;
+    /** Default label for unit. */
+    readonly label: string;
+    /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */
+    readonly phenomenon: string;
+    /** This is set to true if the Unit is known by the UnitsProvider. */
+    readonly isValid: boolean;
+    /** Unique system name. Example "Units.USCUSTOM"," Units.METRIC", "Units.USSURVEY", "Units.IMPERIAL" */
+    readonly system: string;
+}
+/** This interface defines the required properties of a Quantity.
+ * @beta
+ */
+export interface QuantityProps {
+    readonly magnitude: number;
+    readonly unit: UnitProps;
+    readonly isValid: boolean;
+}
+/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.
+ * @beta
+ */
+export interface UnitConversionSpec {
+    /** Unit name that was used to locate the unit by the Unit Provider */
+    name: string;
+    /** The default label that is used to display unit */
+    label: string;
+    /** Unit system name, used to when finding preferred parse unit */
+    system: string;
+    /** the information necessary to convert the unit to a specific display unit */
+    conversion: UnitConversion;
+    /** Labels that may be used to represent the unit in a string that is to be parsed. */
+    parseLabels?: string[];
+}
+/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet
+ * or from Celsius to Fahrenheit.
+ * @beta
+ */
+export interface UnitConversion {
+    factor: number;
+    offset: number;
+}
+/** Interface that defines potential parse units that may be found in user's string input of a quantity value.
+ * @beta
+ */
+export interface PotentialParseUnit {
+    unitName: string;
+    altLabels?: string[];
+}
+/**
+ * This interface defines extra properties to be associated with Units from Units Schema by name
+ * @alpha
+ */
+export interface UnitExtraData {
+    readonly name: string;
+    readonly altDisplayLabels: string[];
+}
+/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.
+ * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.
+ * @beta
+ */
+export interface UnitsProvider {
+    findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;
+    getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;
+    findUnitByName(unitName: string): Promise<UnitProps>;
+    getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversion>;
+}
+/**
+ * Used to uniquely identify a unit system.
+ * @beta
+ */
+export declare type UnitSystemKey = "metric" | "imperial" | "usCustomary" | "usSurvey";
 //# sourceMappingURL=Interfaces.d.ts.map

package/lib/esm/Interfaces.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Quantity
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Quantity
+ */
+export {};
 //# sourceMappingURL=Interfaces.js.map

package/lib/esm/Interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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\n/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.\n * @beta\n */\nexport interface AlternateUnitLabelsProvider {\n  getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;\n}\n\n/** This interface provides basic information about a Unit that is return from a UnitProvider. This info\n * uniquely identifies a unit by its name.\n * @beta\n */\nexport interface UnitProps {\n  /** Unique name for unit. */\n  readonly name: string;\n  /** Default label for unit. */\n  readonly label: string;\n  /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */\n  readonly phenomenon: string;\n  /** This is set to true if the Unit is known by the UnitsProvider. */\n  readonly isValid: boolean;\n  /** Unique system name. Example \"Units.USCUSTOM\",\" Units.METRIC\", \"Units.USSURVEY\", \"Units.IMPERIAL\" */\n  readonly system: string;\n}\n\n/** This interface defines the required properties of a Quantity.\n * @beta\n */\nexport interface QuantityProps {\n  readonly magnitude: number;\n  readonly unit: UnitProps;\n  readonly isValid: boolean;\n}\n\n/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.\n * @beta\n */\nexport interface UnitConversionSpec {\n  /** Unit name that was used to locate the unit by the Unit Provider */\n  name: string;\n  /** The default label that is used to display unit */\n  label: string;\n  /** Unit system name, used to when finding preferred parse unit */\n  system: string;\n  /** the information necessary to convert the unit to a specific display unit */\n  conversion: UnitConversion;\n  /** Labels that may be used to represent the unit in a string that is to be parsed. */\n  parseLabels?: string[];\n}\n\n/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet\n * or from Celsius to Fahrenheit.\n * @beta\n */\nexport interface UnitConversion {\n  factor: number;\n  offset: number;\n}\n\n/** Interface that defines potential parse units that may be found in user's string input of a quantity value.\n * @beta\n */\nexport interface PotentialParseUnit {\n  unitName: string;\n  altLabels?: string[];\n}\n\n/**\n * This interface defines extra properties to be associated with Units from Units Schema by name\n * @alpha\n */\nexport interface UnitExtraData {\n  readonly name: string;\n  readonly altDisplayLabels: string[];\n}\n\n/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.\n * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.\n * @beta\n */\nexport interface UnitsProvider {\n  findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;\n  getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;\n  findUnitByName(unitName: string): Promise<UnitProps>;\n  getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversion>;\n}\n\n/**\n * Used to uniquely identify a unit system.\n * @beta\n */\nexport type UnitSystemKey = \"metric\" | \"imperial\" | \"usCustomary\" | \"usSurvey\";\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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\n/** This interface allows a provider to be specified that will define an array of alternate labels for a specific unit.\r\n * @beta\r\n */\r\nexport interface AlternateUnitLabelsProvider {\r\n  getAlternateUnitLabels: (unit: UnitProps) => string[] | undefined;\r\n}\r\n\r\n/** This interface provides basic information about a Unit that is return from a UnitProvider. This info\r\n * uniquely identifies a unit by its name.\r\n * @beta\r\n */\r\nexport interface UnitProps {\r\n  /** Unique name for unit. */\r\n  readonly name: string;\r\n  /** Default label for unit. */\r\n  readonly label: string;\r\n  /** Unique name of unit phenomenon. Example phenomenon names include 'Units.LENGTH', 'Units.AREA', and 'Units.VOLUME' */\r\n  readonly phenomenon: string;\r\n  /** This is set to true if the Unit is known by the UnitsProvider. */\r\n  readonly isValid: boolean;\r\n  /** Unique system name. Example \"Units.USCUSTOM\",\" Units.METRIC\", \"Units.USSURVEY\", \"Units.IMPERIAL\" */\r\n  readonly system: string;\r\n}\r\n\r\n/** This interface defines the required properties of a Quantity.\r\n * @beta\r\n */\r\nexport interface QuantityProps {\r\n  readonly magnitude: number;\r\n  readonly unit: UnitProps;\r\n  readonly isValid: boolean;\r\n}\r\n\r\n/** Interface that defines how to convert between a specific unit an another in synchronous formatting or parsing processing.\r\n * @beta\r\n */\r\nexport interface UnitConversionSpec {\r\n  /** Unit name that was used to locate the unit by the Unit Provider */\r\n  name: string;\r\n  /** The default label that is used to display unit */\r\n  label: string;\r\n  /** Unit system name, used to when finding preferred parse unit */\r\n  system: string;\r\n  /** the information necessary to convert the unit to a specific display unit */\r\n  conversion: UnitConversion;\r\n  /** Labels that may be used to represent the unit in a string that is to be parsed. */\r\n  parseLabels?: string[];\r\n}\r\n\r\n/** This interface defines the properties required to convert a quantity value from one unit to another such as from meters to feet\r\n * or from Celsius to Fahrenheit.\r\n * @beta\r\n */\r\nexport interface UnitConversion {\r\n  factor: number;\r\n  offset: number;\r\n}\r\n\r\n/** Interface that defines potential parse units that may be found in user's string input of a quantity value.\r\n * @beta\r\n */\r\nexport interface PotentialParseUnit {\r\n  unitName: string;\r\n  altLabels?: string[];\r\n}\r\n\r\n/**\r\n * This interface defines extra properties to be associated with Units from Units Schema by name\r\n * @alpha\r\n */\r\nexport interface UnitExtraData {\r\n  readonly name: string;\r\n  readonly altDisplayLabels: string[];\r\n}\r\n\r\n/** This interface is implemented by the class that is responsible for locating units by name or label and providing conversion values between units.\r\n * The methods to be implemented are async allowing the UnitsProvider to query the backend when necessary to look up unit definition and conversion rules.\r\n * @beta\r\n */\r\nexport interface UnitsProvider {\r\n  findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;\r\n  getUnitsByFamily(phenomenon: string): Promise<UnitProps[]>;\r\n  findUnitByName(unitName: string): Promise<UnitProps>;\r\n  getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversion>;\r\n}\r\n\r\n/**\r\n * Used to uniquely identify a unit system.\r\n * @beta\r\n */\r\nexport type UnitSystemKey = \"metric\" | \"imperial\" | \"usCustomary\" | \"usSurvey\";\r\n"]}

package/lib/esm/Parser.d.ts

@@ -1,94 +1,94 @@
-/** @packageDocumentation
- * @module Quantity
- */
-import { Format } from "./Formatter/Format";
-import { AlternateUnitLabelsProvider, PotentialParseUnit, QuantityProps, UnitConversionSpec, UnitProps, UnitsProvider } from "./Interfaces";
-import { ParserSpec } from "./ParserSpec";
-/** Possible parser errors
- * @beta
- */
-export declare enum ParseError {
-    UnableToGenerateParseTokens = 1,
-    NoValueOrUnitFoundInString = 2,
-    UnitLabelSuppliedButNotMatched = 3,
-    UnknownUnit = 4,
-    UnableToConvertParseTokensToQuantity = 5,
-    InvalidParserSpec = 6
-}
-/** Parse error result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
- * @beta
- */
-export interface ParseQuantityError {
-    /** Union discriminator for [[QuantityParseResult]]. */
-    ok: false;
-    /** The specific error that occurred during parsing. */
-    error: ParseError;
-}
-/** Successful result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
- * @beta
- */
-export interface ParsedQuantity {
-    /** Union discriminator for [[QuantityParseResult]]. */
-    ok: true;
-    /** The magnitude of the parsed quantity. */
-    value: number;
-}
-/**
- * Defines Results of parsing a string input by a user into its desired value type
- * @beta
- */
-export declare type QuantityParseResult = ParsedQuantity | ParseQuantityError;
-/** A ParseToken holds either a numeric or string token extracted from a string that represents a quantity value.
- * @beta
- */
-declare class ParseToken {
-    value: number | string;
-    constructor(value: string | number);
-    get isString(): boolean;
-    get isNumber(): boolean;
-}
-/** A Parser class that is used to break a string that represents a quantity value into tokens.
- * @beta
- */
-export declare class Parser {
-    private static _log;
-    static isParsedQuantity(item: QuantityParseResult): item is ParsedQuantity;
-    static isParseError(item: QuantityParseResult): item is ParseQuantityError;
-    private static checkForScientificNotation;
-    private static checkForFractions;
-    private static isDigit;
-    private static isDigitOrDecimalSeparator;
-    /** Parse the quantity string and return and array of ParseTokens that represent the component invariant values and unit labels.
-     * @param quantitySpecification The quantity string to ba parsed.
-     */
-    static parseQuantitySpecification(quantitySpecification: string, format: Format): ParseToken[];
-    private static lookupUnitByLabel;
-    private static createQuantityFromParseTokens;
-    /** Async method to generate a Quantity given a string that represents a quantity value and likely a unit label.
-     *  @param inString A string that contains text represent a quantity.
-     *  @param format   Defines the likely format of inString.
-     *  @param unitsProvider required to look up units that may be specified in inString
-     */
-    static parseIntoQuantity(inString: string, format: Format, unitsProvider: UnitsProvider, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<QuantityProps>;
-    /** method to get the Unit Conversion given a unit label */
-    private static tryFindUnitConversion;
-    private static getQuantityValueFromParseTokens;
-    /** Method to generate a Quantity given a string that represents a quantity value.
-     *  @param inString A string that contains text represent a quantity.
-     *  @param parserSpec unit label if not explicitly defined by user. Must have matching entry in supplied array of unitsConversions.
-     *  @param defaultValue default value to return if parsing is un successful
-     */
-    static parseQuantityString(inString: string, parserSpec: ParserSpec): QuantityParseResult;
-    /** Method to generate a Quantity given a string that represents a quantity value and likely a unit label.
-     *  @param inString A string that contains text represent a quantity.
-     *  @param format   Defines the likely format of inString. Primary unit serves as a default unit if no unit label found in string.
-     *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
-     */
-    static parseToQuantityValue(inString: string, format: Format, unitsConversions: UnitConversionSpec[]): QuantityParseResult;
-    /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */
-    static createUnitConversionSpecsForUnit(unitsProvider: UnitsProvider, outUnit: UnitProps, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<UnitConversionSpec[]>;
-    /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */
-    static createUnitConversionSpecs(unitsProvider: UnitsProvider, outUnitName: string, potentialParseUnits: PotentialParseUnit[], altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<UnitConversionSpec[]>;
-}
-export {};
+/** @packageDocumentation
+ * @module Quantity
+ */
+import { Format } from "./Formatter/Format";
+import { AlternateUnitLabelsProvider, PotentialParseUnit, QuantityProps, UnitConversionSpec, UnitProps, UnitsProvider } from "./Interfaces";
+import { ParserSpec } from "./ParserSpec";
+/** Possible parser errors
+ * @beta
+ */
+export declare enum ParseError {
+    UnableToGenerateParseTokens = 1,
+    NoValueOrUnitFoundInString = 2,
+    UnitLabelSuppliedButNotMatched = 3,
+    UnknownUnit = 4,
+    UnableToConvertParseTokensToQuantity = 5,
+    InvalidParserSpec = 6
+}
+/** Parse error result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
+ * @beta
+ */
+export interface ParseQuantityError {
+    /** Union discriminator for [[QuantityParseResult]]. */
+    ok: false;
+    /** The specific error that occurred during parsing. */
+    error: ParseError;
+}
+/** Successful result from [[Parser.parseToQuantityValue]] or [[Parser.parseToQuantityValue]].
+ * @beta
+ */
+export interface ParsedQuantity {
+    /** Union discriminator for [[QuantityParseResult]]. */
+    ok: true;
+    /** The magnitude of the parsed quantity. */
+    value: number;
+}
+/**
+ * Defines Results of parsing a string input by a user into its desired value type
+ * @beta
+ */
+export declare type QuantityParseResult = ParsedQuantity | ParseQuantityError;
+/** A ParseToken holds either a numeric or string token extracted from a string that represents a quantity value.
+ * @beta
+ */
+declare class ParseToken {
+    value: number | string;
+    constructor(value: string | number);
+    get isString(): boolean;
+    get isNumber(): boolean;
+}
+/** A Parser class that is used to break a string that represents a quantity value into tokens.
+ * @beta
+ */
+export declare class Parser {
+    private static _log;
+    static isParsedQuantity(item: QuantityParseResult): item is ParsedQuantity;
+    static isParseError(item: QuantityParseResult): item is ParseQuantityError;
+    private static checkForScientificNotation;
+    private static checkForFractions;
+    private static isDigit;
+    private static isDigitOrDecimalSeparator;
+    /** Parse the quantity string and return and array of ParseTokens that represent the component invariant values and unit labels.
+     * @param quantitySpecification The quantity string to ba parsed.
+     */
+    static parseQuantitySpecification(quantitySpecification: string, format: Format): ParseToken[];
+    private static lookupUnitByLabel;
+    private static createQuantityFromParseTokens;
+    /** Async method to generate a Quantity given a string that represents a quantity value and likely a unit label.
+     *  @param inString A string that contains text represent a quantity.
+     *  @param format   Defines the likely format of inString.
+     *  @param unitsProvider required to look up units that may be specified in inString
+     */
+    static parseIntoQuantity(inString: string, format: Format, unitsProvider: UnitsProvider, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<QuantityProps>;
+    /** method to get the Unit Conversion given a unit label */
+    private static tryFindUnitConversion;
+    private static getQuantityValueFromParseTokens;
+    /** Method to generate a Quantity given a string that represents a quantity value.
+     *  @param inString A string that contains text represent a quantity.
+     *  @param parserSpec unit label if not explicitly defined by user. Must have matching entry in supplied array of unitsConversions.
+     *  @param defaultValue default value to return if parsing is un successful
+     */
+    static parseQuantityString(inString: string, parserSpec: ParserSpec): QuantityParseResult;
+    /** Method to generate a Quantity given a string that represents a quantity value and likely a unit label.
+     *  @param inString A string that contains text represent a quantity.
+     *  @param format   Defines the likely format of inString. Primary unit serves as a default unit if no unit label found in string.
+     *  @param unitsConversions dictionary of conversions used to convert from unit used in inString to output quantity
+     */
+    static parseToQuantityValue(inString: string, format: Format, unitsConversions: UnitConversionSpec[]): QuantityParseResult;
+    /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */
+    static createUnitConversionSpecsForUnit(unitsProvider: UnitsProvider, outUnit: UnitProps, altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<UnitConversionSpec[]>;
+    /** Async Method used to create an array of UnitConversionSpec entries that can be used in synchronous calls to parse units. */
+    static createUnitConversionSpecs(unitsProvider: UnitsProvider, outUnitName: string, potentialParseUnits: PotentialParseUnit[], altUnitLabelsProvider?: AlternateUnitLabelsProvider): Promise<UnitConversionSpec[]>;
+}
+export {};
 //# sourceMappingURL=Parser.d.ts.map