0.0.1 โข Published 1 year ago
@poly-kit/number-utils v0.0.1
@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
0.0.1
1 year ago