0.0.1 โ€ข Published 1 year ago

@poly-kit/number-utils v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@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 separators
  • formatCurrency() - Format as currency
  • formatPercentage() - Format as percentage
  • formatWithUnit() - Format with unit prefixes
  • formatOrdinal() - Format as ordinal numbers

Math Operations

  • clamp() - Restrict number to range
  • roundToPrecision() - Round with precision
  • interpolate() - Linear interpolation
  • normalize() - Normalize to range

Statistical Functions

  • average() - Calculate average
  • median() - Calculate median
  • mode() - Calculate mode
  • sum() - Calculate sum

Utility Functions

  • parseNumber() - Parse string to number
  • random() - Generate random numbers
  • maskNumber() - Mask sensitive numbers
  • compareNumbers() - Compare numbers
  • And more...

See detailed documentation for each package:

๐Ÿ“ License

MIT ยฉ Srikar Phani Kumar Marti