@danielsimonjr/mathts-expression 0.8.0 → 0.8.2

package/dist/node/FunctionNode.d.ts

@@ -460,31 +460,30 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * Compile a node into a JavaScript function.
          * This basically pre-calculates as much as possible and only leaves open
          * calculations which depend on a dynamic scope with variables.
-         * @param {Object} math     Math.js namespace with functions and constants.
-         * @param {Object} argNames An object with argument names as key and `true`
+         * @param math - Math.js namespace with functions and constants.
+         * @param argNames - An object with argument names as key and `true`
          *                          as value. Used in the SymbolNode to optimize
          *                          for arguments from user assigned functions
          *                          (see FunctionAssignmentNode) or special symbols
          *                          like `end` (see IndexNode).
-         * @return {function} Returns a function which can be called like:
+         * @returns Returns a function which can be called like:
          *                        evalNode(scope: Object, args: Object, context: *)
          */
         _compile(math: Record<string, unknown>, argNames: Record<string, boolean>): (scope: Map<string, unknown>, args: Record<string, unknown>, context: unknown) => unknown;
         /**
          * Execute a callback for each of the child nodes of this node
-         * @param {function(child: Node, path: string, parent: Node)} callback
+         * @param callback
          */
         forEach(callback: (child: MathNode, path: string, parent: MathNode) => void): void;
         /**
          * Create a new FunctionNode whose children are the results of calling
          * the provided callback function for each child of the original node.
-         * @param {function(child: Node, path: string, parent: Node): Node} callback
-         * @returns {FunctionNode} Returns a transformed copy of the node
+         * @param callback
+         * @returns Returns a transformed copy of the node
          */
         map(callback: (child: MathNode, path: string, parent: MathNode) => MathNode): /*elided*/ any;
         /**
          * Create a clone of this node, a shallow copy
-         * @return {FunctionNode}
          */
         clone(): /*elided*/ any;
         /**
@@ -495,20 +494,19 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * otherwise it falls back to calling Node's toString
          * function.
          *
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          * @override
          */
         toString(options?: StringOptions): string;
         /**
          * Get string representation
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          */
         _toString(options?: StringOptions): string;
         /**
          * Get a JSON representation of the node
-         * @returns {Object}
          */
         toJSON(): {
             mathjs: string;
@@ -517,8 +515,8 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
         };
         /**
          * Get HTML representation
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          */
         _toHTML(options?: StringOptions): string;
         /**
@@ -529,20 +527,17 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * otherwise it falls back to calling Node's toTex
          * function.
          *
-         * @param {Object} options
-         * @return {string}
+         * @param options
          */
         toTex(options?: StringOptions): string;
         /**
-         * Get LaTeX representation
-         * @param {Object} options
-         * @return {string} str
+         * Get the MathML representation of this node.
+         * @returns str
          */
         _toMathML(): string;
         _toTex(options?: StringOptions): string;
         /**
          * Get identifier.
-         * @return {string}
          */
         getIdentifier(): string;
         get isNode(): boolean;
