@rezzon8/math-utils
v1.2.1
Published
Basic set of math utility functions
Downloads
630
Readme
@rezzon8/math-utils
Basic math utility functions with TypeScript support.
Installation
npm install @rezzon8/math-utilsUsage
import { add, subtract, multiply, divide, modulus } from '@rezzon8/math-utils'
// Addition
const sum = add(5, 3) // 8
// Subtraction
const difference = subtract(10, 4) // 6
// Multiplication
const product = multiply(6, 7) // 42
// Division
const quotient = divide(20, 5) // 4
// Modulus
const remainder = modulus(17, 5) // 2
// Division by zero throws an error
try {
divide(10, 0)
} catch (error) {
console.error(error.message) // "Division by zero is not allowed"
}API
add(a: number, b: number): number
Returns the sum of two numbers.
Parameters:
a- First numberb- Second number
Returns: The sum of a and b
subtract(a: number, b: number): number
Returns the difference of two numbers.
Parameters:
a- First numberb- Second number
Returns: The difference (a - b)
multiply(a: number, b: number): number
Returns the product of two numbers.
Parameters:
a- First numberb- Second number
Returns: The product of a and b
divide(a: number, b: number): number
Returns the quotient of two numbers.
Parameters:
a- Dividendb- Divisor
Returns: The quotient (a / b)
Throws: Error if b is zero
modulus(a: number, b: number): number
Returns the remainder of dividing two numbers.
Parameters:
a- Dividendb- Divisor
Returns: The remainder (a % b)
Development
# Install dependencies
npm install
# Run tests
npm test
# Run tests in watch mode
npm run test:watch
# Build the package
npm run build
# Lint code
npm run lint
# Fix linting issues
npm run lint:fix
# Format code
npm run format
# Check formatting
npm run format:checkFeatures
- ✅ TypeScript support with full type definitions
- ✅ ESM modules
- ✅ Comprehensive test coverage with Vitest
- ✅ Modern ESLint + Prettier configuration
- ✅ Source maps included
Repository
https://github.com/rezzon8/npm-package
License
ISC © 2025
