@thi.ng/csp 3.2.12 → 3.2.13

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-10-05T12:12:32Z
+- **Last updated**: 2024-10-17T15:38:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [3.2.13](https://github.com/thi-ng/umbrella/tree/@thi.ng/csp@3.2.13) (2024-10-17)
+
+#### ♻️ Refactoring
+
+- undeprecate `into()`, refactor `pipe()` ([c8788d9](https://github.com/thi-ng/umbrella/commit/c8788d9))
+  - update docstrings
+
 ### [3.2.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/csp@3.2.2) (2024-06-21)
 
 #### ♻️ Refactoring

package/README.md

@@ -158,7 +158,7 @@ For Node.js REPL:
 const csp = await import("@thi.ng/csp");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.80 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.78 KB
 
 ## Dependencies
 

package/ops.d.ts

@@ -42,15 +42,23 @@ export declare const drain: <T>(chan: Channel<T>) => Promise<Awaited<T>[]>;
  */
 export declare const fromAsyncIterable: <T>(src: AsyncIterable<T>, close?: boolean) => Channel<T>;
 export declare const merge: <T>(src: Channel<T>[], dest?: Channel<T>, close?: boolean) => Channel<T>;
-/**
- * @deprecated use {@link pipe} instead.
- */
-export declare const into: <T, DEST extends IWriteable<T> & IClosable>(chan: DEST, src: Iterable<T> | AsyncIterable<T>, close?: boolean) => Promise<void>;
 /**
  * Receives values from `src` and writes them to `dest` for as long as it's
  * accepting new writes (i.e. isn't closed from elsewhere). If `close` is true
  * (default), the `dest` channel will be automatically closed once the `src` is
- * exhausted. Returns `dest` channel.
+ * exhausted. Returns a void-promise which resolves once done.
+ *
+ * @param dest
+ * @param src
+ * @param close
+ */
+export declare const into: <T, DEST extends IWriteable<T> & IClosable>(dest: DEST, src: Iterable<T> | AsyncIterable<T>, close?: boolean) => Promise<void>;
+/**
+ * Similar to {@link into} (and also calls that function asynchronously), but
+ * `pipe()` itself is synchronous and returns `dest` channel immediatedly.
+ *
+ * @remarks
+ * Also note different argument order!
  *
  * @param src
  * @param dest

package/ops.js

@@ -58,21 +58,15 @@ const merge = (src, dest, close = true) => {
   })();
   return dest;
 };
-const into = async (chan, src, close = false) => {
+const into = async (dest, src, close = false) => {
   for await (let x of src) {
-    if (!chan.writable()) break;
-    await chan.write(x);
+    if (!dest.writable()) break;
+    await dest.write(x);
   }
-  close && chan.close();
+  close && dest.close();
 };
 const pipe = (src, dest, close = true) => {
-  (async () => {
-    for await (let x of src) {
-      await dest.write(x);
-      if (!dest.writable()) break;
-    }
-    close && dest.close();
-  })();
+  into(dest, src, close);
   return dest;
 };
 const select = async (input, ...rest) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/csp",
-  "version": "3.2.12",
+  "version": "3.2.13",
   "description": "Primitives & operators for Communicating Sequential Processes based on async/await and async iterables",
   "type": "module",
   "module": "./index.js",
@@ -106,5 +106,5 @@
     "status": "beta",
     "year": 2016
   },
-  "gitHead": "11ae480076e61a2263f5730ffb37dfddbf01c7d1\n"
+  "gitHead": "8301254c4436505a1fb0e3cc28eca3adb920c3e0\n"
 }