@ptolemy2002/js-math-utils
v1.0.3
Published
JavaScript math utilities
Downloads
18
Readme
JS Math Utils
This library contains mathematical utilities for JavaScript development.
The functions are not exported as default, so you can import them in one of the following ways:
// ES6
import { functionName } from '@ptolemy2002/js-math-utils';
// CommonJS
const { functionName } = require('@ptolemy2002/js-math-utils');
Functions
The following functions are available in the library:
clamp
Description
Clamps a number between a minimum and maximum value.
Parameters
value
(Number): The value to be clamped.min
(Number): The minimum value.max
(Number): The maximum value.
Returns
Number - The clamped value.
wrapNumber
Description
Wraps a number between a minimum and maximum value, non-inclusive on the maximum side (so min - 1
gets converted to max - 1
and max
gets converted to min
).
Parameters
n
(Number): The number to be wrapped.min
(Number): The minimum value.max
(Number): The maximum value.
Returns
Number - The wrapped value.
Meta
This is a React Library Created by Ptolemy2002's cra-template-react-library template in combination with create-react-app. However, it does not actually depend on React - it has been modified to work only with my own utility library. It contains methods of building and publishing your library to npm.
Peer Dependencies
This project does not have any peer dependencies (they are all bundled with the library), so it should work out of the box.
Commands
The following commands exist in the project:
npm run uninstall
- Uninstalls all dependencies for the librarynpm run reinstall
- Uninstalls and then Reinstalls all dependencies for the librarynpm run example-uninstall
- Uninstalls all dependencies for the example appnpm run example-install
- Installs all dependencies for the example appnpm run example-reinstall
- Uninstalls and then Reinstalls all dependencies for the example appnpm run example-start
- Starts the example app after building the librarynpm run build
- Builds the librarynpm run release
- Publishes the library to npm without changing the versionnpm run release-patch
- Publishes the library to npm with a patch version bumpnpm run release-minor
- Publishes the library to npm with a minor version bumpnpm run release-major
- Publishes the library to npm with a major version bump