mf-parser - npm Package Compare versions

Comparing version 3.2.5 to 3.2.6

lib/src/ensureCase.d.ts

@@ -7,1 +7,2 @@ /**
 export function ensureCase(mf: string): string;
+//# sourceMappingURL=ensureCase.d.ts.map

lib/src/ensureCase.js

@@ -52,1 +52,2 @@ "use strict";
 }
+//# sourceMappingURL=ensureCase.js.map

lib/src/Format.d.ts

@@ -7,1 +7,2 @@ export namespace Format {
 }
+//# sourceMappingURL=Format.d.ts.map

lib/src/Format.js

@@ -13,1 +13,2 @@ "use strict";
 };
+//# sourceMappingURL=Format.js.map

lib/src/index.d.ts

@@ -12,1 +12,2 @@ export * from "./parse.js";
 export * from "./parseToHtml.js";
+//# sourceMappingURL=index.d.ts.map

lib/src/index.js

@@ -28,1 +28,2 @@ "use strict";
 __exportStar(require("./parseToHtml.js"), exports);
+//# sourceMappingURL=index.js.map

lib/src/Kind.d.ts

@@ -17,1 +17,2 @@ export namespace Kind {
 }
+//# sourceMappingURL=Kind.d.ts.map

lib/src/Kind.js

@@ -23,1 +23,2 @@ "use strict";
 };
+//# sourceMappingURL=Kind.js.map

lib/src/MF.d.ts

@@ -11,6 +11,27 @@ /** @typedef {import('./util/getIsotopesInfo.types').IsotopesInfo} IsotopesInfo */
     cache: {};
-    toDisplay(): any;
-    toHtml(): any;
-    toText(): any;
-    toCanonicText(): any;
+    /**
+     * Returns an array of objects with kind and value that can be used to easily
+     * display the molecular formula.
+     * @returns {{kind: string, value: string}[]}
+     */
+    toDisplay(): {
+        kind: string;
+        value: string;
+    }[];
+    /**
+     * Returns a string that represents the molecular formula adding subscript and superscript in HTML.
+     * @returns {string}
+     */
+    toHtml(): string;
+    /**
+     * Returns a string that represents the molecular formula adding subscript and superscript
+     * using unicode characters. This can not be parsed anymore so kind of dead end ...
+     * @returns {string}
+     */
+    toText(): string;
+    /**
+     * Similar to toText but returns a canonic string in which the atoms are sorted using the Hill system
+     * @returns {string}
+     */
+    toCanonicText(): string;
     toParts(options: any): any;
@@ -28,4 +49,4 @@ /**
         customUnsaturations?: object;
-        emFieldName?: string;
-        msemFieldName?: string;
+        emFieldName?: string | undefined;
+        msemFieldName?: string | undefined;
     }): PartInfo | PartInfoWithParts;
@@ -48,4 +69,5 @@ /**
      * Get a canonized MF
+     * @returns {string}
      */
-    toMF(): any;
+    toMF(): string;
     /**
@@ -61,1 +83,2 @@ * Get a canonized MF
 export type PartInfoWithParts = import("./util/getInfo.types").PartInfoWithParts;
+//# sourceMappingURL=MF.d.ts.map

lib/src/MF.js

@@ -31,2 +31,7 @@ "use strict";
     }
+    /**
+     * Returns an array of objects with kind and value that can be used to easily
+     * display the molecular formula.
+     * @returns {{kind: string, value: string}[]}
+     */
     toDisplay() {
@@ -37,2 +42,6 @@ if (!this.cache.displayed)
     }
