readme

Author: cmdcolin

CHANGELOG.md

@@ -1,7 +1,5 @@
 ## [6.0.1](https://github.com/GMOD/twobit-js/compare/v6.0.0...v6.0.1) (2025-05-13)
 
-
-
 # [6.0.0](https://github.com/GMOD/twobit-js/compare/v4.0.1...v6.0.0) (2025-04-30)
 
 # [5.0.0](https://github.com/GMOD/twobit-js/compare/v4.0.1...v5.0.0) (2025-04-30)

README.md

@@ -58,7 +58,6 @@ const seqNames = await t.getSequenceNames()
 ##### Parameters
 
 - `args` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-
   - `args.filehandle` **Filehandle?** node fs.promises-like filehandle for the .2bit file.
     Only needs to support `filehandle.read(buffer, offset, length, position)`
   - `args.path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** filesystem path for the .2bit file to open

package.json

@@ -31,18 +31,20 @@
   ],
   "scripts": {
     "test": "vitest",
+    "benchonly": "vitest bench",
+    "bench": "./scripts/build-both-branches.sh \"$BRANCH1\" \"$BRANCH2\" && vitest bench",
     "format": "prettier --write .",
     "coverage": "yarn test --coverage",
     "lint": "eslint --report-unused-disable-directives --max-warnings 0",
     "docs": "documentation readme src/twoBitFile.ts --section=TwoBitFile",
     "postdocs": "yarn format && git commit -am 'readme'",
     "clean": "rimraf dist esm",
-    "prebuild": "yarn docs && yarn clean",
+    "prebuild": "yarn clean",
     "build:esm": "tsc --outDir esm",
     "build:es5": "tsc --module commonjs --outDir dist",
     "build": "yarn build:esm && yarn build:es5",
     "postbuild:es5": "echo '{\"type\": \"commonjs\"}' > dist/package.json",
-    "preversion": "npm run build",
+    "preversion": "yarn docs && yarn build",
     "version": "standard-changelog && git add CHANGELOG.md",
     "postversion": "git push --follow-tags"
   },
@@ -54,17 +56,17 @@
     "generic-filehandle2": "^2.0.1"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^3.0.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "documentation": "^14.0.1",
     "eslint": "^9.7.0",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-unicorn": "^61.0.2",
+    "eslint-plugin-unicorn": "^62.0.0",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
     "standard-changelog": "^7.0.1",
     "typescript": "^5.5.3",
     "typescript-eslint": "^8.13.0",
-    "vitest": "^3.0.1"
+    "vitest": "^4.0.15"
   },
   "publishConfig": {
     "access": "public"