@anion155/proposal-iterator-helpers 0.1.0 → 1.0.0

package/README.md

@@ -0,0 +1,39 @@
+# @anion155/proposal-iterator-helpers
+
+Implementation of the [Iterator Helpers proposal for ECMAScript](https://github.com/tc39/proposal-iterator-helpers).
+This package provides the proposal semantics and polyfills intended for testing, polyfilling, and proposal exploration.
+
+## Install
+
+Install with npm:
+
+```bash
+npm install @anion155/proposal-iterator-helpers
+```
+
+## Usage
+
+```ts
+// To polyfill prototypes and constructor without modifying global scope
+import "@anion155/proposal-iterator-helpers";
+// or
+// To also polyfill global scope use this import
+import "@anion155/proposal-iterator-helpers/global";
+// and
+// To install types
+import "@anion155/proposal-iterator-helpers/types";
+
+function* naturals() {
+  let i = 0;
+  while (true) {
+    yield i;
+    i += 1;
+  }
+}
+const result = naturals().map((value) => {
+  return value * value;
+});
+result.next(); // { value: 0, done: false };
+result.next(); // { value: 1, done: false };
+result.next(); // { value: 4, done: false };
+```

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anion155/proposal-iterator-helpers",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Polyfills implementing the Iterator Helpers proposal for ECMAScript.",
   "keywords": [
     "iterator",
@@ -10,6 +10,7 @@
     "proposal",
     "polyfill"
   ],
+  "license": "MIT",
   "author": {
     "name": "anion155",
     "url": "https://github.com/anion155"
@@ -19,27 +20,10 @@
     "url": "https://github.com/anion155/monorepo.git",
     "directory": "packages/proposal-iterator-helpers"
   },
-  "license": "MIT",
   "type": "module",
   "exports": {
-    "./global-iterator": "./src/global-iterator.ts",
-    "./global": "./src/global.ts",
     ".": "./src/index.ts",
-    "./iterator-constructor": "./src/iterator-constructor.ts",
-    "./iterator-from": "./src/iterator-from.ts",
-    "./iterator-prototype-drop": "./src/iterator-prototype-drop.ts",
-    "./iterator-prototype-every": "./src/iterator-prototype-every.ts",
-    "./iterator-prototype-filter": "./src/iterator-prototype-filter.ts",
-    "./iterator-prototype-find": "./src/iterator-prototype-find.ts",
-    "./iterator-prototype-flat-map": "./src/iterator-prototype-flat-map.ts",
-    "./iterator-prototype-for-each": "./src/iterator-prototype-for-each.ts",
-    "./iterator-prototype-map": "./src/iterator-prototype-map.ts",
-    "./iterator-prototype-reduce": "./src/iterator-prototype-reduce.ts",
-    "./iterator-prototype-some": "./src/iterator-prototype-some.ts",
-    "./iterator-prototype-take": "./src/iterator-prototype-take.ts",
-    "./iterator-prototype-to-array": "./src/iterator-prototype-to-array.ts",
-    "./iterator-prototype": "./src/iterator-prototype.ts",
-    "./utils": "./src/utils.ts"
-  },
-  "dependencies": {}
+    "./global": "./src/global.ts",
+    "./types": "./src/types.ts"
+  }
 }

package/src/iterator-from.ts

@@ -39,7 +39,9 @@ ProxyIterator.prototype = Object.create(IteratorPrototype, {
 }) as ProxyIterator<unknown, unknown, unknown>;
 
 polyfillProperty(IteratorConstructor, "from", {
-  value: function from<T, TReturn = unknown, TNext = unknown>(it: Iterator<T, TReturn, TNext> | Iterable<T>): IteratorObject<T, TReturn, TNext> {
+  value: function from<T, TReturn = unknown, TNext = undefined>(
+    it: Iterator<T, TReturn, TNext> | Iterable<T, TReturn, TNext>,
+  ): IteratorObject<T, TReturn, TNext> {
     if (isIteratorInstance<T, TReturn, TNext>(it)) return it;
     const iterator = isIterable(it) ? it[Symbol.iterator]() : it;
     if (isIteratorInstance<T, TReturn, TNext>(iterator)) return iterator;

package/src/types.ts

@@ -0,0 +1,28 @@
+interface Iterator<T, TResult, TNext> extends globalThis.IteratorObject<T, TResult, TNext> {}
+declare abstract class Iterator<T, TResult = undefined, TNext = unknown> {
+  abstract next(value?: TNext): IteratorResult<T, TResult>;
+}
+type IteratorObjectConstructor = typeof Iterator;
+declare global {
+  interface IteratorObject<T, TReturn, TNext> {
+    readonly [Symbol.toStringTag]: string;
+    [Symbol.iterator](): IteratorObject<T, TReturn, TNext>;
+    drop(limit: number): Generator<T, TReturn, TNext>;
+    every(predicate: (value: T, index: number) => boolean): boolean;
+    filter(predicate: (value: T, index: number) => boolean): Generator<T, TReturn, TNext>;
+    find(predicate: (value: T, index: number) => boolean): T | undefined;
+    flatMap<U>(project: (value: T, index: number) => Iterator<U> | Iterable<U>): Generator<U, TReturn, undefined>;
+    forEach(callback: (value: T, index: number) => void): void;
+    map<U>(project: (value: T, index: number) => U): Generator<U, TReturn, TNext>;
+    reduce<U>(reducer: (aggregation: U, value: T, index: number) => U, ...args: [initialValue?: U]): U;
+    some(predicate: (value: T, index: number) => boolean): boolean;
+    take(limit: number): Generator<T, T | TReturn | undefined, TNext>;
+    toArray(): T[];
+  }
+  interface IteratorConstructor extends IteratorObjectConstructor {
+    from<T, TReturn = unknown, TNext = undefined>(it: Iterator<T, TReturn, TNext> | Iterable<T, TReturn, TNext>): IteratorObject<T, TReturn, TNext>;
+  }
+  var Iterator: IteratorConstructor;
+}
+
+export {};