@harshrathi.dev/number-abbreviator

number-abbreviator

number-abbreviator is a simple utility for abbreviating large numbers with suffixes (K, M, B, T) to enhance readability. Perfect for financial data, statistics, or any numerical information where brevity improves user experience.

Features

• Converts numbers into human-readable formats with suffixes.
• Supports a wide range of numbers, from 0 to trillions.
• Easy to integrate into any JavaScript or TypeScript project.

Installation

To install number-abbreviator, use npm:

npm install number-abbreviator

Or with yarn:

yarn add number-abbreviator

Usage

Here's how to use number-abbreviator in your project:

JavaScript

const { formatNumber } = require('number-abbreviator');

console.log(formatNumber(123));        // Output: 123
console.log(formatNumber(1234));       // Output: 1.2K
console.log(formatNumber(1234567));    // Output: 1.2M
console.log(formatNumber(1234567890)); // Output: 1.2B
console.log(formatNumber(1234567890123)); // Output: 1.2T

TypeScript

import { formatNumber } from 'number-abbreviator';

console.log(formatNumber(123));        // Output: 123
console.log(formatNumber(1234));       // Output: 1.2K
console.log(formatNumber(1234567));    // Output: 1.2M
console.log(formatNumber(1234567890)); // Output: 1.2B
console.log(formatNumber(1234567890123)); // Output: 1.2T

API

formatNumber(n: number): string

• n: The number to be formatted.
• Returns: A string representing the number with an appropriate suffix (K, M, B, T).

Examples

• formatNumber(500) returns "500"
• formatNumber(1500) returns "1.5K"
• formatNumber(2000000) returns "2.0M"

License

MIT License

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

Contact

For any questions or feedback, please reach out to [e-mail].