@itwin/core-quantity 3.0.0-dev.76 → 3.0.0-dev.80

package/lib/cjs/core-quantity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-quantity.js","sourceRoot":"","sources":["../../src/core-quantity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,2CAAyB;AACzB,+CAA6B;AAC7B,6CAA2B;AAC3B,yCAAuB;AAEvB,qDAAmC;AACnC,4DAA0C;AAC1C,0DAAwC;AACxC,wDAAsC;AACtC,yDAAuC;AAEvC;;GAEG;AAEH;;;GAGG","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*--------------------------------------------------------------------------------------------*/\nexport * from \"./Constants\";\nexport * from \"./Exception\";\nexport * from \"./Interfaces\";\nexport * from \"./Parser\";\nexport * from \"./ParserSpec\";\nexport * from \"./Quantity\";\nexport * from \"./Unit\";\n\nexport * from \"./Formatter/Format\";\nexport * from \"./Formatter/FormatterSpec\";\nexport * from \"./Formatter/FormatEnums\";\nexport * from \"./Formatter/Formatter\";\nexport * from \"./Formatter/Interfaces\";\n\n/** @docs-package-description\n * The core-quantity package always runs in a web browser. It contains classes, interfaces, and definitions for formatting and parsing quantity values.\n */\n\n/**\n * @docs-group-description Quantity\n * Classes, Interfaces, and definitions used to format and parse quantity values.\n */\n"]}

package/lib/esm/Constants.d.ts

@@ -0,0 +1,28 @@
+/** Constants used internally for both formatting and parsing.
+ * @internal
+ */
+export declare class QuantityConstants {
+    static readonly CHAR_COMMA = 44;
+    static readonly CHAR_SPACE = 32;
+    static readonly CHAR_NUMBER = 35;
+    static readonly CHAR_PLUS = 43;
+    static readonly CHAR_MINUS = 45;
+    static readonly CHAR_PERIOD = 46;
+    static readonly CHAR_SLASH = 47;
+    static readonly CHAR_DIVISION_SLASH = 8725;
+    static readonly CHAR_FRACTION_SLASH = 8260;
+    static readonly CHAR_ONE_QUARTER = 188;
+    static readonly CHAR_ONE_HALF = 189;
+    static readonly CHAR_THREE_QUARTER = 190;
+    static readonly CHAR_DIGIT_ZERO = 48;
+    static readonly CHAR_DIGIT_NINE = 57;
+    static readonly CHAR_UPPER_E = 69;
+    static readonly CHAR_LOWER_E = 101;
+    private static _LOCALE_DECIMAL_SEPARATOR;
+    private static _LOCALE_THOUSAND_SEPARATOR;
+    /** Return the decimal separator for the current locale. */
+    static get LocaleSpecificDecimalSeparator(): string;
+    /** Return the thousand separator for the current locale. */
+    static get LocaleSpecificThousandSeparator(): string;
+}
+//# sourceMappingURL=Constants.d.ts.map

package/lib/esm/Constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.d.ts","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,gBAAuB,UAAU,MAAM;IACvC,gBAAuB,UAAU,MAAM;IACvC,gBAAuB,WAAW,MAAM;IACxC,gBAAuB,SAAS,MAAM;IACtC,gBAAuB,UAAU,MAAM;IACvC,gBAAuB,WAAW,MAAM;IACxC,gBAAuB,UAAU,MAAM;IACvC,gBAAuB,mBAAmB,QAAQ;IAClD,gBAAuB,mBAAmB,QAAQ;IAClD,gBAAuB,gBAAgB,OAAO;IAC9C,gBAAuB,aAAa,OAAO;IAC3C,gBAAuB,kBAAkB,OAAO;IAChD,gBAAuB,eAAe,MAAM;IAC5C,gBAAuB,eAAe,MAAM;IAC5C,gBAAuB,YAAY,MAAM;IACzC,gBAAuB,YAAY,OAAO;IAC1C,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAM;IAC9C,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAM;IAE/C,2DAA2D;IAC3D,WAAkB,8BAA8B,IAAI,MAAM,CAUzD;IAED,4DAA4D;IAC5D,WAAkB,+BAA+B,IAAI,MAAM,CAU1D;CACF"}

