gff-nostream 1.3.1 → 1.3.3

package/dist/api.d.ts

@@ -1,4 +1,4 @@
-import { GFF3Item } from './util';
+import { GFF3Feature } from './util';
 /** Parser options */
 export interface ParseOptions {
     /** Whether to resolve references to derives from features */
@@ -19,5 +19,13 @@ export interface ParseOptions {
      */
     parseAll?: boolean;
 }
-export declare function parseStringSync(str: string, inputOptions?: ParseOptions): GFF3Item[];
+/**
+ * Synchronously parse a string containing GFF3 and return an array of the
+ * parsed items.
+ *
+ * @param str - GFF3 string
+ * @param inputOptions - Parsing options
+ * @returns array of parsed features, directives, comments and/or sequences
+ */
+export declare function parseStringSync(str: string): GFF3Feature[];
 export { type GFF3FeatureLine, type GFF3Comment, type GFF3FeatureLineWithRefs, type GFF3Directive, type GFF3Sequence, type GFF3Feature, type GFF3Item, } from './util';

package/dist/api.js

@@ -5,35 +5,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseStringSync = parseStringSync;
 const parse_1 = __importDefault(require("./parse"));
-// shared arg processing for the parse routines
-function _processParseOptions(options) {
-    const out = Object.assign({ encoding: 'utf8', parseFeatures: true, parseDirectives: false, parseSequences: true, parseComments: false, disableDerivesFromReferences: false }, options);
-    if (options.parseAll) {
-        out.parseFeatures = true;
-        out.parseDirectives = true;
-        out.parseComments = true;
-        out.parseSequences = true;
-    }
-    return out;
-}
-function parseStringSync(str, inputOptions = {}) {
-    if (!str) {
-        return [];
-    }
-    const options = _processParseOptions(inputOptions);
+/**
+ * Synchronously parse a string containing GFF3 and return an array of the
+ * parsed items.
+ *
+ * @param str - GFF3 string
+ * @param inputOptions - Parsing options
+ * @returns array of parsed features, directives, comments and/or sequences
+ */
+function parseStringSync(str) {
     const items = [];
-    const push = items.push.bind(items);
     const parser = new parse_1.default({
-        featureCallback: options.parseFeatures ? push : undefined,
-        directiveCallback: options.parseDirectives ? push : undefined,
-        commentCallback: options.parseComments ? push : undefined,
-        sequenceCallback: options.parseSequences ? push : undefined,
-        disableDerivesFromReferences: options.disableDerivesFromReferences || false,
+        featureCallback: arg => items.push(arg),
+        disableDerivesFromReferences: true,
         errorCallback: err => {
             throw err;
         },
     });
-    str.split(/\r?\n/).forEach(parser.addLine.bind(parser));
+    for (const line of str.split(/\r?\n/)) {
+        parser.addLine(line);
+    }
     parser.finish();
     return items;
 }

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;AAgDA,0CA2BC;AA3ED,oDAA4B;AA0B5B,+CAA+C;AAC/C,SAAS,oBAAoB,CAAC,OAAqB;IACjD,MAAM,GAAG,mBACP,QAAQ,EAAE,MAAe,EACzB,aAAa,EAAE,IAAI,EACnB,eAAe,EAAE,KAAK,EACtB,cAAc,EAAE,IAAI,EACpB,aAAa,EAAE,KAAK,EACpB,4BAA4B,EAAE,KAAK,IAChC,OAAO,CACX,CAAA;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAA;QACxB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAA;QAC1B,GAAG,CAAC,aAAa,GAAG,IAAI,CAAA;QACxB,GAAG,CAAC,cAAc,GAAG,IAAI,CAAA;IAC3B,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAgB,eAAe,CAC7B,GAAW,EACX,eAA6B,EAAE;IAE/B,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,OAAO,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAA;IAClD,MAAM,KAAK,GAAe,EAAE,CAAA;IAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAEnC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACzD,iBAAiB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC7D,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACzD,gBAAgB,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC3D,4BAA4B,EAAE,OAAO,CAAC,4BAA4B,IAAI,KAAK;QAC3E,aAAa,EAAE,GAAG,CAAC,EAAE;YACnB,MAAM,GAAG,CAAA;QACX,CAAC;KACF,CAAC,CAAA;IAEF,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACvD,MAAM,CAAC,MAAM,EAAE,CAAA;IAEf,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;AAyCA,0CAgBC;AAzDD,oDAA4B;AAiC5B;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,eAAe,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACvC,4BAA4B,EAAE,IAAI;QAClC,aAAa,EAAE,GAAG,CAAC,EAAE;YACnB,MAAM,GAAG,CAAA;QACX,CAAC;KACF,CAAC,CAAA;IAEF,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,CAAC;IACD,MAAM,CAAC,MAAM,EAAE,CAAA;IAEf,OAAO,KAAK,CAAA;AACd,CAAC"}

package/esm/api.d.ts

@@ -1,4 +1,4 @@
-import { GFF3Item } from './util';
+import { GFF3Feature } from './util';
 /** Parser options */
 export interface ParseOptions {
     /** Whether to resolve references to derives from features */
@@ -19,5 +19,13 @@ export interface ParseOptions {
      */
     parseAll?: boolean;
 }
-export declare function parseStringSync(str: string, inputOptions?: ParseOptions): GFF3Item[];
+/**
+ * Synchronously parse a string containing GFF3 and return an array of the
+ * parsed items.
+ *
+ * @param str - GFF3 string
+ * @param inputOptions - Parsing options
+ * @returns array of parsed features, directives, comments and/or sequences
+ */
+export declare function parseStringSync(str: string): GFF3Feature[];
 export { type GFF3FeatureLine, type GFF3Comment, type GFF3FeatureLineWithRefs, type GFF3Directive, type GFF3Sequence, type GFF3Feature, type GFF3Item, } from './util';

package/esm/api.js

@@ -1,41 +1,24 @@
 import Parser from './parse';
-// shared arg processing for the parse routines
-function _processParseOptions(options) {
-    const out = {
-        encoding: 'utf8',
-        parseFeatures: true,
-        parseDirectives: false,
-        parseSequences: true,
-        parseComments: false,
-        disableDerivesFromReferences: false,
-        ...options,
-    };
-    if (options.parseAll) {
-        out.parseFeatures = true;
-        out.parseDirectives = true;
-        out.parseComments = true;
-        out.parseSequences = true;
-    }
-    return out;
-}
-export function parseStringSync(str, inputOptions = {}) {
-    if (!str) {
-        return [];
-    }
-    const options = _processParseOptions(inputOptions);
+/**
+ * Synchronously parse a string containing GFF3 and return an array of the
+ * parsed items.
+ *
+ * @param str - GFF3 string
+ * @param inputOptions - Parsing options
+ * @returns array of parsed features, directives, comments and/or sequences
+ */
+export function parseStringSync(str) {
     const items = [];
-    const push = items.push.bind(items);
     const parser = new Parser({
-        featureCallback: options.parseFeatures ? push : undefined,
-        directiveCallback: options.parseDirectives ? push : undefined,
-        commentCallback: options.parseComments ? push : undefined,
-        sequenceCallback: options.parseSequences ? push : undefined,
-        disableDerivesFromReferences: options.disableDerivesFromReferences || false,
+        featureCallback: arg => items.push(arg),
+        disableDerivesFromReferences: true,
         errorCallback: err => {
             throw err;
         },
     });
-    str.split(/\r?\n/).forEach(parser.addLine.bind(parser));
+    for (const line of str.split(/\r?\n/)) {
+        parser.addLine(line);
+    }
     parser.finish();
     return items;
 }

package/esm/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAA;AA0B5B,+CAA+C;AAC/C,SAAS,oBAAoB,CAAC,OAAqB;IACjD,MAAM,GAAG,GAAG;QACV,QAAQ,EAAE,MAAe;QACzB,aAAa,EAAE,IAAI;QACnB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,KAAK;QACpB,4BAA4B,EAAE,KAAK;QACnC,GAAG,OAAO;KACX,CAAA;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAA;QACxB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAA;QAC1B,GAAG,CAAC,aAAa,GAAG,IAAI,CAAA;QACxB,GAAG,CAAC,cAAc,GAAG,IAAI,CAAA;IAC3B,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,GAAW,EACX,eAA6B,EAAE;IAE/B,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,OAAO,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAA;IAClD,MAAM,KAAK,GAAe,EAAE,CAAA;IAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAEnC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACzD,iBAAiB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC7D,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACzD,gBAAgB,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC3D,4BAA4B,EAAE,OAAO,CAAC,4BAA4B,IAAI,KAAK;QAC3E,aAAa,EAAE,GAAG,CAAC,EAAE;YACnB,MAAM,GAAG,CAAA;QACX,CAAC;KACF,CAAC,CAAA;IAEF,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACvD,MAAM,CAAC,MAAM,EAAE,CAAA;IAEf,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAA;AAiC5B;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,eAAe,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACvC,4BAA4B,EAAE,IAAI;QAClC,aAAa,EAAE,GAAG,CAAC,EAAE;YACnB,MAAM,GAAG,CAAA;QACX,CAAC;KACF,CAAC,CAAA;IAEF,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,CAAC;IACD,MAAM,CAAC,MAAM,EAAE,CAAA;IAEf,OAAO,KAAK,CAAA;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gff-nostream",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "utilities to read GFF3 data",
   "license": "MIT",
   "repository": "cmdcolin/gff-nostream",

package/src/api.ts

@@ -1,5 +1,12 @@
 import Parser from './parse'
-import { GFF3Item } from './util'
+import {
+  GFF3Comment,
+  GFF3Directive,
+  GFF3Feature,
+  GFF3Item,
+  GFF3Sequence,
+  parseFeature,
+} from './util'
 
 /** Parser options */
 export interface ParseOptions {
@@ -24,52 +31,27 @@ export interface ParseOptions {
 
 type ParseOptionsProcessed = Required<Omit<ParseOptions, 'parseAll'>>
 
-// shared arg processing for the parse routines
-function _processParseOptions(options: ParseOptions): ParseOptionsProcessed {
-  const out = {
-    encoding: 'utf8' as const,
-    parseFeatures: true,
-    parseDirectives: false,
-    parseSequences: true,
-    parseComments: false,
-    disableDerivesFromReferences: false,
-    ...options,
-  }
-
-  if (options.parseAll) {
-    out.parseFeatures = true
-    out.parseDirectives = true
-    out.parseComments = true
-    out.parseSequences = true
-  }
-
-  return out
-}
-
-export function parseStringSync(
-  str: string,
-  inputOptions: ParseOptions = {},
-): GFF3Item[] {
-  if (!str) {
-    return []
-  }
-
-  const options = _processParseOptions(inputOptions)
-  const items: GFF3Item[] = []
-  const push = items.push.bind(items)
-
+/**
+ * Synchronously parse a string containing GFF3 and return an array of the
+ * parsed items.
+ *
+ * @param str - GFF3 string
+ * @param inputOptions - Parsing options
+ * @returns array of parsed features, directives, comments and/or sequences
+ */
+export function parseStringSync(str: string): GFF3Feature[] {
+  const items: GFF3Feature[] = []
   const parser = new Parser({
-    featureCallback: options.parseFeatures ? push : undefined,
-    directiveCallback: options.parseDirectives ? push : undefined,
-    commentCallback: options.parseComments ? push : undefined,
-    sequenceCallback: options.parseSequences ? push : undefined,
-    disableDerivesFromReferences: options.disableDerivesFromReferences || false,
+    featureCallback: arg => items.push(arg),
+    disableDerivesFromReferences: true,
     errorCallback: err => {
       throw err
     },
   })
 
-  str.split(/\r?\n/).forEach(parser.addLine.bind(parser))
+  for (const line of str.split(/\r?\n/)) {
+    parser.addLine(line)
+  }
   parser.finish()
 
   return items