sdf-parser 5.0.0 → 5.0.1

package/lib/index.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var ensureString = require('ensure-string');
 var pipeline = require('pumpify');
 var split2 = require('split2');
 var through2 = require('through2');
@@ -31,6 +32,16 @@ function getEntriesBoundaries(string, substring, eol) {
   return res;
 }
 
+/**
+ *  Parse a SDF file
+ * @param {string|ArrayBuffer|Uint8Array} sdf SDF file to parse
+ * @param {any} [options={}]
+ * @param {array<string>} [options.include] List of fields to include
+ * @param {array<string>} [options.exclude] List of fields to exclude
+ * @param {boolean} [options.dynamicTyping] Dynamically type the data
+ * @param {object} [options.modifiers] Object containing callbacks to apply on some specific fields
+ * @param {boolean} [options.mixedEOL=false] Set to true if you know there is a mixture between \r\n and \n
+ */
 function parse(sdf, options = {}) {
   const {
     include,
@@ -41,6 +52,7 @@ function parse(sdf, options = {}) {
     dynamicTyping = true,
   } = options;
 
+  sdf = ensureString.ensureString(sdf);
   if (typeof sdf !== 'string') {
     throw new TypeError('Parameter "sdf" must be a string');
   }
@@ -179,6 +191,7 @@ function parse(sdf, options = {}) {
 }
 
 const filterStream = filter__default["default"].bind(null, { objectMode: true });
+
 function filterCb(chunk) {
   return chunk.length > 1 && chunk.trim().length > 1;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdf-parser",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "SDF parser",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -8,6 +8,7 @@
     "lib",
     "src"
   ],
+  "sideEffects": false,
   "scripts": {
     "build": "npm run compile && cheminfo-build --root SDFParser",
     "compile": "rollup -c",
@@ -42,19 +43,20 @@
   },
   "homepage": "https://github.com/cheminfo/sdf-parser",
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.15.4",
+    "@babel/plugin-transform-modules-commonjs": "^7.16.8",
     "babel-eslint": "^10.1.0",
     "callback-stream": "^1.1.0",
     "cheminfo-build": "^1.1.11",
-    "eslint": "^7.32.0",
-    "eslint-config-cheminfo": "^6.0.1",
-    "jest": "^27.2.5",
+    "eslint": "^8.10.0",
+    "eslint-config-cheminfo": "^7.3.0",
+    "jest": "^27.5.1",
     "openchemlib": "^7.4.3",
-    "prettier": "^2.4.1"
+    "prettier": "^2.5.1"
   },
   "dependencies": {
+    "ensure-string": "^1.1.0",
     "pumpify": "^2.0.1",
-    "split2": "^3.2.2",
+    "split2": "^4.1.0",
     "through2": "^4.0.2",
     "through2-filter": "^3.0.0"
   }

package/src/parse.js

@@ -1,5 +1,16 @@
-import { getEntriesBoundaries } from './getEntriesBoundaries';
+import { ensureString } from 'ensure-string';
 
+import { getEntriesBoundaries } from './getEntriesBoundaries';
+/**
+ *  Parse a SDF file
+ * @param {string|ArrayBuffer|Uint8Array} sdf SDF file to parse
+ * @param {any} [options={}]
+ * @param {array<string>} [options.include] List of fields to include
+ * @param {array<string>} [options.exclude] List of fields to exclude
+ * @param {boolean} [options.dynamicTyping] Dynamically type the data
+ * @param {object} [options.modifiers] Object containing callbacks to apply on some specific fields
+ * @param {boolean} [options.mixedEOL=false] Set to true if you know there is a mixture between \r\n and \n
+ */
 export function parse(sdf, options = {}) {
   const {
     include,
@@ -10,6 +21,7 @@ export function parse(sdf, options = {}) {
     dynamicTyping = true,
   } = options;
 
+  sdf = ensureString(sdf);
   if (typeof sdf !== 'string') {
     throw new TypeError('Parameter "sdf" must be a string');
   }

package/src/stream.js

@@ -6,6 +6,7 @@ import filter from 'through2-filter';
 import { parse } from './parse';
 
 const filterStream = filter.bind(null, { objectMode: true });
+
 function filterCb(chunk) {
   return chunk.length > 1 && chunk.trim().length > 1;
 }