evaluatex
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/evaluatex package

2.2.0 • Public • Published

Evaluatex

Evaluatex is a parser that reads and evaluates LaTeX and ASCII math. Use in Node, Angular, or with vanilla Javascript on both clients and servers.

Evaluatex can safely resolve math without relying Javascript's native eval() function. It can also support custom variables and functions, so you can pass in arbitrary values without having to hard-code the math.

Evaluatex is reasonably stable. It has been tested for common patterns and use cases, but when provoked it may do weird and unexpected things such as eating your cat.

Installation

npm install evaluatex
# or 
yarn install/add evaluatex
const evaluatex = require("evaluatex");
// or
import evaluatex from "evaluatex";

Building

Get yarn and do yarn install.

yarn build transpiles ES6 sources to dist/.

yarn test runs tests in the test/ directory.

API

const fn = evaluatex(expression, constants = {}, options = {});
const result = fn(variables = {});
  • evaluatex() compiles a text math expression into a function fn.
    • expression is an ASCII or LaTeX expression to be parsed and evaluated.
    • constants is a map of constant values - values that don't change if you invoke fn more than once.
    • options is a map of options for the compiler.
  • result is the numerical result of the calculation.
    • variables is a map of variables that can change between invocations.

Features and usage

A complete manual is available on the project page.

Readme

Keywords

none

Package Sidebar

Install

npm i evaluatex

Weekly Downloads

1,197

Version

2.2.0

License

MIT

Unpacked Size

56.1 kB

Total Files

18

Last publish

Collaborators

  • arthanzel