dimensional/types/config.d.ts

Dimensional analysis and unit conversions

/**
 * Global configuration options for the `dimensional` package
 */
export declare const config: {
    /**
     * Automatically convert dimension, unit, and prefix names to LaTeX `text` elements\
     * Default: `true`
     */
    convertToText: boolean;
    /**
     * The symbol to use for dimensionless and unitless quantities\
     * Default: `1`
     */
    scalarSymbol: string;
    /**
     * The LaTeX symbol for combined units or dimensions by multiplication\
     * Default: `\cdot`
     */
    multiplySymbol: string;
    /**
     * The number of decimals displayed when converting quantities to strings\
     * Default: `3`
     */
    decimalsShown: number;
    /**
     * Always display the unit on a quantity, even for unitless quantities.\
     * Default: `true`
     */
    showUnitless: boolean;
    /**
     * The base-10 magnitude bounds at which numeric values are displayed in scientific notation
     */
    scientificNotationMagnitude: {
        /**
         * The minimum magnitude for standard notation\
         * Default: `-6` (0.000 001)
         */
        min: number;
        /**
         * The maximum magnitude for standard notation\
         * Default: `6` (1,000,000)
         */
        max: number;
    };
    /**
     * Characters in LaTeX that mark the beginning and end of a unit within a quantity
     */
    unitDelimiters: {
        /**
         * The left side\
         * Default: `\left[`
         */
        left: string;
        /**
         * The right side\
         * Default: `\right]`
         */
        right: string;
    };
};