@gmod/bbi - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

CHANGELOG.md

@@ -1,5 +0,9 @@
-## [4.0.1](https://github.com/GMOD/bbi-js/compare/v4.0.0...v4.0.1) (2023-07-13)
+## [4.0.2](https://github.com/GMOD/bbi-js/compare/v4.0.1...v4.0.2) (2023-07-30)
 
 
 
+- Fix issue with fetching headers that are large in certain cases
+
+## [4.0.1](https://github.com/GMOD/bbi-js/compare/v4.0.0...v4.0.1) (2023-07-13)
+
 - Fix eslint plugin being in dependencies Accidentally
@@ -6,0 +10,0 @@

dist/bbi.js

@@ -97,5 +97,9 @@ "use strict";
      * @param filehandle - a filehandle from generic-filehandle or implementing something similar to the node10 fs.promises API
+     *
      * @param path - a Local file path as a string
+     *
      * @param url - a URL string
-     * @param renameRefSeqs - an optional method to rename the internal reference sequences using a mapping function
+     *
+     * @param renameRefSeqs - an optional method to rename the internal reference
+     * sequences using a mapping function
      */
@@ -140,3 +144,5 @@ constructor(args) {
             }
-            if (header.totalSummaryOffset > requestSize) {
+            // refetch header if it is too large on first pass,
+            // 8*5 is the sizeof the totalSummary struct
+            if (header.totalSummaryOffset > requestSize - 8 * 5) {
                 return this._getMainHeader(opts, requestSize * 2);
@@ -143,0 +149,0 @@ }

esm/bbi.js

@@ -85,5 +85,9 @@ import { Buffer } from 'buffer';
      * @param filehandle - a filehandle from generic-filehandle or implementing something similar to the node10 fs.promises API
+     *
      * @param path - a Local file path as a string
+     *
      * @param url - a URL string
-     * @param renameRefSeqs - an optional method to rename the internal reference sequences using a mapping function
+     *
+     * @param renameRefSeqs - an optional method to rename the internal reference
+     * sequences using a mapping function
      */
@@ -125,3 +129,5 @@ constructor(args) {
         }
-        if (header.totalSummaryOffset > requestSize) {
+        // refetch header if it is too large on first pass,
+        // 8*5 is the sizeof the totalSummary struct
+        if (header.totalSummaryOffset > requestSize - 8 * 5) {
             return this._getMainHeader(opts, requestSize * 2);
@@ -128,0 +134,0 @@ }

package.json

 {
   "name": "@gmod/bbi",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Parser for BigWig/BigBed files",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -151,3 +151,3 @@ # bbi-js
 - name: a string to search for in the BigBed extra indices
-- opts: an opject that can optionally contain opts.signal, an abort signal
+- opts: an object that can optionally contain opts.signal, an abort signal
 
@@ -154,0 +154,0 @@ Returns a Promise to an array of Features, with an extra field indicating the

src/bbi.ts

@@ -145,5 +145,9 @@ import { Buffer } from 'buffer'
    * @param filehandle - a filehandle from generic-filehandle or implementing something similar to the node10 fs.promises API
+   *
    * @param path - a Local file path as a string
+   *
    * @param url - a URL string
-   * @param renameRefSeqs - an optional method to rename the internal reference sequences using a mapping function
+   *
+   * @param renameRefSeqs - an optional method to rename the internal reference
+   * sequences using a mapping function
    */
@@ -198,5 +202,9 @@ public constructor(args: {
     }
-    if (header.totalSummaryOffset > requestSize) {
+
+    // refetch header if it is too large on first pass,
+    // 8*5 is the sizeof the totalSummary struct
+    if (header.totalSummaryOffset > requestSize - 8 * 5) {
       return this._getMainHeader(opts, requestSize * 2)
     }
+
     if (header.totalSummaryOffset) {
@@ -203,0 +211,0 @@ const tail = buffer.subarray(Number(header.totalSummaryOffset))

No alert changes

Improved metrics

Total package byte prevSize

245809

increased by0.28%

Lines of code

4163

increased by0.43%

No dependency changes