@jspreadsheet/formula-pro/dist/index.d.ts

Jspreadsheet formula pro is a JavaScript software to parse spreadsheet-like formulas.

/**
 * Official Type definitions for JSS Formula Premium
 * https://jspreadsheet.com/products/formula
 */

declare function formula(expression: string, variables?: object, x?: number, y?: number, instance?: Function): any

declare namespace formula {

    /**
     * Define custom formulas
     */
    function setFormula(formulas: object) : void;
    function license(value: string) : void;

    /**
     * Define external variables
     */
    function setConst(variables: object) : void;
    function resetConst() : void;

    /**
     * This property is depreacted. Use Jspreadsheet defined names.
     * @param variables
     */
    function define(variables: object) : void;
    function reset() : void;

    let adjustPrecision: boolean;
    let caching: boolean;
    let divisor: string;
    let debug: boolean;


    /**
     * Transform a formula before executed.
     * @param {string} expression
     * Example:
     * formula.onbeforeformula = (expression) => expression.replace(/\./g, '').replace(/\,/g, '.')
     */
    function onbeforeformula(expression: string) : string

    /**
     * Transform a formula before executed.
     * @param {object} error
     * @param {string} expression - SUM(A1,B2)
     * @param {object} variables - { A1: 1000, A2: 2000 }
     * @param {number} x (cell coordinate)
     * @param {number} y (cell coordinate)
     * @param {object} worksheet (worksheet instance)
     */
    function onerror(error: Error, expression: string, variables: object, x: number, y: number, worksheet: object) : void
}

export default formula;