it-map - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

dist/src/index.d.ts

@@ -5,3 +5,6 @@ /**
  */
-export default function map<I, O>(source: AsyncIterable<I> | Iterable<I>, func: (val: I) => O | Promise<O>): AsyncGenerator<O, void, undefined>;
+declare function map<I, O>(source: Iterable<I>, func: (val: I) => Promise<O>): AsyncGenerator<O, void, undefined>;
+declare function map<I, O>(source: Iterable<I>, func: (val: I) => O): Generator<O, void, undefined>;
+declare function map<I, O>(source: AsyncIterable<I>, func: (val: I) => O | Promise<O>): AsyncGenerator<O, void, undefined>;
+export default map;
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

@@ -1,10 +0,37 @@
-/**
- * Takes an (async) iterable and returns one with each item mapped by the passed
- * function
- */
-export default async function* map(source, func) {
-    for await (const val of source) {
-        yield func(val);
+import peek from 'it-peekable';
+function isAsyncIterable(thing) {
+    return thing[Symbol.asyncIterator] != null;
+}
+function map(source, func) {
+    if (isAsyncIterable(source)) {
+        return (async function* () {
+            for await (const val of source) {
+                yield func(val);
+            }
+        })();
     }
+    // if mapping function returns a promise we have to return an async generator
+    const peekable = peek(source);
+    const { value, done } = peekable.next();
+    if (done === true) {
+        return (function* () { }());
+    }
+    const res = func(value);
+    // @ts-expect-error .then is not present on O
+    if (typeof res.then === 'function') {
+        return (async function* () {
+            yield await res;
+            for await (const val of peekable) {
+                yield func(val);
+            }
+        })();
+    }
+    const fn = func;
+    return (function* () {
+        for (const val of source) {
+            yield fn(val);
+        }
+    })();
 }
+export default map;
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "it-map",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Maps the values yielded by an async iterator",
@@ -23,3 +23,3 @@ "author": "Alex Potsides <[e-mail]>",
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
@@ -140,3 +140,6 @@ "!**/*.tsbuildinfo"
     "aegir": "^38.1.7"
+  },
+  "dependencies": {
+    "it-peekable": "^3.0.0"
   }
 }

README.md

 # it-map <!-- omit in toc -->
 
 [![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
-[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
@@ -11,5 +11,6 @@ > Maps the values yielded by an async iterator
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [License](#license)
-- [Contribute](#contribute)
+- [Contribution](#contribution)
 
@@ -22,2 +23,10 @@ ## Install
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `ItMap` in the global namespace.
+
+```html
+<script src="https://unpkg.com/it-map/dist/index.min.js"></script>
+```
+
 ## Usage
@@ -28,10 +37,24 @@
 
-// This can also be an iterator, async iterator, generator, etc
+// This can also be an iterator, generator, etc
 const values = [0, 1, 2, 3, 4]
 
-const result = await map(values, (val) => val++)
+const result = map(values, (val) => val++)
 
-console.info(result) // 15
+console.info(result) // [1, 2, 3, 4, 5]
 ```
 
+Async sources and transforms must be awaited:
+
+```javascript
+import map from 'it-map'
+
+const values = async function * () {
+  yield * [0, 1, 2, 3, 4]
+}
+
+const result = await map(values(), async (val) => val++)
+
+console.info(result) // [1, 2, 3, 4, 5]
+```
+
 ## License
@@ -44,4 +67,4 @@
 
-## Contribute
+## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

src/index.ts

@@ -0,1 +1,7 @@
+import peek from 'it-peekable'
+
+function isAsyncIterable <T> (thing: any): thing is AsyncIterable<T> {
+  return thing[Symbol.asyncIterator] != null
+}
+
 /**
@@ -5,6 +11,44 @@ * Takes an (async) iterable and returns one with each item mapped by the passed
  */
-export default async function * map <I, O> (source: AsyncIterable<I> | Iterable<I>, func: (val: I) => O | Promise<O>): AsyncGenerator<O, void, undefined> {
-  for await (const val of source) {
-    yield func(val)
+function map <I, O> (source: Iterable<I>, func: (val: I) => Promise<O>): AsyncGenerator<O, void, undefined>
+function map <I, O> (source: Iterable<I>, func: (val: I) => O): Generator<O, void, undefined>
+function map <I, O> (source: AsyncIterable<I>, func: (val: I) => O | Promise<O>): AsyncGenerator<O, void, undefined>
+function map <I, O> (source: AsyncIterable<I> | Iterable<I>, func: (val: I) => O | Promise<O>): AsyncGenerator<O, void, undefined> | Generator<O, void, undefined> {
+  if (isAsyncIterable(source)) {
+    return (async function * () {
+      for await (const val of source) {
+        yield func(val)
+      }
+    })()
   }
+
+  // if mapping function returns a promise we have to return an async generator
+  const peekable = peek(source)
+  const { value, done } = peekable.next()
+
+  if (done === true) {
+    return (function * () {}())
+  }
+
+  const res = func(value)
+
+  // @ts-expect-error .then is not present on O
+  if (typeof res.then === 'function') {
+    return (async function * () {
+      yield await res
+
+      for await (const val of peekable) {
+        yield func(val)
+      }
+    })()
+  }
+
+  const fn = func as (val: I) => O
+
+  return (function * () {
+    for (const val of source) {
+      yield fn(val)
+    }
+  })()
 }
+
+export default map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11628

increased by85.04%

Number of package files

9

increased by12.5%

Lines of code

94

increased by308.7%

Number of lines in readme file

67

increased by52.27%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedit-peekable@^3.0.0

• + Addedit-peekable@3.0.5(transitive)