import { BytesFormatOptions as BytesFormatOptions } from './bytes'; import { DecimalFormatOptions as DecimalFormatOptions } from './decimal'; import { PercentFormatOptions as PercentFormatOptions } from './percent'; import { TimeFormatOptions as TimeFormatOptions } from './time'; import { UnitGroup, UnitGroupConfig, UnitConfig } from './types'; import { ThroughputFormatOptions } from './throughput'; /** * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript. * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time. * * To format bytes, we also make use of the `numbro` package, * because it can handle adding units like KB, MB, GB, etc. correctly. */ export declare const UNIT_GROUP_CONFIG: Readonly>; export declare const UNIT_CONFIG: { readonly "bits/sec": UnitConfig; readonly "bytes/sec": UnitConfig; readonly "counts/sec": UnitConfig; readonly "events/sec": UnitConfig; readonly "messages/sec": UnitConfig; readonly "ops/sec": UnitConfig; readonly "packets/sec": UnitConfig; readonly "reads/sec": UnitConfig; readonly "records/sec": UnitConfig; readonly "requests/sec": UnitConfig; readonly "rows/sec": UnitConfig; readonly "writes/sec": UnitConfig; readonly bytes: UnitConfig; readonly decimal: UnitConfig; readonly percent: UnitConfig; readonly "percent-decimal": UnitConfig; readonly "%": UnitConfig; readonly milliseconds: UnitConfig; readonly seconds: UnitConfig; readonly minutes: UnitConfig; readonly hours: UnitConfig; readonly days: UnitConfig; readonly weeks: UnitConfig; readonly months: UnitConfig; readonly years: UnitConfig; }; export type FormatOptions = TimeFormatOptions | PercentFormatOptions | DecimalFormatOptions | BytesFormatOptions | ThroughputFormatOptions; type HasDecimalPlaces = UnitOpt extends { decimalPlaces?: number; } ? UnitOpt : never; type HasShortValues = UnitOpt extends { shortValues?: boolean; } ? UnitOpt : never; export declare function formatValue(value: number, formatOptions?: FormatOptions): string; export declare function getUnitConfig(formatOptions: FormatOptions): UnitConfig; export declare function getUnitGroup(formatOptions: FormatOptions): UnitGroup; export declare function getUnitGroupConfig(formatOptions: FormatOptions): UnitGroupConfig; export declare function isTimeUnit(formatOptions: FormatOptions): formatOptions is TimeFormatOptions; export declare function isPercentUnit(formatOptions: FormatOptions): formatOptions is PercentFormatOptions; export declare function isDecimalUnit(formatOptions: FormatOptions): formatOptions is DecimalFormatOptions; export declare function isBytesUnit(formatOptions: FormatOptions): formatOptions is BytesFormatOptions; export declare function isUnitWithDecimalPlaces(formatOptions: FormatOptions): formatOptions is HasDecimalPlaces; export declare function isUnitWithShortValues(formatOptions: FormatOptions): formatOptions is HasShortValues; export declare function isThroughputUnit(formatOptions: FormatOptions): formatOptions is ThroughputFormatOptions; export {}; //# sourceMappingURL=units.d.ts.map