🎨 @worldkit/formatters

Formatting utilities for currencies, multi-line postal addresses, and international phone numbers in JavaScript & TypeScript.

Format prices, addresses, and phone numbers with clean, localized outputs.

📚 Full Documentation: https://worldkit.in/docs/formatters

⚡ Features

• 💵 Currency & Price Formatter: Formats monetary amounts using localized Intl.NumberFormat with automatic fallback.
• ✉️ Multi-Line Address Formatter: Formats street, city, state, postal code, and country names into standard mailing label layouts.
• 📞 Phone Number Formatter: Formats raw phone digits into international E.164 dial representations.
• 📦 Micro Size: ~1.4 KB gzipped.

📦 Install

npm install @worldkit/formatters
# or
pnpm add @worldkit/formatters
# or
yarn add @worldkit/formatters

💡 Usage

import { formatAddress, formatCurrency, formatPhone } from "@worldkit/formatters";

// 1. Format Currency Amounts
console.log(formatCurrency(1250.5, "USD", "en-US")); // "$1,250.50"
console.log(formatCurrency(1250.5, "EUR", "de-DE")); // "1.250,50 €"
console.log(formatCurrency(1250.5, "JPY", "ja-JP")); // "￥1,251"

// 2. Format Multi-Line Postal Address
const addressLabel = formatAddress({
  street: "100 Market St",
  street2: "Suite 400",
  city: "San Francisco",
  state: "CA",
  postalCode: "94105",
  country: "US"
});

console.log(addressLabel);
/*
100 Market St, Suite 400
San Francisco CA 94105
United States
*/

// 3. Format International Phone Numbers
console.log(formatPhone("9876543210", "IN")); // "+91 98765 43210"

📖 API Reference

formatCurrency(amount: number, currencyCode = "USD", locale = "en-US"): string

Formats numbers into locale-aware currency strings.

formatAddress(address: AddressInput): string

Formats an address object into a standard multi-line string block.

formatPhone(phone: string, countryIso2?: string): string

Formats phone digits into clean international phone format.

📐 TypeScript Support

Includes 100% strict TypeScript types:

import type { AddressInput } from "@worldkit/formatters";

🔗 Related Packages

Explore the rest of the WorldKit ecosystem:

• @worldkit/core - Unified global data facade.
• @worldkit/validators - Data validators suite.
• @worldkit/currencies - ISO-4217 currencies.
• @worldkit/phone - Phone lookup & rules.

📜 License

MIT © WorldKit