ui-formatter 0.1.1 → 0.1.2

package/README.md

@@ -1 +1,446 @@
-# ui-formatter
+# ui-formatter
+
+A lightweight, zero-dependency TypeScript utility library for formatting dates, times, numbers, and phone numbers.
+
+Designed for applications that require **high performance**, **small bundle size**, and **no external dependencies**.
+
+---
+
+## Features
+
+- 🚀 Zero dependencies
+- ⚡ High-performance implementations
+- 📅 Date formatting
+- 🕒 Time formatting
+- 🔢 Number formatting
+- ☎️ Phone/Fax formatting
+- 🧹 Phone normalization
+- 💯 TypeScript support
+- 🌍 Works in Browser and Node.js
+
+---
+
+## Installation
+
+```bash
+npm install ui-formatter
+```
+
+or
+
+```bash
+yarn add ui-formatter
+```
+
+---
+
+## Quick Example
+
+```ts
+import {
+    formatDate,
+    formatDateTime,
+    formatNumber,
+    formatInteger,
+    formatPhone
+} from "ui-formatter"
+
+const date = new Date()
+
+formatDate(date, "MM/dd/yyyy")
+// 07/02/2026
+
+formatDateTime(date, "yyyy-MM-dd")
+// 2026-07-02 14:35
+
+formatNumber(1234567.89, 2)
+// 1,234,567.89
+
+formatInteger(1000000)
+// 1,000,000
+
+formatPhone("8005551234")
+// 800 555-1234
+```
+
+---
+
+# API
+
+---
+
+## Date Utilities
+
+### getDateFormat()
+
+Returns the default date format.
+
+```ts
+const format = getDateFormat()
+
+// M/d/yyyy
+```
+
+---
+
+### addDays()
+
+Returns a new date with the specified number of days added.
+
+```ts
+const tomorrow = addDays(new Date(), 1)
+```
+
+---
+
+### formatDate()
+
+Formats a Date using a custom format.
+
+Supported tokens:
+
+| Token | Description |
+|--------|-------------|
+| yyyy | 4-digit year |
+| yy | 2-digit year |
+| MM | 2-digit month |
+| M | Month |
+| dd | 2-digit day |
+| d | Day |
+
+Example
+
+```ts
+formatDate(new Date(), "yyyy-MM-dd")
+
+// 2026-07-02
+```
+
+---
+
+### formatTime()
+
+Returns
+
+```
+HH:mm
+```
+
+Example
+
+```ts
+formatTime(new Date())
+
+// 15:30
+```
+
+---
+
+### formatLongTime()
+
+Returns
+
+```
+HH:mm:ss
+```
+
+Example
+
+```ts
+formatLongTime(new Date())
+
+// 15:30:45
+```
+
+---
+
+### formatFullTime()
+
+Returns
+
+```
+HH:mm:ss.SSS
+```
+
+Example
+
+```ts
+formatFullTime(new Date())
+
+// 15:30:45.123
+```
+
+---
+
+### formatDateTime()
+
+Formats
+
+```
+<Date> <HH:mm>
+```
+
+Example
+
+```ts
+formatDateTime(new Date(), "yyyy-MM-dd")
+
+// 2026-07-02 15:30
+```
+
+---
+
+### formatLongDateTime()
+
+Formats
+
+```
+<Date> <HH:mm:ss>
+```
+
+---
+
+### formatFullDateTime()
+
+Formats
+
+```
+<Date> <HH:mm:ss.SSS>
+```
+
+---
+
+### datetimeToString()
+
+Converts a Date into ISO-like format.
+
+```ts
+datetimeToString(new Date())
+
+// 2026-07-02T15:30:45
+```
+
+---
+
+### dateToString()
+
+Returns a compact timestamp.
+
+```ts
+dateToString(new Date())
+
+// 20260702153045
+```
+
+Milliseconds may be included.
+
+```ts
+dateToString(new Date(), true)
+
+// 20260702153045123
+```
+
+---
+
+# Number Utilities
+
+---
+
+### formatInteger()
+
+Formats an integer with thousands separators.
+
+```ts
+formatInteger(123456789)
+
+// 123,456,789
+```
+
+Custom separator
+
+```ts
+formatInteger(123456789, ".")
+
+// 123.456.789
+```
+
+---
+
+### formatNumber()
+
+Formats decimal numbers.
+
+```ts
+formatNumber(1234567.89, 2)
+
+// 1,234,567.89
+```
+
+Custom separators
+
+```ts
+formatNumber(
+    1234567.89,
+    2,
+    ",",
+    "."
+)
+
+// 1.234.567,89
+```
+
+---
+
+# Phone Utilities
+
+---
+
+### normalizePhone()
+
+Removes all characters except digits and `+`.
+
+```ts
+normalizePhone("(800) 555-1234")
+
+// 8005551234
+```
+
+---
+
+### normalizeFax()
+
+Alias of
+
+```
+normalizePhone()
+```
+
+---
+
+### formatPhone()
+
+Formats phone numbers into a readable representation.
+
+```ts
+formatPhone("8005551234")
+
+// 800 555-1234
+```
+
+Supports
+
+- US numbers
+- international numbers
+- partial numbers
+
+---
+
+### formatFax()
+
+Formats fax numbers.
+
+```ts
+formatFax("0212345678")
+
+// 02-12345678
+```
+
+---
+
+# Utility Functions
+
+---
+
+### isNotEmpty()
+
+Checks whether an array or string is not empty.
+
+```ts
+isNotEmpty([])
+
+// false
+
+isNotEmpty("hello")
+
+// true
+```
+
+---
+
+### isChecked()
+
+Utility for HTML templates.
+
+```ts
+isChecked(true)
+
+// checked
+
+isChecked(false)
+
+// ""
+```
+
+Can also compare string values.
+
+```ts
+isChecked("admin", "admin")
+
+// checked
+```
+
+---
+
+# Design Goals
+
+This library is designed with the following principles:
+
+- Zero runtime dependencies
+- High performance
+- Minimal allocations
+- Small bundle size
+- Predictable behavior
+- Browser and Node compatibility
+
+Several implementations avoid regular expressions and repeated string concatenation in favor of allocation-friendly algorithms.
+
+---
+
+# Performance
+
+The library includes optimized implementations for:
+
+- Manual date parsing
+- Number formatting
+- Integer formatting
+- Phone normalization
+
+Many functions use:
+
+- single-pass parsing
+- preallocated buffers
+- minimal temporary objects
+
+making them suitable for high-throughput applications.
+
+---
+
+# Browser Support
+
+Works in:
+
+- Chrome
+- Firefox
+- Safari
+- Edge
+- Node.js
+- Bun
+- Deno
+
+---
+
+# TypeScript
+
+Fully written in TypeScript.
+
+No additional typings are required.

