Math Utils 🤓

Lightweight TypeScript math utility functions

This lightweight TypeScript utility library comes with common and utility math functions.

Table of Content

• Getting started
• What's Changed
• What's inside
  • Conversion functions
  • Formatting functions
  • Helpers functions
  • Interpolation functions
  • Easing functions
  • Tween
  • Random number functions
  • Types
• Development
  • Local development
  • Production build
  • Unit tests
    • Run tests with coverage
  • Contributing
  • Security
• Credits

Getting started

Run the following command to start using math-utils in your projects:

npm i @alessiofrittoli/math-utils

or using pnpm

pnpm i @alessiofrittoli/math-utils

What's Changed

Updates in the latest release 🎉

• Welcome Tween!
• Removed deprecated easeOutCirc in favor of Easings.easeOutCirc() function. See Easing API Reference for more info.

Development

Run the following to start development

nvm use

pnpm i

Local development

Run the following

pnpm dev

This will generate unminified output code, sourcemaps and will enable source file watcher.

Production build

Run the following to create a local production build

pnpm build

This will generate minified output code without sourcemaps.

Unit tests

Run all the defined test suites by running the following:

# Run tests and watch file changes.
pnpm test:watch

# Run tests in a CI environment.
pnpm test:ci

Run tests with coverage

An HTTP server is then started to serve coverage files from ./coverage folder.

⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.

pnpm test:coverage:serve

Contributing

Contributions are truly welcome!

Please refer to the Contributing Doc for more information on how to start contributing to this project.

Help keep this project up to date with GitHub Sponsor.

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and NOT open a public issue. We will investigate all legitimate reports. Email [email protected] to disclose any security vulnerabilities.

Made with ☕

Alessio Frittoli https://alessiofrittoli.it | [email protected]