+    /**
+     * Returns a string that represents the molecular formula adding subscript and superscript in HTML.
+     * @returns {string}
+     */
     toHtml() {
@@ -45,2 +54,7 @@ if (!this.cache.html) {
     }
+    /**
+     * Returns a string that represents the molecular formula adding subscript and superscript
+     * using unicode characters. This can not be parsed anymore so kind of dead end ...
+     * @returns {string}
+     */
     toText() {
@@ -53,2 +67,6 @@ if (!this.cache.text) {
     }
+    /**
+     * Similar to toText but returns a canonic string in which the atoms are sorted using the Hill system
+     * @returns {string}
+     */
     toCanonicText() {
@@ -116,2 +134,3 @@ if (!this.cache.canonicText) {
      * Get a canonized MF
+     * @returns {string}
      */
@@ -145,1 +164,2 @@ toMF() {
 exports.MF = MF;
+//# sourceMappingURL=MF.js.map

lib/src/parse.d.ts

@@ -6,1 +6,2 @@ /**
 export function parse(mf: string): any[];
+//# sourceMappingURL=parse.d.ts.map

lib/src/parse.js

@@ -267,1 +267,2 @@ "use strict";
 }
+//# sourceMappingURL=parse.js.map

lib/src/parseToHtml.d.ts

@@ -6,1 +6,2 @@ /**
 export function parseToHtml(mf: string): string;
+//# sourceMappingURL=parseToHtml.d.ts.map

lib/src/parseToHtml.js

@@ -14,1 +14,2 @@ "use strict";
 }
+//# sourceMappingURL=parseToHtml.js.map

lib/src/Style.d.ts

@@ -5,1 +5,2 @@ export namespace Style {
 }
+//# sourceMappingURL=Style.d.ts.map

lib/src/Style.js

@@ -8,1 +8,2 @@ "use strict";
 };
+//# sourceMappingURL=Style.js.map

lib/src/util/capitalizeMF.d.ts

@@ -5,1 +5,2 @@ /**
 export function capitalizeMF(mf: any): any;
+//# sourceMappingURL=capitalizeMF.d.ts.map

lib/src/util/capitalizeMF.js

@@ -68,1 +68,2 @@ "use strict";
 }
+//# sourceMappingURL=capitalizeMF.js.map

lib/src/util/flatten.d.ts

 export function flatten(parsed: any, options?: {}): string[];
+//# sourceMappingURL=flatten.d.ts.map

lib/src/util/flatten.js

@@ -150,1 +150,2 @@ "use strict";
 }
+//# sourceMappingURL=flatten.js.map

lib/src/util/formatCharge.d.ts

 export function formatCharge(charge: any): string;
+//# sourceMappingURL=formatCharge.d.ts.map

lib/src/util/formatCharge.js

@@ -13,1 +13,2 @@ "use strict";
 }
+//# sourceMappingURL=formatCharge.js.map

lib/src/util/getEA.d.ts

@@ -10,1 +10,2 @@ /**
 }[];
+//# sourceMappingURL=getEA.d.ts.map

lib/src/util/getEA.js

@@ -68,1 +68,2 @@ "use strict";
 }
+//# sourceMappingURL=getEA.js.map

lib/src/util/getElements.d.ts

@@ -7,1 +7,2 @@ /**
 export function getElements(parts: any): any[];
+//# sourceMappingURL=getElements.d.ts.map

lib/src/util/getElements.js

@@ -59,1 +59,2 @@ "use strict";
 }
+//# sourceMappingURL=getElements.js.map

lib/src/util/getInfo.d.ts

@@ -12,1 +12,2 @@ /** @typedef {import('./getInfo.types').PartInfo} PartInfo */
 export type PartInfoWithParts = import("./getInfo.types").PartInfoWithParts;
+//# sourceMappingURL=getInfo.d.ts.map

lib/src/util/getInfo.js

@@ -141,1 +141,2 @@ "use strict";
 }
+//# sourceMappingURL=getInfo.js.map

lib/src/util/getInfo.types.d.ts

@@ -17,1 +17,2 @@ import type { AtomsMap } from './partToAtoms';
 }
+//# sourceMappingURL=getInfo.types.d.ts.map

lib/src/util/getInfo.types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=getInfo.types.js.map

lib/src/util/getIsotopeRatioInfo.d.ts

@@ -5,1 +5,2 @@ export function getIsotopeRatioInfo(value: any): {
 };
+//# sourceMappingURL=getIsotopeRatioInfo.d.ts.map

lib/src/util/getIsotopeRatioInfo.js

@@ -28,1 +28,2 @@ "use strict";
 }
+//# sourceMappingURL=getIsotopeRatioInfo.js.map

lib/src/util/getIsotopesInfo.d.ts

@@ -13,1 +13,2 @@ /** @typedef {import('./getIsotopesInfo.types').IsotopesInfo} IsotopesInfo
 export type IsotopesInfo = import("./getIsotopesInfo.types").IsotopesInfo;
+//# sourceMappingURL=getIsotopesInfo.d.ts.map

lib/src/util/getIsotopesInfo.js

@@ -98,1 +98,2 @@ "use strict";
 }
+//# sourceMappingURL=getIsotopesInfo.js.map

lib/src/util/getIsotopesInfo.types.d.ts

@@ -14,1 +14,2 @@ interface IsotopeInfo {
 export {};
+//# sourceMappingURL=getIsotopesInfo.types.d.ts.map

lib/src/util/getIsotopesInfo.types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=getIsotopesInfo.types.js.map

lib/src/util/isMF.d.ts

 export function isMF(mf: any): boolean;
+//# sourceMappingURL=isMF.d.ts.map

lib/src/util/isMF.js

@@ -16,1 +16,2 @@ "use strict";
 }
+//# sourceMappingURL=isMF.js.map

lib/src/util/parseCharge.d.ts

@@ -7,1 +7,2 @@ /**
 export function parseCharge(charge: any): number;
+//# sourceMappingURL=parseCharge.d.ts.map

lib/src/util/parseCharge.js

@@ -30,1 +30,2 @@ "use strict";
 }
+//# sourceMappingURL=parseCharge.js.map

lib/src/util/partsToDisplay.d.ts

@@ -11,1 +11,2 @@ /**
 }[];
+//# sourceMappingURL=partsToDisplay.d.ts.map

lib/src/util/partsToDisplay.js

@@ -27,1 +27,2 @@ "use strict";
 }
+//# sourceMappingURL=partsToDisplay.js.map

lib/src/util/partsToMF.d.ts

 export function partsToMF(parts: any, options: any): string;
+//# sourceMappingURL=partsToMF.d.ts.map

lib/src/util/partsToMF.js

@@ -12,1 +12,2 @@ "use strict";
 }
+//# sourceMappingURL=partsToMF.js.map

lib/src/util/partToAtoms.d.ts

@@ -10,1 +10,2 @@ /** @typedef {Record<string, number>} AtomsMap */
 export type AtomsMap = Record<string, number>;
+//# sourceMappingURL=partToAtoms.d.ts.map

lib/src/util/partToAtoms.js

@@ -42,1 +42,2 @@ "use strict";
 }
+//# sourceMappingURL=partToAtoms.js.map

lib/src/util/partToMF.d.ts

 export function partToMF(part: any, options?: {}): string;
+//# sourceMappingURL=partToMF.d.ts.map

lib/src/util/partToMF.js

@@ -34,1 +34,2 @@ "use strict";
 }