package/lib/index.js

@@ -233,7 +233,7 @@ var formatter = (function () {
       return "";
     }
     var s = phone;
-    var x = removePhoneFormat(phone);
+    var x = normalizePhone(phone);
     if (x.length === 10) {
       var USNumber = x.match(formatter.usPhone);
       if (USNumber != null) {
@@ -260,7 +260,7 @@ var formatter = (function () {
       return "";
     }
     var s = fax;
-    var x = removePhoneFormat(fax);
+    var x = normalizeFax(fax);
     var l = x.length;
     if (l <= 6) {
       s = x;
@@ -285,20 +285,30 @@ var formatter = (function () {
     }
     return s;
   };
-  formatter.fax = / |\-|\.|\(|\)/g;
-  formatter.phone = / |\-|\.|\(|\)/g;
   formatter.usPhone = /(\d{3})(\d{3})(\d{4})/;
   return formatter;
 }());
 exports.formatter = formatter;
-function removePhoneFormat(phone) {
-  return phone ? phone.replace(formatter.phone, "") : "";
+function normalizePhone(s) {
+  if (!s) {
+    return "";
+  }
+  var len = s.length;
+  var buf = new Array(len);
+  var j = 0;
+  for (var i = 0; i < len; i++) {
+    var c = s.charCodeAt(i);
+    if ((c >= 48 && c <= 57) || c === 43) {
+      buf[j++] = s[i];
+    }
+  }
+  return j === len ? buf.join("") : buf.slice(0, j).join("");
 }
-exports.removePhoneFormat = removePhoneFormat;
-function removeFaxFormat(fax) {
-  return fax ? fax.replace(formatter.fax, "") : "";
+exports.normalizePhone = normalizePhone;
+function normalizeFax(fax) {
+  return normalizePhone(fax);
 }
-exports.removeFaxFormat = removeFaxFormat;
+exports.normalizeFax = normalizeFax;
 function formatPhone(phone) {
   return formatter.formatPhone(phone);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui-formatter",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Format web UI",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/index.ts

@@ -253,8 +253,8 @@ export function formatNumber(v?: number | null, precision = 0, decimalSeparator?
 // tslint:disable-next-line:class-name
 export class formatter {
   // private static _preg = / |\+|\-|\.|\(|\)/g;
-  static fax = / |\-|\.|\(|\)/g
-  static phone = / |\-|\.|\(|\)/g
+  // static fax = / |\-|\.|\(|\)/g
+  // static phone = / |\-|\.|\(|\)/g
   static usPhone = /(\d{3})(\d{3})(\d{4})/
   static formatPhone(phone?: string | null): string {
     if (!phone) {
@@ -263,7 +263,7 @@ export class formatter {
     // reformat phone number
     // 555 123-4567 or (+1) 555 123-4567
     let s = phone
-    const x = removePhoneFormat(phone)
+    const x = normalizePhone(phone)
     if (x.length === 10) {
       const USNumber = x.match(formatter.usPhone)
       if (USNumber != null) {
@@ -289,7 +289,7 @@ export class formatter {
     // reformat phone number
     // 035-456745 or 02-1234567
     let s = fax
-    const x = removePhoneFormat(fax)
+    const x = normalizeFax(fax)
     const l = x.length
     if (l <= 6) {
       s = x
@@ -311,11 +311,23 @@ export class formatter {
     return s
   }
 }
-export function removePhoneFormat(phone?: string): string {
-  return phone ? phone.replace(formatter.phone, "") : ""
+export function normalizePhone(s?: string | null): string {
+  if (!s) {
+    return ""
+  }
+  const len = s.length
+  const buf = new Array<string>(len)
+  let j = 0
+  for (let i = 0; i < len; i++) {
+    const c = s.charCodeAt(i)
+    if ((c >= 48 && c <= 57) || c === 43) {
+      buf[j++] = s[i]
+    }
+  }
+  return j === len ? buf.join("") : buf.slice(0, j).join("")
 }
-export function removeFaxFormat(fax?: string): string {
-  return fax ? fax.replace(formatter.fax, "") : ""
+export function normalizeFax(fax?: string): string {
+  return normalizePhone(fax)
 }
 export function formatPhone(phone?: string | null): string {
   return formatter.formatPhone(phone)