@thi.ng/csp 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-25T19:44:55Z
+- **Last updated**: 2024-04-26T13:32:20Z
 - **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.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csp@3.1.0) (2024-04-26)
+
+#### 🚀 Features
+
+- add opt. generics for PubSub.subscribe()/unsubscribe() ([b4e9d20](https://github.com/thi-ng/umbrella/commit/b4e9d20))
+- add into() to feed (async) iterables into a channel ([c7c1f6d](https://github.com/thi-ng/umbrella/commit/c7c1f6d))
+
 # [3.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csp@3.0.0) (2024-04-25)
 
 #### 🛑 Breaking changes

package/README.md

@@ -15,10 +15,12 @@
 > GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
 
 - [About](#about)
+  - [Channel operators](#channel-operators)
 - [Status](#status)
 - [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
   - [PubSub](#pubsub)
 - [Authors](#authors)
@@ -49,6 +51,23 @@ Provided are:
 - [`PubSub`](https://docs.thi.ng/umbrella/csp/classes/PubSub.html) for
   topic-based subscriptions, each topic implemented as `Mult`
 
+### Channel operators
+
+- [`broadcast()`](https://docs.thi.ng/umbrella/csp/functions/broadcast.html)
+- [`channel()`](https://docs.thi.ng/umbrella/csp/functions/channel.html)
+- [`concat()`](https://docs.thi.ng/umbrella/csp/functions/concat.html)
+- [`consume()`](https://docs.thi.ng/umbrella/csp/functions/consume.html)
+- [`consumeWith()`](https://docs.thi.ng/umbrella/csp/functions/consumeWith.html)
+- [`drain()`](https://docs.thi.ng/umbrella/csp/functions/drain.html)
+- [`fromAsyncIterable()`](https://docs.thi.ng/umbrella/csp/functions/fromAsyncIterable.html)
+- [`into()`](https://docs.thi.ng/umbrella/csp/functions/into.html)
+- [`merge()`](https://docs.thi.ng/umbrella/csp/functions/merge.html)
+- [`mult()`](https://docs.thi.ng/umbrella/csp/functions/mult.html)
+- [`pipe()`](https://docs.thi.ng/umbrella/csp/functions/pipe.html)
+- [`pubsub()`](https://docs.thi.ng/umbrella/csp/functions/pubsub.html)
+- [`select()`](https://docs.thi.ng/umbrella/csp/functions/select.html)
+- [`timeout()`](https://docs.thi.ng/umbrella/csp/functions/timeout.html)
+
 ## Status
 
 **BETA** - possibly breaking changes forthcoming
@@ -87,7 +106,7 @@ For Node.js REPL:
 const csp = await import("@thi.ng/csp");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.77 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.79 KB
 
 ## Dependencies
 
@@ -96,6 +115,16 @@ Package sizes (brotli'd, pre-treeshake): ESM: 1.77 KB
 - [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
 - [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 
+## Usage examples
+
+One project in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory is using this package:
+
+| Screenshot                                                                                                     | Description                                                                  | Live demo                                     | Source                                                                     |
+|:---------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------|:----------------------------------------------|:---------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/csp-bus.png" width="240"/> | CSP channel-based event handling, async transducers & reactive UI components | [Demo](https://demo.thi.ng/umbrella/csp-bus/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/csp-bus) |
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/csp/)
@@ -103,7 +132,7 @@ Package sizes (brotli'd, pre-treeshake): ESM: 1.77 KB
 ### PubSub
 
 ```ts tangle:export/readme-pubsub.ts
-import { channel, consumeWith, pubsub } from "@thi.ng/csp";
+import { channel, consumeWith, into, pubsub } from "@thi.ng/csp";
 
 // input channel (optional)
 const src = channel<string>({ id: "users" });
@@ -120,10 +149,9 @@ for (let i of "abc") {
     consumeWith(pub.subscribeTopic(i), (x, ch) => console.log(ch.id, x));
 }
 
-// start processing
-for (let x of ["alice", "bert", "bella", "charlie", "arthur"]) {
-    await src.write(x);
-}
+// start processing by feeding an iterable of names
+await into(src, ["alice", "bert", "bella", "charlie", "arthur"]);
+
 // users-a-tap0 alice
 // users-b-tap1 bert
 // users-b-tap1 bella

package/ops.d.ts

@@ -17,6 +17,7 @@ export declare const consumeWith: <T>(chan: Channel<T>, fn: Fn2<T, Channel<T>, v
 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>;
+export declare const into: <T, DEST extends IWriteable<T> & IClosable>(chan: DEST, src: Iterable<T> | AsyncIterable<T>, close?: boolean) => Promise<void>;
 export declare const pipe: <T, DEST extends IWriteable<T> & IClosable>(src: Channel<T>, dest: DEST, close?: boolean) => DEST;
 export declare const select: <T>(input: Channel<T>, ...xs: Channel<T>[]) => Promise<[Maybe<T>, Channel<T>]>;
 export declare const timeout: (delay: number) => Channel<any>;

package/ops.js

@@ -73,6 +73,14 @@ const merge = (src, dest, close = true) => {
   })();
   return dest;
 };
+const into = async (chan, src, close = false) => {
+  for await (let x of src) {
+    if (!chan.writable())
+      break;
+    await chan.write(x);
+  }
+  close && chan.close();
+};
 const pipe = (src, dest, close = true) => {
   (async () => {
     for await (let x of src) {
@@ -110,6 +118,7 @@ export {
   consumeWith,
   drain,
   fromAsyncIterable,
+  into,
   merge,
   pipe,
   select,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/csp",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "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": "aed3421c21044c005fbcb7cc37965ccf85a870d2\n"
+  "gitHead": "0bec55821066c18eb977a7eabd42c0bb2b096d98\n"
 }

package/pubsub.d.ts

@@ -7,7 +7,7 @@ export declare function pubsub<T>(src: Channel<T>, fn: TopicFn<T>): PubSub<T>;
 export declare class PubSub<T> implements IWriteable<T>, IClosable {
     protected src: Channel<T>;
     protected fn: TopicFn<T>;
-    protected topics: IObjectOf<Mult<T>>;
+    protected topics: IObjectOf<Mult<any>>;
     constructor(fn: TopicFn<T>);
     constructor(src: Channel<T>, fn: TopicFn<T>);
     writable(): boolean;
@@ -21,8 +21,8 @@ export declare class PubSub<T> implements IWriteable<T>, IClosable {
      *
      * @param id - topic id
      */
-    subscribeTopic(id: string): Channel<T>;
-    unsubscribeTopic(id: string, ch: Channel<T>): boolean;
+    subscribeTopic<S extends T = T>(id: string): Channel<S>;
+    unsubscribeTopic<S extends T = T>(id: string, ch: Channel<S>): boolean;
     unsubscribeAll(id: string, close?: boolean): void;
     protected process(): Promise<void>;
 }