/** * Options for price formatting. * The intention is for this enumeration to stay in sync with the open api price formatting enumeration. However, at present * this supports more than what open api exposes. * @example * ```ts * priceFormatting.format(1.23, 2, priceFormatOptions.ModernFractions); * ``` */ declare const PriceFormatOptions: { /** * Use only specified (number of decimals/fraction size). * */ readonly Normal: "Normal"; /** * Pad fractional formats with spaces, `e.g. "7/128" -> " 7/128"` * Only used with fractional formats (decimals < 0). * */ readonly AdjustFractions: "AdjustFractions"; /** * Include fractions that are zero, e.g. "42" -> "42 0/8" * Only used with fractional formats (decimals < 0). * */ readonly IncludeZeroFractions: "IncludeZeroFractions"; /** * Special US Bonds futures fractional format (1/32s without nominator). * 1/32 fractional (decimals: -5) or with 1/2 or 1/4 of 1/32 extra precision (decimals: -6, -7) * e.g. 102.9140625 == 102 29/32 + 1/128 -> "102'29.25" * Only used with fractional formats (decimals < 0). */ readonly ModernFractions: "ModernFractions"; /** * Show as a percentage. */ readonly Percentage: "Percentage"; /** * Show as a fraction */ readonly Fractions: "Fractions"; /** * format the price as a number of pips rather than an absolute price */ readonly FormatAsPips: "FormatAsPips"; /** * Use digits for deci/half-pips. */ readonly AllowDecimalPips: "AllowDecimalPips"; /** * Use two digits for decimal pips. */ readonly AllowTwoDecimalPips: "AllowTwoDecimalPips"; /** * Use a space as separator between pips and deci-pips. */ readonly DeciPipsSpaceSeparator: "DeciPipsSpaceSeparator"; /** * Use culture specific decimal separator as separator. * Only used with AllowDecimalPips. */ readonly DeciPipsDecimalSeparator: "DeciPipsDecimalSeparator"; /** * Use '1/2' fraction character for half-pips. */ readonly DeciPipsFraction: "DeciPipsFraction"; /** Use a space instead of zero. * Only used with DeciPipsFraction. */ readonly DeciPipsSpaceForZero: "DeciPipsSpaceForZero"; /** * Use up to eight non-zero decimal digits in total. */ readonly UseExtendedDecimals: "UseExtendedDecimals"; /** * Indicates that no rounding should be done - that * decimals should be treated as a max decimals. */ readonly NoRounding: "NoRounding"; }; export declare type PriceFormatOption = keyof typeof PriceFormatOptions; export default PriceFormatOptions;