iteragain - npm Package Compare versions

Comparing version 3.17.4 to 3.18.0

package.json

 {
   "name": "iteragain",
-  "version": "3.17.4",
+  "version": "3.18.0",
   "description": "Javascript Iterable/Iterator/Generator-function utilities.",
@@ -20,2 +20,3 @@ "main": "index.js",
     "iterplus": "^3.0.2",
+    "ix": "^5.0.0",
     "lint-staged": "^13.2.2",
@@ -68,4 +69,3 @@ "mocha": "10.2.0",
     "*.ts": [
-      "eslint --cache --fix",
-      "prettier --write"
+      "eslint --cache --fix"
     ]
@@ -85,2 +85,4 @@ },
     "test:debug": "pnpm run test --inspect",
+    "check": "tsc -p tsconfig.test.json",
+    "check:watch": "pnpm run check --watch",
     "coverage": "nyc --skip-full ts-mocha test/**.test.ts --reporter spec",
@@ -87,0 +89,0 @@ "bm": "ts-node benchmark/index.bm.ts",

README.md

@@ -1,4 +0,6 @@
-
 # [iteragain](https://www.npmjs.com/package/iteragain)
 
+[![Run Tests](https://github.com/danieloakman/iteragain/actions/workflows/run-tests.yml/badge.svg)](https://github.com/danieloakman/iteragain/actions/workflows/run-tests.yml)
+[![Deploy Documentation](https://github.com/danieloakman/iteragain/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/danieloakman/iteragain/actions/workflows/deploy-docs.yml)
+
 Another Javascript library for iterating.
@@ -12,6 +14,8 @@
 
-__You can see the full list of modules and the documentation on everything [here](https://danieloakman.github.io/iteragain).__
-
 See [iteragain-es](https://www.npmjs.com/package/iteragain-es) for the ES modules exported version of this package.
 
+## Documentation
+
+You can see the full list of modules and the documentation on everything [here](https://danieloakman.github.io/iteragain).
+
 ## Code examples
@@ -49,3 +53,3 @@
 
-### Using the `range` standalone function.
+### Using the `range` standalone function
 
@@ -70,3 +74,3 @@ ```js
 
-### Iterating through any object's properties recursively.
+### Iterating through any object's properties recursively
 
@@ -91,14 +95,48 @@ ```js
 
+### Accessing elements from an iterator with [arrayLike](https://danieloakman.github.io/iteragain/functions/arrayLike.arrayLike.html)
+
+The `arrayLike` uses a [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) that wraps a [seekable](https://danieloakman.github.io/iteragain/functions/seekable.seekable.html) iterator. This allows access to elements from the iterator. This can be useful when you may need to easily search behind the current element, then look ahead, or just access elements by index.
+
+```js
+import { arrayLike, range, iter, toArray } from 'iteragain';
+
+const arr = arrayLike(iter(range(100)).map(n => n * n)); // Cached elements: []
+arr.length; // Returns 0
+
+arr[4]; // Returns 16. Cached elements: [0, 1, 4, 9, 16]
+arr.length; // returns 5
+
+arr[9]; // Returns 81. Cached elements: [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
+arr.length; // Returns 10
+
+// Negative indices are supported, because internally it's just a seekable.
+// This will seek starting from the end of the internal cache.
+arr[-1]; // Returns 81. Cached elements: [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
+arr.length; // Returns 10
+
+// All other array methods are supported, as it's of type `readonly number[]`.
+// Including using it as an iterable:
+for (const n of arr) {
+  console.log(n);
+  if (n > 20) break;
+}
+
+// Exhausts the iterator wrapped inside of `arr`. `collected` is just a regular array.
+const collected = toArray(arr);
+```
+
 ## Inpired by
 
-[iterplus](https://www.npmjs.com/package/iterplus), [iterare](https://www.npmjs.com/package/iterare), [lodash](https://www.npmjs.com/package/lodash), [rxjs](https://www.npmjs.com/package/rxjs) and the Python [itertools](https://docs.python.org/3/library/itertools.html) and [more-itertools](https://pypi.org/project/more-itertools/) modules. See benchmark section for performance against some of these.
+[iterplus](https://www.npmjs.com/package/iterplus), [iterare](https://www.npmjs.com/package/iterare), [lodash](https://www.npmjs.com/package/lodash), [rxjs](https://www.npmjs.com/package/rxjs), [ixjs](https://www.npmjs.com/package/ix) and the Python [itertools](https://docs.python.org/3/library/itertools.html) and [more-itertools](https://pypi.org/project/more-itertools/) modules. See benchmark section for performance against some of these.
 
 ## Benchmark
 
-```
+```md
 Starting benchmark suite: index.bm.ts
-  for of loop x 2,015 ops/sec, ±47 ops/sec or ±2.33% (90 runs sampled)
-  iteragain x 1,431 ops/sec, ±25 ops/sec or ±1.74% (92 runs sampled)
-  iterare x 1,368 ops/sec, ±20 ops/sec or ±1.48% (95 runs sampled)
-  rxjs x 989 ops/sec, ±10 ops/sec or ±1.05% (93 runs sampled)
+  for of loop x 2,831 ops/sec, ±10 ops/sec or ±0.35% (98 runs sampled)
+  iteragain x 1,853 ops/sec, ±7 ops/sec or ±0.36% (98 runs sampled)
+  iteragain standalones x 1,740 ops/sec, ±27 ops/sec or ±1.57% (97 runs sampled)
+  iterare x 1,754 ops/sec, ±31 ops/sec or ±1.76% (96 runs sampled)
+  rxjs x 1,319 ops/sec, ±7 ops/sec or ±0.50% (96 runs sampled)
+  ixjs x 873 ops/sec, ±15 ops/sec or ±1.70% (95 runs sampled)
 ```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

139

increased by37.62%

Worsened metrics

Total package byte prevSize

90555

decreased by-72.27%

Dev dependency count

26

increased by4%

Number of package files

10

decreased by-97.49%

Lines of code

8

decreased by-99.8%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes