feat: support mapEffect (#298)

* feat: support mapEffect

* docs: update other alias function

src/Lazy/fx.ts

@@ -66,6 +66,15 @@ class FxAsyncIterable<A> {
     return new FxAsyncIterable(map(f, this.asyncIterable));
   }
 
+  /**
+   * A function that is identical to `map`, but is intended to create side effects as part of its convention.
+   *
+   * see {@link https://fxts.dev/docs/map | map}
+   */
+  mapEffect<B>(f: (a: A) => B) {
+    return new FxAsyncIterable(map(f, this.asyncIterable));
+  }
+
   /**
    * Returns flattened AsyncIterable of values by running each element
    * flattening the mapped results.
@@ -366,6 +375,15 @@ export class FxIterable<A> {
     return new FxIterable(map(f, this.iterable));
   }
 
+  /**
+   * A function that is identical to `map`, but is intended to create side effects as part of its convention.
+   *
+   * see {@link https://fxts.dev/docs/map | map}
+   */
+  mapEffect<B>(f: (a: A) => B): FxIterable<B> {
+    return new FxIterable(map(f, this.iterable));
+  }
+
   /**
    * Returns flattened Iterable of values by running each element
    * flattening the mapped results.

src/Lazy/index.ts

@@ -66,6 +66,7 @@ export {
   intersectionBy,
   keys,
   map,
+  map as mapEffect,
   peek,
   pipeLazy,
   pluck,

src/Lazy/map.ts

@@ -1,5 +1,4 @@
-import { AsyncFunctionException } from "../_internal/error";
-import { isAsyncIterable, isIterable, isPromise } from "../_internal/utils";
+import { isAsyncIterable, isIterable } from "../_internal/utils";
 import type Awaited from "../types/Awaited";
 import type IterableInfer from "../types/IterableInfer";
 import type ReturnIterableIteratorType from "../types/ReturnIterableIteratorType";
@@ -55,6 +54,8 @@ function async<A, B>(
 /**
  * Returns Iterable/AsyncIterable of values by running each applying `f`.
  *
+ * If the `map` causes side effects, it is recommended to use `mapEffect` instead.
+ *
  * @example
  * ```ts
  * const iter = map(a => a + 10, [1, 2, 3, 4]);

src/head.ts

@@ -14,7 +14,9 @@ type HeadReturnType<T> = T extends readonly [a: infer H, ...rest: any[]]
   : never;
 
 /**
- * Returns the first element of Iterable/AsyncIterable. (head)
+ * Returns the first element of Iterable/AsyncIterable.
+ *
+ * There is another alias function called `first`.
  *
  * @example
  * ```ts

src/includes.ts

@@ -3,7 +3,9 @@ import some from "./some";
 import type ReturnValueType from "./types/ReturnValueType";
 
 /**
- * Checks if the specified value is equal. (contains)
+ * Checks if the specified value is equal.
+ *
+ * There is another alias function called `contains`.
  *
  * @example
  * ```ts