@fremtind/jkl-formatters-util
Version:
Formatters for common data formats in Jøkul
24 lines (23 loc) • 1.18 kB
TypeScript
import { FormatNumberOptions } from "../util/formatNumber";
export type LengthUnit = "kilometer" | "meter" | "decimeter" | "centimeter" | "millimeter" | "micrometer" | "nanometer" | "picometer" | "mile" | "yard" | "foot" | "inch" | "point";
export interface FormatAvstandOptions extends FormatNumberOptions {
/**
* Lengdeenheten som skal vises for tallet, f.eks. "kilometer" eller "foot".
* Hvis du _ikke_ ønsker å vise noen enhet bør du heller bruke `formatNumber` direkte.
*
* @default "kilometer"
*/
unit?: LengthUnit;
/**
* Valgfritt suffiks som vises etter lengdeenheten. Ønsker du for eksempel
* å vise "km/år" kan du setter "kilometer" som `unit` og "/år" som `suffix`.
*/
suffix?: string;
}
/**
* Formaterer en avstand med norsk locale på tallverdien.
* @param input Verdien som skal formateres
* @param options Lengdeenheten som skal vises for tallet, f.eks. "kilometer" eller "foot". Default: "kilometer". Kan også angi en valgfri suffix, f.eks. "/år".
* @returns Den formaterte verdien.
*/
export declare function formatAvstand(input: string | number, options?: FormatAvstandOptions): string;