@nixat/abacus

A lightweight utility library for number operations in JavaScript and TypeScript.

Installation

npm install @nixat/abacus
# or
yarn add @nixat/abacus
# or
pnpm add @nixat/abacus

Usage

import { abacus } from '@nixat/abacus';

// Format a number with 2 decimal places
const formattedNumber = abacus.format(1234.5678, { decimals: 2 }); // "1,234.57"

// Calculate the average of an array of numbers
const avg = abacus.average([1, 2, 3, 4, 5]); // 3

// Check if a number is prime
const isPrime = abacus.isPrime(17); // true

API

Basic Operations

• isNumber(value: unknown): boolean - Checks if the provided value is a number
• clamp(num: number, min: number, max: number): number - Clamps a number between min and max values
• round(num: number, decimals?: number): number - Rounds a number to the specified number of decimal places
• format(num: number, options?: object): string - Formats a number with specified decimal and thousand separators

Statistical Functions

• sum(numbers: number[]): number - Calculates the sum of an array of numbers
• average(numbers: number[]): number - Calculates the average of an array of numbers
• median(numbers: number[]): number - Calculates the median of an array of numbers
• min(numbers: number[]): number - Finds the minimum value in an array of numbers
• max(numbers: number[]): number - Finds the maximum value in an array of numbers

Utility Functions

• random(min: number, max: number, options?: object): number - Generates a random number between min and max
• convert(value: number, fromUnit: string, toUnit: string, conversionRates: object): number - Converts a value from one unit to another
• percentage(value: number, total: number): number - Calculates the percentage of a value relative to a total
• factorial(num: number): number - Calculates the factorial of a number
• isPrime(num: number): boolean - Checks if a number is prime
• gcd(a: number, b: number): number - Calculates the greatest common divisor of two numbers
• lcm(a: number, b: number): number - Calculates the least common multiple of two numbers

License

MIT