@@ -552,15 +547,14 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
     name: string;
     /**
      * Throws an error 'Undefined function {name}'
-     * @param {string} name
+     * @param name
      */
     onUndefinedFunction: (name: string) => never;
     /**
      * Instantiate an AssignmentNode from its JSON representation
-     * @param {Object} json  An object structured like
+     * @param json - An object structured like
      *                       `{"mathjs": "FunctionNode", fn: ..., args: ...}`,
      *                       where mathjs is optional
-     * @returns {FunctionNode}
      */
     fromJSON: (json: {
         fn: MathNode;
@@ -1021,31 +1015,30 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * Compile a node into a JavaScript function.
          * This basically pre-calculates as much as possible and only leaves open
          * calculations which depend on a dynamic scope with variables.
-         * @param {Object} math     Math.js namespace with functions and constants.
-         * @param {Object} argNames An object with argument names as key and `true`
+         * @param math - Math.js namespace with functions and constants.
+         * @param argNames - An object with argument names as key and `true`
          *                          as value. Used in the SymbolNode to optimize
          *                          for arguments from user assigned functions
          *                          (see FunctionAssignmentNode) or special symbols
          *                          like `end` (see IndexNode).
-         * @return {function} Returns a function which can be called like:
+         * @returns Returns a function which can be called like:
          *                        evalNode(scope: Object, args: Object, context: *)
          */
         _compile(math: Record<string, unknown>, argNames: Record<string, boolean>): (scope: Map<string, unknown>, args: Record<string, unknown>, context: unknown) => unknown;
         /**
          * Execute a callback for each of the child nodes of this node
-         * @param {function(child: Node, path: string, parent: Node)} callback
+         * @param callback
          */
         forEach(callback: (child: MathNode, path: string, parent: MathNode) => void): void;
         /**
          * Create a new FunctionNode whose children are the results of calling
          * the provided callback function for each child of the original node.
-         * @param {function(child: Node, path: string, parent: Node): Node} callback
-         * @returns {FunctionNode} Returns a transformed copy of the node
+         * @param callback
+         * @returns Returns a transformed copy of the node
          */
         map(callback: (child: MathNode, path: string, parent: MathNode) => MathNode): /*elided*/ any;
         /**
          * Create a clone of this node, a shallow copy
-         * @return {FunctionNode}
          */
         clone(): /*elided*/ any;
         /**
@@ -1056,20 +1049,19 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * otherwise it falls back to calling Node's toString
          * function.
          *
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          * @override
          */
         toString(options?: StringOptions): string;
         /**
          * Get string representation
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          */
         _toString(options?: StringOptions): string;
         /**
          * Get a JSON representation of the node
-         * @returns {Object}
          */
         toJSON(): {
             mathjs: string;
@@ -1078,8 +1070,8 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
         };
         /**
          * Get HTML representation
-         * @param {Object} options
-         * @return {string} str
+         * @param options
+         * @returns str
          */
         _toHTML(options?: StringOptions): string;
         /**
@@ -1090,20 +1082,17 @@ export declare const createFunctionNode: import("../utils/factory.js").FactoryFu
          * otherwise it falls back to calling Node's toTex
          * function.
          *
-         * @param {Object} options
-         * @return {string}
+         * @param options
          */
         toTex(options?: StringOptions): string;
         /**
-         * Get LaTeX representation
-         * @param {Object} options
-         * @return {string} str
+         * Get the MathML representation of this node.
+         * @returns str
          */
         _toMathML(): string;
         _toTex(options?: StringOptions): string;
         /**
          * Get identifier.
-         * @return {string}
          */
         getIdentifier(): string;
         get isNode(): boolean;

package/dist/node/FunctionNode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FunctionNode.d.ts","sourceRoot":"","sources":["../../src/node/FunctionNode.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAKzD,eAAO,MAAM,kBAAkB;UAQrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;UACvB,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,QAAQ;gBAC9B,KAAK,IAAI,EAAE,MAAM,KAAK,QAAQ;;aAmIxB,QAAQ,GAAG,MAAM,QAAQ,QAAQ,EAAE,aAAa,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbnE,QAAQ;cACN,QAAQ,EAAE;kBACN,OAAO;oBAiCL,MAAM;oBAIN,MAAM;8BAGI,OAAO;QAI7B;;;;;;;;;;;;WAYG;uBACY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WA9KlE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,QACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACpB,OAAO,KACb,OAAO;QA+WV;;;WAGG;0BACe,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;QAQlF;;;;;WAKG;sBACW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,QAAQ;QAS3E;;;WAGG;;QAaH;;;;;;;;;;;WAWG;2BACgB,aAAa,GAAG,MAAM;QAoBzC;;;;WAIG;4BACiB,aAAa,GAAG,MAAM;QAa1C;;;WAGG;kBACO;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;SAAE;QAmB5D;;;;WAIG;0BACe,aAAa,GAAG,MAAM;QAexC;;;;;;;;;;WAUG;wBACa,aAAa,GAAG,MAAM;QAmBtC;;;;WAIG;qBACU,MAAM;yBAkBF,aAAa,GAAG,MAAM;QAuDvC;;;WAGG;yBACc,MAAM;;;;;;IArNvB;;;OAGG;gCAC0C,MAAM,KAAG,KAAK;IAkE3D;;;;;;OAMG;qBAC+B;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA/WhE,QAAQ;cACN,QAAQ,EAAE;kBACN,OAAO;oBAiCL,MAAM;oBAIN,MAAM;8BAGI,OAAO;QAI7B;;;;;;;;;;;;WAYG;uBACY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WA9KlE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,QACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACpB,OAAO,KACb,OAAO;QA+WV;;;WAGG;0BACe,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;QAQlF;;;;;WAKG;sBACW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,QAAQ;QAS3E;;;WAGG;;QAaH;;;;;;;;;;;WAWG;2BACgB,aAAa,GAAG,MAAM;QAoBzC;;;;WAIG;4BACiB,aAAa,GAAG,MAAM;QAa1C;;;WAGG;kBACO;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;SAAE;QAmB5D;;;;WAIG;0BACe,aAAa,GAAG,MAAM;QAexC;;;;;;;;;;WAUG;wBACa,aAAa,GAAG,MAAM;QAmBtC;;;;WAIG;qBACU,MAAM;yBAkBF,aAAa,GAAG,MAAM;QAuDvC;;;WAGG;yBACc,MAAM;;;;;EAQ5B,CAAC"}
+{"version":3,"file":"FunctionNode.d.ts","sourceRoot":"","sources":["../../src/node/FunctionNode.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAKzD,eAAO,MAAM,kBAAkB;UAQrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;UACvB,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,QAAQ;gBAC9B,KAAK,IAAI,EAAE,MAAM,KAAK,QAAQ;;aAmIxB,QAAQ,GAAG,MAAM,QAAQ,QAAQ,EAAE,aAAa,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbnE,QAAQ;cACN,QAAQ,EAAE;kBACN,OAAO;oBAiCL,MAAM;oBAIN,MAAM;8BAGI,OAAO;QAI7B;;;;;;;;;;;;WAYG;uBACY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WA9KlE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,QACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACpB,OAAO,KACb,OAAO;QA+WV;;;WAGG;0BACe,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;QAQlF;;;;;WAKG;sBACW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,QAAQ;QAS3E;;WAEG;;QAaH;;;;;;;;;;;WAWG;2BACgB,aAAa,GAAG,MAAM;QAoBzC;;;;WAIG;4BACiB,aAAa,GAAG,MAAM;QAa1C;;WAEG;kBACO;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;SAAE;QAkB5D;;;;WAIG;0BACe,aAAa,GAAG,MAAM;QAexC;;;;;;;;;WASG;wBACa,aAAa,GAAG,MAAM;QAmBtC;;;WAGG;qBACU,MAAM;yBAkBF,aAAa,GAAG,MAAM;QAuDvC;;WAEG;yBACc,MAAM;;;;;;IAhNvB;;;OAGG;gCAC0C,MAAM,KAAG,KAAK;IAiE3D;;;;;OAKG;qBAC+B;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA5WhE,QAAQ;cACN,QAAQ,EAAE;kBACN,OAAO;oBAiCL,MAAM;oBAIN,MAAM;8BAGI,OAAO;QAI7B;;;;;;;;;;;;WAYG;uBACY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WA9KlE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,QACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACpB,OAAO,KACb,OAAO;QA+WV;;;WAGG;0BACe,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;QAQlF;;;;;WAKG;sBACW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,QAAQ;QAS3E;;WAEG;;QAaH;;;;;;;;;;;WAWG;2BACgB,aAAa,GAAG,MAAM;QAoBzC;;;;WAIG;4BACiB,aAAa,GAAG,MAAM;QAa1C;;WAEG;kBACO;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;SAAE;QAkB5D;;;;WAIG;0BACe,aAAa,GAAG,MAAM;QAexC;;;;;;;;;WASG;wBACa,aAAa,GAAG,MAAM;QAmBtC;;;WAGG;qBACU,MAAM;yBAkBF,aAAa,GAAG,MAAM;QAuDvC;;WAEG;yBACc,MAAM;;;;;EAQ5B,CAAC"}