mumath - npm Package Compare versions

Comparing version 0.4.3 to 1.0.0

index.js

@@ -1,5 +0,3 @@
-var wrap = require('./wrap');
-
 /**
- * Simple math utils.
+ * Composed set of all math utils
  *
@@ -13,11 +11,19 @@ * @module  mumath
 	precision: require('./precision'),
-	min: wrap(Math.min),
-	max: wrap(Math.max),
-	add: wrap(function(a,b){return a+b}),
-	sub: wrap(function(a,b){return a-b}),
-	div: wrap(function(a,b){return a/b}),
-	mult: wrap(function(a,b){return a*b}),
-	mod: wrap(function(a,b){return a%b}),
-	floor: wrap(function(a){return Math.floor(a)}),
-	ceil: wrap(function(a){return Math.ceil(a)})
+	loop: require('./loop'),
+	add: require('./add'),
+	sub: require('./sub'),
+	min: require('./min'),
+	max: require('./max'),
+	div: require('./div'),
+	mult: require('./mult'),
+	mod: require('./mod'),
+	floor: require('./floor'),
+	ceil: require('./ceil'),
+
+	gt: require('./gt'),
+	gte: require('./gte'),
+	lt: require('./lt'),
+	lte: require('./lte'),
+	eq: require('./eq'),
+	ne: require('./ne'),
 };

package.json

 {
   "name": "mumath",
-  "version": "0.4.3",
+  "version": "1.0.0",
   "description": "Micro math methods",
@@ -5,0 +5,0 @@ "main": "index.js",

precision.js

 /**
+ * @module  mumath/precision
+ *
  * Get precision from float:
@@ -7,3 +9,2 @@ *
  *
- *
  * @param {number} n
@@ -10,0 +11,0 @@ *

README.md

 # μMath [![Build Status](https://travis-ci.org/dfcreative/mumath.svg?branch=master)](https://travis-ci.org/dfcreative/mumath) [![Code Climate](https://codeclimate.com/github/dfcreative/mumath/badges/gpa.svg)](https://codeclimate.com/github/dfcreative/mumath) <a href="UNLICENSE"><img src="http://upload.wikimedia.org/wikipedia/commons/6/62/PD-icon.svg" width="20"/></a>
 
-Common math functions aware of objects and arrays.
-Each can be required as `require('mumath/<fn>')`;
+Set of practical math utils to shorten code.
 
+`$ npm install mumath`
 
+```js
+	var round = require('mumath/round');
+	round(123.32, .5); //123.5
+
+	//require any function as
+	//var <fn> = require('mumath/<fn>');
+```
+
+## API
+
+### `round(value, precision?)`
+
+Rounds value to optional `precision`, which is `1` by default.
+
+
+### `precision(value)`
+
+Get precision from float:
+
+`1.1 → 1, 1234 → 0, .1234 → 4`
+
+
+### `between(value, left, right)`
+
+Return value clamped by left/right limits (or vice-versa).
+
+
+### `isBetween(value, left, right)`
+
+Whether element is between left & right, including.
+
+
+### `loop(value, [min,]? max)`
+
+An enhanced [mod-loop](http://npmjs.org/package/mod-loop) - loops value within a frame.
+
+
+### `mult(a, b, ...)`
+### `div(a, b, ...)`
+### `sub(a, b, ...)`
+### `add(a, b, ...)`
+### `mod(a, b, ...)`
+### `min(a, b, ...)`
+### `max(a, b, ...)`
+### `floor(a, b, ...)`
+### `ceil(a, b, ...)`
+
+Simple wrappers for arythmetical functions.
+
+
+### `gt(a,b)`
+### `gte(a,b)`
+### `lt(a,b)`
+### `lte(a,b)`
+### `eq(a,b)`
+### `ne(a,b)`
+
+Simple conditional functions.
+
+
+
 [![NPM](https://nodei.co/npm/mutype.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/mumath/)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7648

increased by84.2%

Number of package files

24

increased by200%

Lines of code

225

increased by92.31%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

68

increased by871.43%

No dependency changes