package/lib/esm/Constants.js

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable @typescript-eslint/naming-convention */
+/** Constants used internally for both formatting and parsing.
+ * @internal
+ */
+export class QuantityConstants {
+    /** Return the decimal separator for the current locale. */
+    static get LocaleSpecificDecimalSeparator() {
+        if (QuantityConstants._LOCALE_DECIMAL_SEPARATOR.length > 0)
+            return QuantityConstants._LOCALE_DECIMAL_SEPARATOR;
+        QuantityConstants._LOCALE_DECIMAL_SEPARATOR = ".";
+        const matches = (12345.6789).toLocaleString().match(/345(.*)67/);
+        if (matches && matches.length > 1)
+            QuantityConstants._LOCALE_DECIMAL_SEPARATOR = matches[1];
+        return QuantityConstants._LOCALE_DECIMAL_SEPARATOR;
+    }
+    /** Return the thousand separator for the current locale. */
+    static get LocaleSpecificThousandSeparator() {
+        if (QuantityConstants._LOCALE_THOUSAND_SEPARATOR.length > 0)
+            return QuantityConstants._LOCALE_THOUSAND_SEPARATOR;
+        QuantityConstants._LOCALE_THOUSAND_SEPARATOR = ",";
+        const matches = (12345.6789).toLocaleString().match(/12(.*)345/);
+        if (matches && matches.length > 0)
+            QuantityConstants._LOCALE_THOUSAND_SEPARATOR = matches[1];
+        return QuantityConstants._LOCALE_THOUSAND_SEPARATOR;
+    }
+}
+QuantityConstants.CHAR_COMMA = 44;
+QuantityConstants.CHAR_SPACE = 32;
+QuantityConstants.CHAR_NUMBER = 35;
+QuantityConstants.CHAR_PLUS = 43;
+QuantityConstants.CHAR_MINUS = 45;
+QuantityConstants.CHAR_PERIOD = 46;
+QuantityConstants.CHAR_SLASH = 47;
+QuantityConstants.CHAR_DIVISION_SLASH = 8725;
+QuantityConstants.CHAR_FRACTION_SLASH = 8260;
+QuantityConstants.CHAR_ONE_QUARTER = 188;
+QuantityConstants.CHAR_ONE_HALF = 189;
+QuantityConstants.CHAR_THREE_QUARTER = 190;
+QuantityConstants.CHAR_DIGIT_ZERO = 48;
+QuantityConstants.CHAR_DIGIT_NINE = 57;
+QuantityConstants.CHAR_UPPER_E = 69;
+QuantityConstants.CHAR_LOWER_E = 101;
+QuantityConstants._LOCALE_DECIMAL_SEPARATOR = "";
+QuantityConstants._LOCALE_THOUSAND_SEPARATOR = "";
+//# sourceMappingURL=Constants.js.map

