@poly-kit/number-utils
v0.0.1
Published
Number utilities for JavaScript, TypeScript, React and Angular
Downloads
49
Maintainers
Readme
@poly-kit/number-utils
A comprehensive number utilities package for JavaScript, TypeScript, React, and Angular applications.
📦 Installation
npm install @poly-kit/number-utils
# or
yarn add @poly-kit/number-utils
# or
pnpm add @poly-kit/number-utils
🔨 Usage
The package provides utilities for:
- Core number formatting and manipulation
- React number components and hooks
- Angular number services and components
Core Package
import { formatNumber, formatCurrency } from '@poly-kit/number-utils';
// Format a number with thousand separators
const formatted = formatNumber(1234567.89); // "1,234,567.89"
// Format as currency
const currency = formatCurrency(1234.56); // "$1,234.56"
React Components
import { NumberInput } from '@poly-kit/number-utils/react';
function App() {
return (
<NumberInput
value={1234.56}
onChange={value => console.log(value)}
format="currency"
/>
);
}
Angular Components
import { NumberInputModule } from '@poly-kit/number-utils/angular';
@NgModule({
imports: [NumberInputModule],
// ...
})
export class AppModule {}
📚 Documentation
🌟 Features
- 📊 Comprehensive number formatting
- 💱 Currency formatting with locale support
- 📈 Statistical operations
- 🔢 Number parsing and validation
- ⚛️ React components
- 🅰️ Angular components
- 🌍 Internationalization support
- 💪 TypeScript support
- 🧪 Thoroughly tested
📖 API Overview
Core Functions
Formatting Functions
formatNumber()
- Format numbers with separatorsformatCurrency()
- Format as currencyformatPercentage()
- Format as percentageformatWithUnit()
- Format with unit prefixesformatOrdinal()
- Format as ordinal numbers
Math Operations
clamp()
- Restrict number to rangeroundToPrecision()
- Round with precisioninterpolate()
- Linear interpolationnormalize()
- Normalize to range
Statistical Functions
average()
- Calculate averagemedian()
- Calculate medianmode()
- Calculate modesum()
- Calculate sum
Utility Functions
parseNumber()
- Parse string to numberrandom()
- Generate random numbersmaskNumber()
- Mask sensitive numberscompareNumbers()
- Compare numbers- And more...
See detailed documentation for each package:
📝 License
MIT © Srikar Phani Kumar Marti