mathematician - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "mathematician",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Arithmetical expressions parser for Elm and JavaScript",
@@ -5,0 +5,0 @@ "main": "./src/index.js",

README.md

 # mathematician
 Arithmetical expressions parser for JavaScript. 数学者！
+
+> Available on NPM: https://www.npmjs.com/package/mathematician
+
+## Examples
+
+It splits expressions into atomic symbols for easy programming handling.
+
+```js
+parseExpression('-3,14 0.57 +');
+// returns them:
+[
+  { type: SYMBOL_TYPE.NUMBER, value: -3.14 },
+  { type: SYMBOL_TYPE.NUMBER, value: 0.57 },
+  { type: SYMBOL_TYPE.SUM, value: null },
+]
+
+parseExpression('42c');
+// throws error indexing failing token:
+Error('2')
+```
+
+And may also safely evaluate whole expressions following
+[postfix notation](https://en.wikipedia.org/wiki/Reverse_Polish_notation):
+
+```js
+evalPostfix('1 1 + 2 + 3 +');
+// returns the result:
+7
+
+evalPostfix('42 0 /');
+// throws error messaging arithmetical inconsistency:
+Error('Division by zero')
+```

src/index.js

 import evalPostfix from './evals';
+import { parseExpression } from './parser';
+import * as syntax from './syntax';
 
 export default {
   evalPostfix,
+  parseExpression,
+  ...syntax,
 };

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

Improved metrics

Total package byte prevSize

17593

increased by5.02%

Lines of code

377

increased by1.07%

Number of lines in readme file

36

increased by1100%

No dependency changes