package/lib/esm/Constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,yDAAyD;AAEzD;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAoB5B,2DAA2D;IACpD,MAAM,KAAK,8BAA8B;QAC9C,IAAI,iBAAiB,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC;YACxD,OAAO,iBAAiB,CAAC,yBAAyB,CAAC;QAErD,iBAAiB,CAAC,yBAAyB,GAAG,GAAG,CAAC;QAClD,MAAM,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC,cAAc,EAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAC/B,iBAAiB,CAAC,yBAAyB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE3D,OAAO,iBAAiB,CAAC,yBAAyB,CAAC;IACrD,CAAC;IAED,4DAA4D;IACrD,MAAM,KAAK,+BAA+B;QAC/C,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,MAAM,GAAG,CAAC;YACzD,OAAO,iBAAiB,CAAC,0BAA0B,CAAC;QAEtD,iBAAiB,CAAC,0BAA0B,GAAG,GAAG,CAAC;QACnD,MAAM,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC,cAAc,EAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAC/B,iBAAiB,CAAC,0BAA0B,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE5D,OAAO,iBAAiB,CAAC,0BAA0B,CAAC;IACtD,CAAC;;AA3CsB,4BAAU,GAAG,EAAE,CAAC;AAChB,4BAAU,GAAG,EAAE,CAAC;AAChB,6BAAW,GAAG,EAAE,CAAC;AACjB,2BAAS,GAAG,EAAE,CAAC;AACf,4BAAU,GAAG,EAAE,CAAC;AAChB,6BAAW,GAAG,EAAE,CAAC;AACjB,4BAAU,GAAG,EAAE,CAAC;AAChB,qCAAmB,GAAG,IAAI,CAAC;AAC3B,qCAAmB,GAAG,IAAI,CAAC;AAC3B,kCAAgB,GAAG,GAAG,CAAC;AACvB,+BAAa,GAAG,GAAG,CAAC;AACpB,oCAAkB,GAAG,GAAG,CAAC;AACzB,iCAAe,GAAG,EAAE,CAAC;AACrB,iCAAe,GAAG,EAAE,CAAC;AACrB,8BAAY,GAAG,EAAE,CAAC;AAClB,8BAAY,GAAG,GAAG,CAAC;AAC3B,2CAAyB,GAAG,EAAE,CAAC;AAC/B,4CAA0B,GAAG,EAAE,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\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** Constants used internally for both formatting and parsing.\n * @internal\n */\nexport class QuantityConstants {\n  public static readonly CHAR_COMMA = 44;\n  public static readonly CHAR_SPACE = 32;\n  public static readonly CHAR_NUMBER = 35;\n  public static readonly CHAR_PLUS = 43;\n  public static readonly CHAR_MINUS = 45;\n  public static readonly CHAR_PERIOD = 46;\n  public static readonly CHAR_SLASH = 47;\n  public static readonly CHAR_DIVISION_SLASH = 8725;\n  public static readonly CHAR_FRACTION_SLASH = 8260;\n  public static readonly CHAR_ONE_QUARTER = 188;\n  public static readonly CHAR_ONE_HALF = 189;\n  public static readonly CHAR_THREE_QUARTER = 190;\n  public static readonly CHAR_DIGIT_ZERO = 48;\n  public static readonly CHAR_DIGIT_NINE = 57;\n  public static readonly CHAR_UPPER_E = 69;\n  public static readonly CHAR_LOWER_E = 101;\n  private static _LOCALE_DECIMAL_SEPARATOR = \"\";\n  private static _LOCALE_THOUSAND_SEPARATOR = \"\";\n\n  /** Return the decimal separator for the current locale. */\n  public static get LocaleSpecificDecimalSeparator(): string {\n    if (QuantityConstants._LOCALE_DECIMAL_SEPARATOR.length > 0)\n      return QuantityConstants._LOCALE_DECIMAL_SEPARATOR;\n\n    QuantityConstants._LOCALE_DECIMAL_SEPARATOR = \".\";\n    const matches = (12345.6789).toLocaleString()!.match(/345(.*)67/);\n    if (matches && matches.length > 1)\n      QuantityConstants._LOCALE_DECIMAL_SEPARATOR = matches[1];\n\n    return QuantityConstants._LOCALE_DECIMAL_SEPARATOR;\n  }\n\n  /** Return the thousand separator for the current locale. */\n  public static get LocaleSpecificThousandSeparator(): string {\n    if (QuantityConstants._LOCALE_THOUSAND_SEPARATOR.length > 0)\n      return QuantityConstants._LOCALE_THOUSAND_SEPARATOR;\n\n    QuantityConstants._LOCALE_THOUSAND_SEPARATOR = \",\";\n    const matches = (12345.6789).toLocaleString()!.match(/12(.*)345/);\n    if (matches && matches.length > 0)\n      QuantityConstants._LOCALE_THOUSAND_SEPARATOR = matches[1];\n\n    return QuantityConstants._LOCALE_THOUSAND_SEPARATOR;\n  }\n}\n"]}

package/lib/esm/Exception.d.ts

@@ -0,0 +1,27 @@
+/** @packageDocumentation
+ * @module Quantity
+ */
+import { BentleyError } from "@itwin/core-bentley";
+/**
+ * Status codes used during Quantity parsing and formatting processing.
+ * @beta
+ */
+export declare enum QuantityStatus {
+    QUANTITY_ERROR_BASE = 35039,
+    Success = 0,
+    InvalidJson = 35040,
+    InvalidCompositeFormat = 35041,
+    UnableToGenerateParseTokens = 35042,
+    NoValueOrUnitFoundInString = 35043,
+    UnitLabelSuppliedButNotMatched = 35044,
+    UnknownUnit = 35045,
+    UnableToConvertParseTokensToQuantity = 35046
+}
+/** The error type thrown by this module. See [[QuantityStatus]] for `errorNumber` values.
+ * @beta
+ */
+export declare class QuantityError extends BentleyError {
+    readonly errorNumber: number;
+    constructor(errorNumber: number, message?: string);
+}
+//# sourceMappingURL=Exception.d.ts.map

