fast-boolean-array 1.4.5 → 1.4.7

package/README.md

@@ -1,4 +1,4 @@
-# Fast Boolean Array
+# Fast Boolean Array ![Build](https://github.com/UltraCakeBakery/FastBooleanArray/actions/workflows/ci.yml/badge.svg?event=push)
 
 In JavaScript, when working with large arrays of boolean values, a common challenge is efficiently indexing and retrieving these values. Using a regular JavaScript array to store booleans is straightforward, but it is memory-inefficient. While booleans are conceptually 1-bit values, JavaScript engines, like V8 (in Chrome and Node.js), allocate 1 byte (8 bits) per boolean for optimization purposes. This can waste a significant amount of memory when dealing with large arrays.
 
@@ -8,53 +8,47 @@ For detailed benchmark results, see below.
 
 ## Features
 
-
 - **Memory Efficiency**: Stores booleans in bits rather than bytes, drastically reducing memory usage.
 - **Fast Set Performance**: Up to 10x faster sets for fast data re-mapping.
-- **Familiar API**:  `Map` and `Set` like API for minimal learning curve. Intuitive helper functions, and works in `for.. of`.
-- **Array like interface**: call `.accessLikeArray()` to access it like an array`someArray[index]` (beware of the performance penalty caused by the Proxy)! 
----
-
-## Why Use Fast Boolean Array?
+- **Familiar API**: `Map` and `Set` like API for minimal learning curve. Intuitive helper functions, and works in `for.. of`.
+- **Array like interface**: call `.accessLikeArray()` to access it like an array`someArray[index]` (beware of the performance penalty caused by the Proxy)!
 
-- **Easy to Use**: Familiar `Map` and `Set` like API for minimal learning curve.
-- **Scalable**: Suitable for high-performance, memory-sensitive projects.
 ---
 
-## Installation
-
-Install the package via npm:
-
-```bash
-npm install fast-boolean-array --save-dev
-pnpm install fast-boolean-array --save-dev
-```
-
----
-
-## Usage
+## Usage example:
 
 Here's how to use the Fast Boolean Array:
 
 ```javascript
-import BooleanArray from 'fast-boolean-array';
+import BooleanArray from "fast-boolean-array";
 // const BooleanArray = require('fast-boolean-array'); commonjs works too.
 
-// Create a new BooleanArray with the desired size
+// Create a new BooleanArray with the desired length
 const booleans = new BooleanArray(2);
 
 // Set a value at a specific index
 booleans.set(0, true);
 booleans.set(1, false);
 
-// Retrieve it
+// Retrieve a value at a specific index
 console.log(booleans.get(0)); // Output: true
 console.log(booleans.get(1)); // Output: false
 
 booleans.set(3, true); // will not throw, but returns false as the boolean is not found
 console.log(booleans.get(3)); // Output: false
 
-booleans.setSafe(3, true); // will throw RangeError
+booleans.setSafe(3, true); // will throw RangeError because the array has a length of 2
+```
+
+---
+
+## Installation
+
+Install the package:
+
+```bash
+npm install fast-boolean-array
+pnpm install fast-boolean-array
 ```
 
 ---

package/package.json

@@ -1,53 +1,52 @@
-{
-  "name": "fast-boolean-array",
-  "version": "1.4.5",
-  "homepage": "https://github.com/UltraCakeBakery/FastBooleanArray",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/UltraCakeBakery/FastBooleanArray.git"
-  },
-  "bugs": {
-    "url": "https://github.com/UltraCakeBakery/FastBooleanArray/issues",
-    "email": "fast-boolean-array@managing.software"
-  },
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    "import": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "require": {
-      "types": "./dist/index.d.cts",
-      "require": "./dist/index.cjs"
-    }
-  },
-  "scripts": {
-    "check": "npm run check:types ; npm run check:test",
-    "check:test": "vitest",
-    "check:types": "npx --yes @arethetypeswrong/cli --pack .",
-    "build": "tsup src/index.ts --dts --format cjs,esm --clean --sourcemap --minify",
-    "publish": "npm publish"
-  },
-  "keywords": [
-    "boolean",
-    "array",
-    "fast",
-    "efficient",
-    "map"
-  ],
-  "author": "Jack van der Bil  <jack@managing.software> (https://jackvanderbilt.nl)",
-  "license": "MIT",
-  "description": "",
-  "engines": {
-    "node": ">=0.10.3"
-  },
-  "devDependencies": {
-    "@types/node": "^22.10.2",
-    "tsup": "^8.3.5",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.8"
-  }
+{
+  "name": "fast-boolean-array",
+  "version": "1.4.7",
+  "homepage": "https://github.com/UltraCakeBakery/FastBooleanArray",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UltraCakeBakery/FastBooleanArray.git"
+  },
+  "bugs": {
+    "url": "https://github.com/UltraCakeBakery/FastBooleanArray/issues",
+    "email": "fast-boolean-array@managing.software"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "test": "vitest",
+    "check-types": "npx --yes @arethetypeswrong/cli --pack .",
+    "build": "tsup src/index.ts --dts --format cjs,esm --clean --sourcemap --minify",
+    "publish": "npm publish"
+  },
+  "keywords": [
+    "boolean",
+    "array",
+    "fast",
+    "efficient",
+    "map"
+  ],
+  "author": "Jack van der Bil  <jack@managing.software> (https://jackvanderbilt.nl)",
+  "license": "MIT",
+  "description": "",
+  "engines": {
+    "node": ">=0.10.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.2"
+  }
 }

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"