# Formula.js

Community built JavaScript implementation of most Microsoft Excel formula functions.

## Use it

### In browser

``````<script src="https://cdn.jsdelivr.net/npm/jstat@1.9.2/dist/jstat.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/formulajs/formulajs@2.5.0/dist/formula.min.js"></script>
``````

### In node

Install the package:

``````npm i @formulajs/formulajs
``````

## Play with it

With Formula.js you can recreate spreadsheet formula with JavaScript using the functions you know.

You can review some usages and play online on the functions pages.

The Formula.js equivalent would be:

``````// =SUM(A1:C1)
formulajs.SUM([1, 2 , 3])
// returns > 6

// =SUM(A1:C2)
formulajs.SUM([[1, 2 , 3], [4, 5, 6]])
// returns > 21
``````

### JavaScript differs from Excel

Formula.js tries to recreate the formula you know and like from your spreadsheet tool. However the two environments differs from each other.

For example `=2^3` is a valid Excel function that will return `8`. The `^` operator means something else in JavaScript (`2^3` return `1`, you can learn more here why). With Formula.js you can write `formulajs.POWER(2, 3)` which is equivalent to `Math.pow(2, 3)` in plain JavaScript.

## Migration guide

### From formulajs

If you were previously using formulajs from Sutoiku, some functions have been removed, due to dependency simplification.

Text functions:

`FIXED, TEXT, DOLLAR, VALUE`

Math functions:

`MDETERM, MINVERSE, MMULT, MUNIT`

Otherwise the 2 packages are fully compatible. You can swap them.

### From @handsontable/formulajs

The code of this package is originally forked from @handsontable/formulajs version 2.0.2 (released in January 2020). The two packages were identical at the time. There is no regression, only fixes and new functions since the fork.

Formula.js

Community built JavaScript implementation of most Microsoft Excel formula functions. Open to contributions and maintainers.