xl-formula-parser

Description

Parses excel-formula-like string to JSON object tree and reverse parses to formula string.

Installation

  npm i xl-formula-parser

APIs

parse(str)

• str | datatype: string | required

Example

  const { parse } = require("xl-formula-parser");

  const formula = `=OR(EQ(./path/personName, "John Doe"), NOT(EQ(personName, "John Smith")))`;

  parse(formula); 

parse(formula) returns

  {
    formula: "OR",
    args: [
      {
        formula: "EQ", 
        args: [
          {
            path: "./path/personName"
          },
          "John Doe"
        ]
      },
      {
        formula: "NOT",
        args: [
          {
            formula: "EQ",
            args:[
              {
                variable: "personName"
              },
            "John Smith"
            ]
          }
        ]
      }
    ]
  }

---

stringify(obj)

• obj | datatype: object | required

Example

const { stringify } = require('xl-formula-parser');

const formulaTreeObject = {
    formula: "OR",
    args: [
      {
        formula: "EQ", 
        args: [
          {
            path: "./path/personName"
          },
          "John Doe"
        ]
      },
      {
        formula: "NOT",
        args: [
          {
            formula: "EQ",
            args:[
              {
                variable: "personName"
              },
            "John Smith"
            ]
          }
        ]
      }
    ]
  };

stringify(formulaTreeObject);

stringify(formulaTreeObject) returns

  '=OR(EQ(./path/personName, "John Doe"), NOT(EQ(personName, "John Smith")))'