postcss-convert-values/types/lib/convert.d.ts

Convert values with PostCSS (e.g. ms -> s)

/**
 * @typedef {'length' | 'time' | 'angle' | 'frequency'} ConvertOption
 * @typedef {{time?: boolean, length?: boolean, angle?: boolean, frequency?: boolean}} ConvertOptions
 * @typedef {{
 *   option?: ConvertOption,
 *   factors: Map<string, number>,
 *   sourceOnly?: Set<string>,
 *   zeroOnly?: Map<string, string>,
 *   requiresZeroUnit?: boolean
 * }} UnitGroup
 */
export type ConvertOption = 'length' | 'time' | 'angle' | 'frequency';
export type ConvertOptions = {
    time?: boolean;
    length?: boolean;
    angle?: boolean;
    frequency?: boolean;
};
export type UnitGroup = {
    option?: ConvertOption;
    factors: Map<string, number>;
    sourceOnly?: Set<string>;
    zeroOnly?: Map<string, string>;
    requiresZeroUnit?: boolean;
};
/**
 * @param {string} lowerCaseUnit
 * @return {boolean}
 */
export declare function requiresZeroUnit(lowerCaseUnit: string): boolean;
/**
 * Accurately round a number to a fixed decimal precision without IEEE-754 binary
 * floating point multiplication errors.
 *
 * @param {number} value
 * @param {number} precision
 * @return {number}
 */
export declare function roundToPrecision(value: number, precision: number): number;
/**
 * Compute the shortest exact scientific notation for a number if one exists.
 *
 * @param {number} num
 * @return {string | undefined}
 */
export declare function toCompactExponent(num: number): string | undefined;
/**
 * @param {number} number
 * @return {string}
 */
export declare function dropLeadingZero(number: number): string;
/**
 * Format a number using standard decimal or compact exponent notation.
 *
 * @param {number} number
 * @param {boolean} [allowExponent=true]
 * @return {string}
 */
export declare function formatNumber(number: number, allowExponent?: boolean): string;
/**
 * @param {number} number
 * @param {string} unit
 * @param {ConvertOptions} [options]
 * @return {string}
 */
declare const convert: (number: number, unit: string, options?: ConvertOptions) => string;
export default convert;
//# sourceMappingURL=convert.d.ts.map