package/lib/esm/Exception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exception.d.ts","sourceRoot":"","sources":["../../src/Exception.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;GAGG;AACH,oBAAY,cAAc;IACxB,mBAAmB,QAAS;IAC5B,OAAO,IAAI;IACX,WAAW,QAA0B;IACrC,sBAAsB,QAA0B;IAChD,2BAA2B,QAA0B;IACrD,0BAA0B,QAA0B;IACpD,8BAA8B,QAA0B;IACxD,WAAW,QAA0B;IACrC,oCAAoC,QAA0B;CAC/D;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY;aACD,WAAW,EAAE,MAAM;gBAAnB,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;CAGlF"}

package/lib/esm/Exception.js

@@ -0,0 +1,34 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BentleyError } from "@itwin/core-bentley";
+/**
+ * Status codes used during Quantity parsing and formatting processing.
+ * @beta
+ */
+export var QuantityStatus;
+(function (QuantityStatus) {
+    QuantityStatus[QuantityStatus["QUANTITY_ERROR_BASE"] = 35039] = "QUANTITY_ERROR_BASE";
+    QuantityStatus[QuantityStatus["Success"] = 0] = "Success";
+    QuantityStatus[QuantityStatus["InvalidJson"] = 35040] = "InvalidJson";
+    QuantityStatus[QuantityStatus["InvalidCompositeFormat"] = 35041] = "InvalidCompositeFormat";
+    QuantityStatus[QuantityStatus["UnableToGenerateParseTokens"] = 35042] = "UnableToGenerateParseTokens";
+    QuantityStatus[QuantityStatus["NoValueOrUnitFoundInString"] = 35043] = "NoValueOrUnitFoundInString";
+    QuantityStatus[QuantityStatus["UnitLabelSuppliedButNotMatched"] = 35044] = "UnitLabelSuppliedButNotMatched";
+    QuantityStatus[QuantityStatus["UnknownUnit"] = 35045] = "UnknownUnit";
+    QuantityStatus[QuantityStatus["UnableToConvertParseTokensToQuantity"] = 35046] = "UnableToConvertParseTokensToQuantity";
+})(QuantityStatus || (QuantityStatus = {}));
+/** The error type thrown by this module. See [[QuantityStatus]] for `errorNumber` values.
+ * @beta
+ */
+export class QuantityError extends BentleyError {
+    constructor(errorNumber, message) {
+        super(errorNumber, message);
+        this.errorNumber = errorNumber;
+    }
+}
+//# sourceMappingURL=Exception.js.map

package/lib/esm/Exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exception.js","sourceRoot":"","sources":["../../src/Exception.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB,qFAA4B,CAAA;IAC5B,yDAAW,CAAA;IACX,qEAAqC,CAAA;IACrC,2FAAgD,CAAA;IAChD,qGAAqD,CAAA;IACrD,mGAAoD,CAAA;IACpD,2GAAwD,CAAA;IACxD,qEAAqC,CAAA;IACrC,uHAA8D,CAAA;AAChE,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C,YAA4C,WAAmB,EAAE,OAAgB;QAC/E,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QADc,gBAAW,GAAX,WAAW,CAAQ;IAE/D,CAAC;CACF","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 { BentleyError } from \"@itwin/core-bentley\";\n\n/**\n * Status codes used during Quantity parsing and formatting processing.\n * @beta\n */\nexport enum QuantityStatus {\n  QUANTITY_ERROR_BASE = 0x88DF,\n  Success = 0,\n  InvalidJson = QUANTITY_ERROR_BASE + 1,\n  InvalidCompositeFormat = QUANTITY_ERROR_BASE + 2,\n  UnableToGenerateParseTokens = QUANTITY_ERROR_BASE + 3,\n  NoValueOrUnitFoundInString = QUANTITY_ERROR_BASE + 4,\n  UnitLabelSuppliedButNotMatched = QUANTITY_ERROR_BASE + 5,\n  UnknownUnit = QUANTITY_ERROR_BASE + 6,\n  UnableToConvertParseTokensToQuantity = QUANTITY_ERROR_BASE + 7,\n}\n\n/** The error type thrown by this module. See [[QuantityStatus]] for `errorNumber` values.\n * @beta\n */\nexport class QuantityError extends BentleyError {\n  public constructor(public override readonly errorNumber: number, message?: string) {\n    super(errorNumber, message);\n  }\n}\n"]}

package/lib/esm/Formatter/Format.d.ts