+//# sourceMappingURL=partToMF.js.map

lib/src/util/subSuperscript.d.ts

@@ -39,1 +39,2 @@ export const superscript: {
 };
+//# sourceMappingURL=subSuperscript.d.ts.map

lib/src/util/subSuperscript.js

@@ -42,1 +42,2 @@ "use strict";
 };
+//# sourceMappingURL=subSuperscript.js.map

lib/src/util/toDisplay.d.ts

@@ -11,1 +11,2 @@ /**
 }[];
+//# sourceMappingURL=toDisplay.d.ts.map

lib/src/util/toDisplay.js

@@ -103,1 +103,2 @@ "use strict";
 }
+//# sourceMappingURL=toDisplay.js.map

lib/src/util/toHtml.d.ts

 export function toHtml(lines: any): string;
+//# sourceMappingURL=toHtml.d.ts.map

lib/src/util/toHtml.js

@@ -25,1 +25,2 @@ "use strict";
 }
+//# sourceMappingURL=toHtml.js.map

lib/src/util/toParts.d.ts

@@ -8,3 +8,4 @@ /**
 export function toParts(lines: any, options?: {
-    expand?: boolean;
+    expand?: boolean | undefined;
 }): any[][];
+//# sourceMappingURL=toParts.d.ts.map

lib/src/util/toParts.js

@@ -217,1 +217,2 @@ "use strict";
 }
+//# sourceMappingURL=toParts.js.map

lib/src/util/toText.d.ts

 export function toText(lines: any): string;
+//# sourceMappingURL=toText.d.ts.map

lib/src/util/toText.js

@@ -66,1 +66,2 @@ "use strict";
 }
+//# sourceMappingURL=toText.js.map

package.json

 {
   "name": "mf-parser",
-  "version": "3.2.5",
+  "version": "3.2.6",
   "description": "Parse a molecular formula",
@@ -23,5 +23,5 @@ "main": "lib/src/index.js",
   "dependencies": {
-    "atom-sorter": "^2.1.3",
-    "chemical-elements": "^2.1.2",
-    "chemical-groups": "^2.2.1"
+    "atom-sorter": "^2.2.0",
+    "chemical-elements": "^2.2.0",
+    "chemical-groups": "^2.2.2"
   },
@@ -31,3 +31,3 @@ "devDependencies": {
   },
-  "gitHead": "2b83132c523cebb4b3c395a70cfd5de04fbf7f28"
+  "gitHead": "a5a0497a4a284ffcbeaf90a39baba0170a6b1e24"
 }

src/MF.js

@@ -31,2 +31,7 @@ import { ensureCase } from './ensureCase';
 
+  /**
+   * Returns an array of objects with kind and value that can be used to easily
+   * display the molecular formula.
+   * @returns {{kind: string, value: string}[]}
+   */
   toDisplay() {
@@ -37,2 +42,6 @@ if (!this.cache.displayed) this.cache.displayed = toDisplay(this.parsed);
 
+  /**
+   * Returns a string that represents the molecular formula adding subscript and superscript in HTML.
+   * @returns {string}
+   */
   toHtml() {
@@ -46,2 +55,7 @@ if (!this.cache.html) {
 
+  /**
+   * Returns a string that represents the molecular formula adding subscript and superscript
+   * using unicode characters. This can not be parsed anymore so kind of dead end ...
+   * @returns {string}
+   */
   toText() {
@@ -55,2 +69,6 @@ if (!this.cache.text) {
 
+  /**
+   * Similar to toText but returns a canonic string in which the atoms are sorted using the Hill system
+   * @returns {string}
+   */
   toCanonicText() {
@@ -124,2 +142,3 @@ if (!this.cache.canonicText) {
    * Get a canonized MF
+   * @returns {string}
    */
@@ -126,0 +145,0 @@ toMF() {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

287023

increased by73.96%

Number of package files

150

increased by64.84%

Lines of code

3795

increased by1.61%

Dependency changes

• Updatedatom-sorter@^2.2.0

• Updatedchemical-elements@^2.2.0

• Updatedchemical-groups@^2.2.2