@gmod/bam - npm Package Compare versions

Comparing version 1.1.6 to 1.1.7

CHANGELOG.md

@@ -0,6 +1,12 @@
+<a name="1.1.7"></a>
+## [1.1.7](https://github.com/GMOD/bam-js/compare/v1.1.6...v1.1.7) (2021-05-21)
+
+
+
+- New param yieldThreadTime to constructor to yield while processing
+
 <a name="1.1.6"></a>
+
 ## [1.1.6](https://github.com/GMOD/bam-js/compare/v1.1.5...v1.1.6) (2021-02-20)
 
-
-
 - Add qualRaw function on records for getting raw qual score array instead of string
@@ -7,0 +13,0 @@

dist/bamFile.d.ts

@@ -17,2 +17,3 @@ /// <reference types="node" />
     protected indexToChr: any;
+    private yieldThreadTime;
     /**
@@ -25,3 +26,3 @@ * @param {object} args
      */
-    constructor({ bamFilehandle, bamPath, bamUrl, baiPath, baiFilehandle, baiUrl, csiPath, csiFilehandle, csiUrl, cacheSize, fetchSizeLimit, chunkSizeLimit, renameRefSeqs, }: {
+    constructor({ bamFilehandle, bamPath, bamUrl, baiPath, baiFilehandle, baiUrl, csiPath, csiFilehandle, csiUrl, cacheSize, fetchSizeLimit, chunkSizeLimit, yieldThreadTime, renameRefSeqs, }: {
         bamFilehandle?: GenericFilehandle;
@@ -40,2 +41,3 @@ bamPath?: string;
         renameRefSeqs?: (a: string) => string;
+        yieldThreadTime: number;
     });
@@ -77,9 +79,2 @@ getHeader(origOpts?: AbortSignal | BaseOpts): Promise<{
         start: number;
-        /**
-         * @param {object} args
-         * @param {string} [args.bamPath]
-         * @param {FileHandle} [args.bamFilehandle]
-         * @param {string} [args.baiPath]
-         * @param {FileHandle} [args.baiFilehandle]
-         */
         end: number;
@@ -86,0 +81,0 @@ score: number;

package.json

 {
   "name": "@gmod/bam",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Parser for BAM and BAM index (bai) files",
@@ -44,3 +44,3 @@ "license": "MIT",
     "@gmod/bgzf-filehandle": "^1.3.3",
-    "abortable-promise-cache": "^1.2.0",
+    "abortable-promise-cache": "^1.4.0",
     "buffer-crc32": "^0.2.13",
@@ -47,0 +47,0 @@ "cross-fetch": "^3.0.2",

README.md

@@ -56,2 +56,3 @@ [![Generated with nod](https://img.shields.io/badge/generator-nod-2196F3.svg?style=flat-square)](https://github.com/diegohaz/nod)
 - cacheSize - limit on number of chunks to cache. default: 50
+- yieldThreadTime - the interval at which the code yields to the main thread when it is parsing a lot of data. default: 100ms. Set to 0 to performed no yielding
 
@@ -58,0 +59,0 @@ Note: filehandles implement the Filehandle interface from https://www.npmjs.com/package/generic-filehandle. This module offers the path and url arguments as convenience methods for supplying the LocalFile and RemoteFile

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

346157

increased by0.25%

Number of lines in readme file

150

increased by0.67%

Worsened metrics

Lines of code

3794

decreased by-0.03%

Dependency changes

• Updatedabortable-promise-cache@^1.4.0