@effectionx/stream-helpers 0.1.1 → 0.3.0

package/README.md

@@ -144,6 +144,54 @@ function* example() {
 }
 ```
 
+### ForEach
+
+The `forEach` helper invokes a function for each item passing through a stream.
+This is useful when you need to perform side effects or operations on each item
+without transforming the stream itself. Unlike other stream helpers that return
+transformed streams, `forEach` consumes the entire stream and returns the
+stream's close value.
+
+```typescript
+import { forEach } from "@effectionx/stream-helpers";
+import { createSignal, spawn } from "effection";
+
+function* example() {
+  const stream = createSignal<number, void>();
+
+  // Process each item in the stream
+  yield* spawn(() =>
+    forEach(function* (item) {
+      console.log(`Processing: ${item}`);
+      // Perform any side effects here
+    }, stream)
+  );
+
+  stream.send(1);
+  stream.send(2);
+  stream.send(3);
+  stream.close();
+}
+
+// Example: Handling stream close value
+function* exampleWithCloseValue() {
+  const stream = createSignal<string, number>();
+
+  const result = yield* spawn(() =>
+    forEach(function* (item) {
+      console.log(`Item: ${item}`);
+    }, stream)
+  );
+
+  stream.send("hello");
+  stream.send("world");
+  stream.close(42); // Close with value 42
+
+  const closeValue = yield* result;
+  console.log(`Stream closed with: ${closeValue}`); // 42
+}
+```
+
 ### Passthrough Tracker
 
 Passthrough Tracker stream helper provides a way to know if all items that
@@ -183,8 +231,7 @@ You can use a simple `pipe()` to compose a series of stream helpers together. In
 this example, we use one from [remeda](https://remedajs.com/docs/#pipe),
 
 ```typescript
-import { batch, filter, map, valve } from "@effectionx/stream-helpers";
-import { each } from "effection";
+import { batch, filter, forEach, map, valve } from "@effectionx/stream-helpers";
 // any standard pipe function should work
 import { pipe } from "remeda";
 
@@ -202,10 +249,10 @@ function* example(source: Stream<number, unknown>) {
     batch({ maxSize: 50 }),
   );
 