@@ -0,0 +1,96 @@
+/** @packageDocumentation
+ * @module Quantity
+ */
+import { UnitProps, UnitsProvider } from "../Interfaces";
+import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "./FormatEnums";
+import { CloneOptions, FormatProps } from "./Interfaces";
+/** A class used to define the specifications for formatting quantity values. This class is typically loaded by reading [[FormatProps]].
+ * @beta
+ */
+export declare class Format {
+    private _name;
+    protected _roundFactor: number;
+    protected _type: FormatType;
+    protected _precision: number;
+    protected _minWidth?: number;
+    protected _scientificType?: ScientificType;
+    protected _showSignOption: ShowSignOption;
+    protected _decimalSeparator: string;
+    protected _thousandSeparator: string;
+    protected _uomSeparator: string;
+    protected _stationSeparator: string;
+    protected _stationOffsetSize?: number;
+    protected _formatTraits: FormatTraits;
+    protected _spacer: string;
+    protected _includeZero: boolean;
+    protected _units?: Array<[UnitProps, string | undefined]>;
+    protected _customProps?: any;
+    /** Constructor
+     *  @param name     The name of a format specification. TODO: make optional or remove
+     */
+    constructor(name: string);
+    get name(): string;
+    get roundFactor(): number;
+    get type(): FormatType;
+    get precision(): DecimalPrecision | FractionalPrecision;
+    get minWidth(): number | undefined;
+    get scientificType(): ScientificType | undefined;
+    get showSignOption(): ShowSignOption;
+    get decimalSeparator(): string;
+    get thousandSeparator(): string;
+    get uomSeparator(): string;
+    get stationSeparator(): string;
+    get stationOffsetSize(): number | undefined;
+    get formatTraits(): FormatTraits;
+    get spacer(): string;
+    get includeZero(): boolean;
+    get units(): Array<[UnitProps, string | undefined]> | undefined;
+    get hasUnits(): boolean;
+    get customProps(): any;
+    static scientificTypeToString(scientificType: ScientificType): string;
+    /** This method parses input string that is typically extracted for persisted JSON data and validates that the string is a valid ScientificType. Throws exception if not valid. */
+    static parseScientificType(scientificType: string, formatName: string): ScientificType;
+    /** Method used when generating a JSON object that represents this Format. */
+    static showSignOptionToString(showSign: ShowSignOption): string;
+    /** This method parses input string that is typically extracted for persisted JSON data and validates that the string is a valid ShowSignOption. Throws exception if not valid. */
+    static parseShowSignOption(showSignOption: string, formatName: string): ShowSignOption;
+    static isFormatTraitSetInProps(formatProps: FormatProps, trait: FormatTraits): boolean;
+    /** Get string used in FormatProps  */
+    static getTraitString(trait: FormatTraits): "trailZeroes" | "keepSingleZero" | "zeroEmpty" | "keepDecimalPoint" | "applyRounding" | "fractionDash" | "showUnitLabel" | "prependUnitLabel" | "use1000Separator" | "exponentOnlyNegative";
+    /** Method used when generating a JSON object that represents this Format. */
+    static formatTraitsToArray(currentFormatTrait: FormatTraits): string[];
+    /** This method parses input string that is typically extracted for persisted JSON data and validates that the string is a valid FormatTrait. Throws exception if not valid. */
+    static parseFormatTrait(stringToCheck: string, currentFormatTrait: number): FormatTraits;
+    /** Get FormatTrait from entry in FormatProps */
+    static parseFormatTraits(formatTraitsFromJson: string | string[] | undefined): FormatTraits | undefined;
+    /** Method used when generating a JSON object that represents this Format. */
+    static formatTypeToString(type: FormatType): string;
+    /** This method parses input string that is typically extracted for persisted JSON data and validates that the string is a valid FormatType. Throws exception if not valid. */
+    static parseFormatType(jsonObjType: string, formatName: string): FormatType;
+    /** This method validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision. Throws exception if not valid. */
+    static parseDecimalPrecision(jsonObjPrecision: number): DecimalPrecision;
+    /** This method validates the input value, that is typically extracted for persisted JSON data, is a valid FractionalPrecision. Throws exception if not valid. */
+    static parseFractionalPrecision(jsonObjPrecision: number, formatName: string): FractionalPrecision;
+    /** This method validates the input value, that is typically extracted for persisted JSON data, is a valid DecimalPrecision or FractionalPrecision. Throws exception if not valid. */
+    static parsePrecision(precision: number, formatName: string, type: FormatType): DecimalPrecision | FractionalPrecision;
+    private verifyFormatTraitsOptions;
+    /** This method returns true if the formatTrait is set in this Format object. */
+    hasFormatTraitSet(formatTrait: FormatTraits): boolean;
+    private createUnit;
+    /**
+     *  Clone Format
+     */
+    clone(options?: CloneOptions): Format;
+    private loadFormatProperties;
+    /**
+     * Populates this Format with the values from the provided.
+     */
+    fromJSON(unitsProvider: UnitsProvider, jsonObj: FormatProps): Promise<void>;
+    /** Create a Format from FormatProps */
+    static createFromJSON(name: string, unitsProvider: UnitsProvider, formatProps: FormatProps): Promise<Format>;
+    /**
+     * Returns a JSON object that contain the specification for this Format.
+     */
+    toJSON(): FormatProps;
+}
+//# sourceMappingURL=Format.d.ts.map

