@tstdl/base 0.91.18 → 0.91.19

package/formats.d.ts

@@ -0,0 +1,42 @@
+export declare let locale: string;
+export declare function configureFormats(options: {
+    locale?: string;
+}): void;
+export declare const integerFormat: Intl.NumberFormatOptions;
+export declare const decimalFormat: Intl.NumberFormatOptions;
+export declare const decimal1Format: Intl.NumberFormatOptions;
+export declare const yearFormat: Intl.NumberFormatOptions;
+export declare const dateTimeNumeric: Intl.DateTimeFormatOptions;
+export declare const dateTimeShort: Intl.DateTimeFormatOptions;
+export declare const dateTimeLong: Intl.DateTimeFormatOptions;
+export declare const dateShort: Intl.DateTimeFormatOptions;
+export declare const dateMedium: Intl.DateTimeFormatOptions;
+export declare const dateLong: Intl.DateTimeFormatOptions;
+export declare const timeShort: Intl.DateTimeFormatOptions;
+export declare const euroFormat: Intl.NumberFormatOptions;
+export declare const euroFormatWithoutCents: Intl.NumberFormatOptions;
+export declare const percentFormat: Intl.NumberFormatOptions;
+export declare function formatNumber(value: number, format?: Intl.NumberFormatOptions): string;
+export declare function formatInteger(value: number): string;
+export declare function formatDecimal(value: number, minimumFractionDigits?: number, maximumFractionDigits?: number): string;
+export declare function formatYear(value: number): string;
+export declare function formatTimeShort(value: number): string;
+export declare function formatDateShort(value: Date | number): string;
+export declare function formatDate(dateOrTimestamp: number | Date): string;
+export declare function formatNumericDate(numericDate: number): string;
+export declare function formatEuro(value: number): string;
+export declare function formatPercent(value: number): string;
+export type FormatUserNameOptions = {
+    lastNameFirst?: boolean;
+    nullOnMissing?: boolean;
+};
+export declare function formatUserName(user: {
+    firstName: string;
+    lastName: string | null;
+} | null | undefined, options: FormatUserNameOptions & {
+    nullOnMissing: true;
+}): string | null;
+export declare function formatUserName(user: {
+    firstName: string;
+    lastName: string | null;
+} | null | undefined, options?: FormatUserNameOptions): string;

package/formats.js

@@ -0,0 +1,141 @@
+import { numericDateToTimestamp } from './utils/date-time.js';
+import { memoize, memoizeSingle } from './utils/function/memoize.js';
+import { isNull, isNullOrUndefined, isUndefined } from './utils/type-guards.js';
+export let locale = 'de-DE';
+export function configureFormats(options) {
+    locale = options.locale ?? locale;
+}
+export const integerFormat = {
+    useGrouping: true,
+    maximumFractionDigits: 0
+};
+export const decimalFormat = {
+    useGrouping: true,
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2
+};
+export const decimal1Format = {
+    useGrouping: true,
+    minimumFractionDigits: 0,
+    maximumFractionDigits: 1
+};
+export const yearFormat = {
+    useGrouping: false,
+    maximumFractionDigits: 0
+};
+export const dateTimeNumeric = {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit'
+};
+export const dateTimeShort = {
+    year: 'numeric',
+    month: 'short',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit'
+};
+export const dateTimeLong = {
+    year: 'numeric',
+    weekday: 'long',
+    month: 'long',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit'
+};
+export const dateShort = {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit'
+};
+export const dateMedium = {
+    year: 'numeric',
+    month: 'long',
+    day: '2-digit'
+};
+export const dateLong = {
+    year: 'numeric',
+    weekday: 'long',
+    month: 'long',
+    day: '2-digit'
+};
+export const timeShort = {
+    hour: '2-digit',
+    minute: '2-digit'
+};
+export const euroFormat = {
+    style: 'currency',
+    currency: 'EUR'
+};
+export const euroFormatWithoutCents = {
+    ...euroFormat,
+    minimumFractionDigits: 0
+};
+export const percentFormat = {
+    style: 'percent',
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2
+};
+const getDecimalFormatter = memoize(_getDecimalFormatter);
+const dateFormatter = memoizeSingle((loc) => Intl.DateTimeFormat(loc, dateShort));
+const integerFormatter = memoizeSingle((loc) => Intl.NumberFormat(loc, integerFormat));
+const decimalFormatter = memoizeSingle((loc) => Intl.NumberFormat(loc, decimalFormat));
+const yearFormatter = memoizeSingle((loc) => Intl.NumberFormat(loc, yearFormat));
+const euroFormatter = memoizeSingle((loc) => Intl.NumberFormat(loc, euroFormat));
+const percentFormatter = memoizeSingle((loc) => Intl.NumberFormat(loc, percentFormat));
+const timeShortFormatter = memoizeSingle((loc) => Intl.DateTimeFormat(loc, timeShort));
+const dateShortFormatter = memoizeSingle((loc) => Intl.DateTimeFormat(loc, dateShort));
+export function formatNumber(value, format) {
+    return Intl.NumberFormat(locale, format).format(value);
+}
+export function formatInteger(value) {
+    return integerFormatter(locale).format(value);
+}
+export function formatDecimal(value, minimumFractionDigits, maximumFractionDigits) {
+    if (isUndefined(minimumFractionDigits) && isUndefined(maximumFractionDigits)) {
+        return decimalFormatter(locale).format(value);
+    }
+    return getDecimalFormatter(minimumFractionDigits ?? 2, maximumFractionDigits ?? 2).format(value);
+}
+export function formatYear(value) {
+    return yearFormatter(locale).format(value);
+}
+export function formatTimeShort(value) {
+    return timeShortFormatter(locale).format(new Date(1970, 1, 1, 0, 0, 0, value));
+}
+export function formatDateShort(value) {
+    return dateShortFormatter(locale).format(value);
+}
+export function formatDate(dateOrTimestamp) {
+    return dateFormatter(locale).format(dateOrTimestamp);
+}
+export function formatNumericDate(numericDate) {
+    return formatDate(numericDateToTimestamp(numericDate));
+}
+export function formatEuro(value) {
+    return euroFormatter(locale).format(value);
+}
+export function formatPercent(value) {
+    return percentFormatter(locale).format(value);
+}
+export function formatUserName(user, { lastNameFirst = false, nullOnMissing = false } = {}) {
+    if (isNullOrUndefined(user)) {
+        return nullOnMissing ? null : '-';
+    }
+    if (isNull(user.lastName)) {
+        return user.firstName;
+    }
+    if (lastNameFirst) {
+        return `${user.lastName}, ${user.firstName}`;
+    }
+    return `${user.firstName} ${user.lastName}`;
+}
+function _getDecimalFormatter(minimumFractionDigits = 2, maximumFractionDigits = 2) {
+    return Intl.NumberFormat(locale, {
+        useGrouping: true,
+        minimumFractionDigits,
+        maximumFractionDigits
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.91.18",
+  "version": "0.91.19",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"