-  for (const value of yield* each(stream)) {
+  // Use forEach to process each value in the composed stream
+  yield* forEach(function* (value) {
     console.log(value);
-    yield* each.next();
-  }
+  }, stream);
 }
 ```
 

package/esm/for-each.d.ts

@@ -0,0 +1,27 @@
+import type { Operation, Stream } from "effection";
+/**
+ * Invoke a function for each item passing through the stream.
+ *
+ * @template T - The type of items in the stream
+ * @template TClose - The type of the close value returned when the stream ends
+ * @param fn - A function that processes each item from the stream.
+ * @param stream: A stream to process
+ *
+ * @example
+ * ```typescript
+ * import { forEach } from "./for-each.ts";
+ * import { createSignal } from "effection";
+ *
+ * // Process items from a stream
+ * const stream = createSignal<number, void>();
+ *
+ * yield* spawn(() => forEach(function*(item) {
+ *   console.log(`Processing: ${item}`);
+ * }, stream));
+ *
+ * yield* stream.send(1);
+ * yield* stream.send(2);
+ * ```
+ */
+export declare function forEach<T, TClose>(fn: (item: T) => Operation<void>, stream: Stream<T, TClose>): Operation<TClose>;
+//# sourceMappingURL=for-each.d.ts.map

package/esm/for-each.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-each.d.ts","sourceRoot":"","sources":["../src/for-each.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAiB,OAAO,CAAC,CAAC,EAAE,MAAM,EAChC,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,EAChC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GACxB,SAAS,CAAC,MAAM,CAAC,CAQnB"}

package/esm/for-each.js

@@ -0,0 +1,33 @@
+/**
+ * Invoke a function for each item passing through the stream.
+ *
+ * @template T - The type of items in the stream
+ * @template TClose - The type of the close value returned when the stream ends
+ * @param fn - A function that processes each item from the stream.
+ * @param stream: A stream to process
+ *
+ * @example
+ * ```typescript
+ * import { forEach } from "./for-each.ts";
+ * import { createSignal } from "effection";
+ *
+ * // Process items from a stream
+ * const stream = createSignal<number, void>();
+ *
+ * yield* spawn(() => forEach(function*(item) {
+ *   console.log(`Processing: ${item}`);
+ * }, stream));
+ *
+ * yield* stream.send(1);
+ * yield* stream.send(2);
+ * ```
+ */
+export function* forEach(fn, stream) {
+    let subscription = yield* stream;
+    let next = yield* subscription.next();
+    while (!next.done) {
+        yield* fn(next.value);
+        next = yield* subscription.next();
+    }
+    return next.value;
+}

package/esm/mod.d.ts

@@ -3,4 +3,5 @@ export * from "./valve.js";
 export * from "./map.js";
 export * from "./filter.js";
 export * from "./tracker.js";
+export * from "./for-each.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}

package/esm/mod.js

@@ -3,3 +3,4 @@ export * from "./valve.js";
 export * from "./map.js";
 export * from "./filter.js";
 export * from "./tracker.js";
+export * from "./for-each.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectionx/stream-helpers",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "author": "engineering@frontside.com",
   "repository": {
     "type": "git",
@@ -22,9 +22,14 @@
       "require": "./script/test-helpers.js"
     }
   },
+  "scripts": {},
   "engines": {
     "node": ">= 16"
   },
   "sideEffects": false,
+  "dependencies": {
+    "@effectionx/signals": "0.3.0",
+    "effection": "^3"
+  },
   "_generatedBy": "dnt@dev"
 }

package/script/for-each.d.ts

@@ -0,0 +1,27 @@
+import type { Operation, Stream } from "effection";
+/**
+ * Invoke a function for each item passing through the stream.
+ *
+ * @template T - The type of items in the stream
+ * @template TClose - The type of the close value returned when the stream ends
+ * @param fn - A function that processes each item from the stream.
+ * @param stream: A stream to process
+ *
+ * @example
+ * ```typescript
+ * import { forEach } from "./for-each.ts";
+ * import { createSignal } from "effection";
+ *
+ * // Process items from a stream
+ * const stream = createSignal<number, void>();
+ *
+ * yield* spawn(() => forEach(function*(item) {
+ *   console.log(`Processing: ${item}`);
+ * }, stream));
+ *
+ * yield* stream.send(1);
+ * yield* stream.send(2);
+ * ```
+ */
+export declare function forEach<T, TClose>(fn: (item: T) => Operation<void>, stream: Stream<T, TClose>): Operation<TClose>;
+//# sourceMappingURL=for-each.d.ts.map

package/script/for-each.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-each.d.ts","sourceRoot":"","sources":["../src/for-each.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAiB,OAAO,CAAC,CAAC,EAAE,MAAM,EAChC,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,EAChC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GACxB,SAAS,CAAC,MAAM,CAAC,CAQnB"}

package/script/for-each.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forEach = forEach;
+/**
+ * Invoke a function for each item passing through the stream.
+ *
+ * @template T - The type of items in the stream
+ * @template TClose - The type of the close value returned when the stream ends
+ * @param fn - A function that processes each item from the stream.
+ * @param stream: A stream to process
+ *
+ * @example
+ * ```typescript
+ * import { forEach } from "./for-each.ts";
+ * import { createSignal } from "effection";
+ *
+ * // Process items from a stream
+ * const stream = createSignal<number, void>();
+ *
+ * yield* spawn(() => forEach(function*(item) {
+ *   console.log(`Processing: ${item}`);
+ * }, stream));
+ *
+ * yield* stream.send(1);
+ * yield* stream.send(2);
+ * ```
+ */
+function* forEach(fn, stream) {
+    let subscription = yield* stream;
+    let next = yield* subscription.next();
+    while (!next.done) {
+        yield* fn(next.value);
+        next = yield* subscription.next();
+    }
+    return next.value;
+}

package/script/mod.d.ts

@@ -3,4 +3,5 @@ export * from "./valve.js";
 export * from "./map.js";
 export * from "./filter.js";
 export * from "./tracker.js";
+export * from "./for-each.js";
 //# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}

package/script/mod.js

@@ -19,3 +19,4 @@ __exportStar(require("./valve.js"), exports);
 __exportStar(require("./map.js"), exports);
 __exportStar(require("./filter.js"), exports);
 __exportStar(require("./tracker.js"), exports);
+__exportStar(require("./for-each.js"), exports);