package/lib/esm/Formatter/Format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Formatter/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAChI,OAAO,EAAE,YAAY,EAAqB,WAAW,EAAuB,MAAM,cAAc,CAAC;AAKjG;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAM;IACnB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAO;IACrC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAsB;IACjD,SAAS,CAAC,UAAU,EAAE,MAAM,CAAwB;IACpD,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IAC3C,SAAS,CAAC,eAAe,EAAE,cAAc,CAA+B;IACxE,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAoD;IACvF,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAqD;IACzF,SAAS,CAAC,aAAa,SAAO;IAC9B,SAAS,CAAC,iBAAiB,SAAO;IAClC,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,aAAa,EAAE,YAAY,CAAO;IAC5C,SAAS,CAAC,OAAO,EAAE,MAAM,CAAO;IAChC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAQ;IACvC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAE7B;;OAEG;gBACS,IAAI,EAAE,MAAM;IAIxB,IAAW,IAAI,IAAI,MAAM,CAAuB;IAChD,IAAW,WAAW,IAAI,MAAM,CAA8B;IAC9D,IAAW,IAAI,IAAI,UAAU,CAAuB;IACpD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAA4B;IAC1F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA2B;IACpE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAiC;IACxF,IAAW,cAAc,IAAI,cAAc,CAAiC;IAC5E,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,iBAAiB,IAAI,MAAM,CAAoC;IAC1E,IAAW,YAAY,IAAI,MAAM,CAA+B;IAChE,IAAW,gBAAgB,IAAI,MAAM,CAAmC;IACxE,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAoC;IACtF,IAAW,YAAY,IAAI,YAAY,CAA+B;IACtE,IAAW,MAAM,IAAI,MAAM,CAAyB;IACpD,IAAW,WAAW,IAAI,OAAO,CAA8B;IAC/D,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAC9F,IAAW,QAAQ,IAAI,OAAO,CAAgE;IAC9F,IAAW,WAAW,IAAI,GAAG,CAA8B;WAG7C,sBAAsB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM;IAO5E,kLAAkL;WACpK,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc;IAW7F,6EAA6E;WAC/D,sBAAsB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM;IAatE,kLAAkL;WACpK,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc;WAe/E,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY;IAQnF,sCAAsC;WACxB,cAAc,CAAC,KAAK,EAAE,YAAY;IA0BhD,6EAA6E;WAC/D,mBAAmB,CAAC,kBAAkB,EAAE,YAAY,GAAG,MAAM,EAAE;IAiB7E,+KAA+K;WACjK,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,YAAY;IA2B/F,gDAAgD;WAClC,iBAAiB,CAAC,oBAAoB,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;IAenF,6EAA6E;WAC/D,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAa1D,8KAA8K;WAChK,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,UAAU;IAelF,8JAA8J;WAChJ,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB;IAiC/E,iKAAiK;WACnJ,wBAAwB,CAAC,gBAAgB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,mBAAmB;IAyBzG,qLAAqL;WACvK,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,gBAAgB,GAAG,mBAAmB;IAW7H,OAAO,CAAC,yBAAyB;IAOjC,gFAAgF;IACzE,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO;YAI9C,UAAU;IAcxB;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAmD5C,OAAO,CAAC,oBAAoB;IAgG5B;;OAEG;IACU,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuCxF,uCAAuC;WACnB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW;IAMvG;;OAEG;IACI,MAAM,IAAI,WAAW;CAmD7B"}