@matsukky/number v0.1.0

A minimalist library that converts numbers to their word representation in various languages. Zero dependencies, tree-shakeable, and type-safe.

Table of Contents

• Installation
• Features
• Usage
  • Basic Usage
  • Localization
  • Capitalization

Installation

npm install @matsukky/number
# or
yarn add @matsukky/number
# or
bun add @matsukky/number

Features

• 🪶 Lightweight
• 📦 Zero dependencies
• 🌍 Support for multiple languages
• 🔠 Automatic capitalization
• 💪 Fully typed (TypeScript)

Usage

Basic Usage

import convertNumberToWords from '@matsukky/number';

console.log(convertNumberToWords(42));    // "forty-two"
console.log(convertNumberToWords(100));   // "one hundred"
console.log(convertNumberToWords(1337));  // "one thousand three hundred thirty-seven"
console.log(convertNumberToWords(-42));   // "minus forty-two"

Localization

import { locale, convertNumberToWords } from '@matsukky/number';

// Load French locale
await locale('fr');

console.log(convertNumberToWords(42));    // "quarante-deux"
console.log(convertNumberToWords(100));   // "cent"

Capitalization

import convertNumberToWords from '@matsukky/number';

console.log(convertNumberToWords(42, { capitalize: true }));    // "Forty-two"
console.log(convertNumberToWords(100, { capitalize: true }));   // "One hundred"

API Reference

convertNumberToWords(number, options)

convertNumberToWords(
  num: number, 
  options?: {
    capitalize?: boolean;
    language?: AvalaibleLanguage;
  }
): string

locale(language, define?)

locale(
  language: AvalaibleLanguage, 
  define?: boolean
): Promise<void>

Supported Languages

• English (en)
• French (fr)
• Belgian French (fr-BE)
• Spanish (es)
• Italian (it)
• German (de)
• Japanese (ja)
• Chinese (zh)
• Arabic (ar)
• Russian (ru)

Each language implementation includes:

• Basic numbers (0-9)
• Teens (11-19)
• Tens (20, 30, etc.)
• Hundreds
• Powers of thousands (thousand, million, billion, etc.)
• Negative numbers support