Update docs

GMOD · Aug 9, 2024 · 4b452e4 · 4b452e4
1 parent 5f173e6
commit 4b452e4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,38 +1,32 @@
 # [2.0.0](https://github.com/GMOD/twobit-js/compare/v1.1.14...v2.0.0) (2024-08-09)
 
-
+- Remove @gmod/binary-parser
 
 ## [1.1.14](https://github.com/GMOD/twobit-js/compare/v1.1.13...v1.1.14) (2022-07-18)
 
-
-
 - Update generic-filehandle 2->3
 
 <a name="1.1.13"></a>
-## [1.1.13](https://github.com/GMOD/twobit-js/compare/v1.1.12...v1.1.13) (2022-03-30)
-
 
+## [1.1.13](https://github.com/GMOD/twobit-js/compare/v1.1.12...v1.1.13) (2022-03-30)
 
 - Publish src directory for better source maps
 
 <a name="1.1.12"></a>
-## [1.1.12](https://github.com/GMOD/twobit-js/compare/v1.1.11...v1.1.12) (2021-12-14)
-
 
+## [1.1.12](https://github.com/GMOD/twobit-js/compare/v1.1.11...v1.1.12) (2021-12-14)
 
 - Remove es6-promisify dependency
 
 <a name="1.1.11"></a>
-## [1.1.11](https://github.com/GMOD/twobit-js/compare/v1.1.10...v1.1.11) (2021-12-14)
-
 
+## [1.1.11](https://github.com/GMOD/twobit-js/compare/v1.1.10...v1.1.11) (2021-12-14)
 
 - Typescriptify codebase and add esm build
 
 <a name="1.1.10"></a>
-## [1.1.10](https://github.com/GMOD/twobit-js/compare/v1.1.9...v1.1.10) (2019-10-06)
-
 
+## [1.1.10](https://github.com/GMOD/twobit-js/compare/v1.1.9...v1.1.10) (2019-10-06)
 
 - Small refactor of `filehandle.read()` to make it more robust
 
@@ -42,13 +36,10 @@
 
 ## [1.1.8](https://github.com/GMOD/twobit-js/compare/v1.1.6...v1.1.8) (2019-04-04)
 
-
-
 - Add @babel/runtime-corejs2 as a runtime dependency
 
 ## [1.1.7](https://github.com/GMOD/twobit-js/compare/v1.1.6...v1.1.7) (2019-04-03)
 
-
 - Use core-js to polyfill Object.values instead of polyfill library
 
 ## [1.1.6](https://github.com/GMOD/twobit-js/compare/v1.1.5...v1.1.6) (2019-04-03)
@@ -71,7 +62,6 @@
 
 - Use @gmod/binary-parser
 
-
 ## 1.1.1
 
 - Use babel-plugin-transform-runtime

diff --git a/README.md b/README.md
@@ -81,10 +81,9 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 #### getSequenceSizes
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** for an object listing the lengths of all sequences like
-`{seqName: length, ...}`. note: this is a relatively slow operation
-especially if there are many refseqs in the file, if you can get this
-information from a different file e.g. a chrom.sizes file, it will be much
-faster
+`{seqName: length, ...}`.note: this is a relatively slow operation especially if there are many
+refseqs in the file, if you can get this information from a different file
+e.g. a chrom.sizes file, it will be much faster
 
 #### getSequenceSize
 
@@ -100,7 +99,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `seqName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the sequence you want
 *   `regionStart` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** optional 0-based half-open start of the sequence region to fetch. (optional, default `0`)
-*   `regionEnd` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** optional 0-based half-open end of the sequence region to fetch. defaults to end of the sequence
+*   `regionEnd` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** optional 0-based half-open end of the sequence region to fetch. defaults to end of the sequence (optional, default `Number.POSITIVE_INFINITY`)
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** for a string of sequence bases