thereadme/Equation.js
1
0
Fork 0
Code Issues 4 Pull Requests 3 Projects Releases Wiki Activity

published to npm

Browse Source
This commit is contained in:
Mahdi Dibaiee 2015-04-21 14:46:05 +04:30
parent 7f1dbfd4ad
commit b08841e51b
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -4,6 +4,14 @@ Solve math expressions or create equations for repeated and complex Math tasks.
To use in browser, download [`equation.min.js`](https://raw.githubusercontent.com/mdibaiee/Equation.js/master/equation.min.js). To use in browser, download [`equation.min.js`](https://raw.githubusercontent.com/mdibaiee/Equation.js/master/equation.min.js).
Install using npm:
```
npm install equations
```
####Examples:
```javascript ```javascript
// solve // solve
console.log(Equation.solve('4 * lg(4) ^ 3')); // 32 console.log(Equation.solve('4 * lg(4) ^ 3')); // 32
@ -39,25 +47,25 @@ API
####solve(expression: String) ####solve(expression: String)
Takes a math expression and evaluates it, returning the result. Takes a math expression and evaluates it, returning the result.
###equation(expression: String) ####equation(expression: String)
Takes a math expression containing variables, returning a function which Takes a math expression containing variables, returning a function which
replaces the variables with given arguments, and solves the expression. replaces the variables with given arguments, and solves the expression.
###registerOperator(key: String, options: Object) ####registerOperator(key: String, options: Object)
Registers a new operator. Registers a new operator.
Options: Options:
#####fn #####fn
The function which runs on arguments The function which is run on arguments and returns the result
#####format #####format
The format which specifies how arguments are placed relative to operator, this is a string in which 1 represents the operator and zeroes represent arguments. The format which specifies how arguments are placed relative to operator, this is a string in which 1 represents the operator and zeroes represent arguments.
For example `+` has the format `010` and factorial has `01`. For example `+` has the format `010` and factorial has `01`.
#####precedence #####precedence
Specifies the precedence of operator. The less the value, the higher the precedence, resulting in soon execution. Specifies the precedence of operator. The less the value, the higher the precedence, resulting in sooner execution.
###registerConstant(key: String, value: Function/Number) ####registerConstant(key: String, value: Function/Number)
Registers a new constant. value can be a function (takes no arguments), or a constant number. Registers a new constant. value can be a function (takes no arguments), or a constant number.
That's right, we have named these *constants* but they actually can change, that's why we can use functions to define them. An example is the `RAND` constant which calls `Math.random`. That's right, we have named these *constants* but they actually can change, that's why we can use functions to define them. An example is the `RAND` constant which calls `Math.random`.
@ -79,6 +87,7 @@ Runs ESLint on `lib` and `tests`
######test ######test
Runs the tests Runs the tests
---
Please make sure to run `grunt eslint` before commiting. Please make sure to run `grunt eslint` before commiting.
If you're adding something new, please add a test, too. If you're adding something new, please add a test, too.

8
package.json
View File

@ -1,5 +1,5 @@
{ {
"name": "equation", "name": "equations",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"main": "dist/index.js", "main": "dist/index.js",
@ -24,10 +24,6 @@
"grunt-contrib-watch": "^0.6.1", "grunt-contrib-watch": "^0.6.1",
"grunt-eslint": "^11.0.0", "grunt-eslint": "^11.0.0",
"grunt-mocha-test": "^0.12.7", "grunt-mocha-test": "^0.12.7",
"mocha": "^2.2.4", "mocha": "^2.2.4"
"remapify": "^2.0.1"
},
"dependencies": {
"babel": "^5.1.11"
} }
} }