@thi.ng/rstream 7.1.1 → 7.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-19T07:59:50Z
+- **Last updated**: 2021-11-21T17:09:28Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.
 
+## [7.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream@7.2.0) (2021-11-21)
+
+#### 🚀 Features
+
+- update defWorker() arg types ([e07521e](https://github.com/thi-ng/umbrella/commit/e07521e))
+  - add `WorkerSource` type alias
+  - add support for zero-arg fns returning a worker instance
+    - helps v. much with Vite's `xxx?worker` imports
+    - see /examples/mandelbrot for usage
+
 ### [7.1.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream@7.1.1) (2021-11-19)
 
 #### 🩹 Bug fixes

package/api.d.ts

@@ -183,4 +183,5 @@ export interface IStream<T> extends ISubscriber<T> {
 }
 export declare type StreamCancel = () => void;
 export declare type StreamSource<T> = (sub: Stream<T>) => StreamCancel | void;
+export declare type WorkerSource = Worker | Blob | Fn0<Worker> | string;
 //# sourceMappingURL=api.d.ts.map

package/defworker.d.ts

@@ -1,3 +1,4 @@
+import type { WorkerSource } from "./api.js";
 export declare const defInlineWorker: (src: string) => Worker;
-export declare const defWorker: (worker: Worker | string | Blob) => Worker;
+export declare const defWorker: (worker: WorkerSource) => Worker;
 //# sourceMappingURL=defworker.d.ts.map

package/defworker.js

@@ -1,4 +1,7 @@
+import { isFunction } from "@thi.ng/checks/is-function";
 export const defInlineWorker = (src) => defWorker(new Blob([src], { type: "text/javascript" }));
 export const defWorker = (worker) => worker instanceof Worker
     ? worker
-    : new Worker(worker instanceof Blob ? URL.createObjectURL(worker) : worker);
+    : isFunction(worker)
+        ? worker()
+        : new Worker(worker instanceof Blob ? URL.createObjectURL(worker) : worker);

package/forkjoin.d.ts

@@ -1,5 +1,5 @@
 import type { ArrayLikeIterable, Fn, Fn3 } from "@thi.ng/api";
-import type { CommonOpts, ITransformable } from "./api.js";
+import type { CommonOpts, ITransformable, WorkerSource } from "./api.js";
 import type { Subscription } from "./subscription.js";
 export interface ForkJoinOpts<IN, MSG, RES, OUT> extends Partial<CommonOpts> {
     /**
@@ -38,7 +38,7 @@ export interface ForkJoinOpts<IN, MSG, RES, OUT> extends Partial<CommonOpts> {
      * string. In the latter two cases, a worker is created
      * automatically using `makeWorker()`.
      */
-    worker: string | Worker | Blob;
+    worker: WorkerSource;
     /**
      * Optional max number of workers to use. Defaults to
      * `navigator.hardwareConcurrency` (or if unavailable, then 4 as

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "description": "Reactive streams & subscription primitives for constructing dataflow graphs / pipelines",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.1",
-    "@thi.ng/arrays": "^2.1.1",
-    "@thi.ng/associative": "^6.1.1",
-    "@thi.ng/atom": "^5.1.1",
-    "@thi.ng/checks": "^3.1.1",
-    "@thi.ng/errors": "^2.1.1",
-    "@thi.ng/logger": "^1.1.1",
-    "@thi.ng/transducers": "^8.1.1"
+    "@thi.ng/api": "^8.3.2",
+    "@thi.ng/arrays": "^2.1.2",
+    "@thi.ng/associative": "^6.1.2",
+    "@thi.ng/atom": "^5.1.2",
+    "@thi.ng/checks": "^3.1.2",
+    "@thi.ng/errors": "^2.1.2",
+    "@thi.ng/logger": "^1.1.2",
+    "@thi.ng/transducers": "^8.1.2"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.1",
+    "@thi.ng/testament": "^0.2.2",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.22.9",
@@ -201,5 +201,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "8bd27c8bde0b770e7c001943f11c951cd345d668\n"
+  "gitHead": "e8a7c2a40191b391cef182c2978e5a6c85987a87\n"
 }

package/promises.d.ts

@@ -1,12 +1,15 @@
 import type { ISubscription, WithErrorHandlerOpts } from "./api.js";
 /**
- * Wraps given iterable in `Promise.all()` to yield {@link Stream} of
- * results in same order as arguments, then closes.
+ * Wraps given iterable in `Promise.all()` to yield {@link Stream} of results in
+ * same order as arguments, then closes.
  *
  * @remarks
- * If any of the promises rejects, all others will do so too. In this
- * case the stream calls {@link ISubscriber.error} in all of its
- * subscribers.
+ * If any of the promises rejects, all others will do so too. In this case the
+ * stream calls {@link ISubscriber.error} in all of its subscribers.
+ *
+ * @remarks
+ * Type signature updated to use `Awaited<T>`, a new core type introduced in
+ * TypeScript 4.5.
  *
  * @example
  * ```ts

package/promises.js

@@ -2,13 +2,16 @@ import { mapcat } from "@thi.ng/transducers/mapcat";
 import { __optsWithID } from "./idgen.js";
 import { fromPromise } from "./promise.js";
 /**
- * Wraps given iterable in `Promise.all()` to yield {@link Stream} of
- * results in same order as arguments, then closes.
+ * Wraps given iterable in `Promise.all()` to yield {@link Stream} of results in
+ * same order as arguments, then closes.
  *
  * @remarks
- * If any of the promises rejects, all others will do so too. In this
- * case the stream calls {@link ISubscriber.error} in all of its
- * subscribers.
+ * If any of the promises rejects, all others will do so too. In this case the
+ * stream calls {@link ISubscriber.error} in all of its subscribers.
+ *
+ * @remarks
+ * Type signature updated to use `Awaited<T>`, a new core type introduced in
+ * TypeScript 4.5.
  *
  * @example
  * ```ts

package/tunnel.d.ts

@@ -1,11 +1,11 @@
-import type { Fn } from "@thi.ng/api";
+import type { Fn, Fn0 } from "@thi.ng/api";
 import { Subscription } from "./subscription.js";
 export interface TunnelOpts<A> {
     /**
      * Tunnelled worker instance, source blob or script URL.
      * If `interrupt` is enabled, the worker MUST be given as blob or URL.
      */
-    src: Worker | Blob | string;
+    src: Worker | Blob | string | Fn0<Worker>;
     /**
      * Max. number of worker instances to use. Only useful if
      * `interrupt` is disabled. If more than one worker is used,
@@ -62,7 +62,7 @@ export declare const tunnel: <A, B>(opts: TunnelOpts<A>) => Tunnel<A, B>;
  */
 export declare class Tunnel<A, B> extends Subscription<A, B> {
     workers: Worker[];
-    src: Worker | Blob | string;
+    src: Worker | Blob | string | Fn0<Worker>;
     transferables?: Fn<A, any[]>;
     terminate: number;
     interrupt: boolean;

package/worker.d.ts

@@ -1,4 +1,4 @@
-import type { WithErrorHandlerOpts } from "./api.js";
+import type { WithErrorHandlerOpts, WorkerSource } from "./api.js";
 export interface FromWorkerOpts extends WithErrorHandlerOpts {
     /**
      * If true, the worker will be terminated when the stream
@@ -31,5 +31,5 @@ export interface FromWorkerOpts extends WithErrorHandlerOpts {
  * @param worker -
  * @param opts -
  */
-export declare const fromWorker: <T>(worker: Worker | Blob | string, opts?: Partial<FromWorkerOpts> | undefined) => import("./stream.js").Stream<T>;
+export declare const fromWorker: <T>(worker: WorkerSource, opts?: Partial<FromWorkerOpts> | undefined) => import("./stream.js").Stream<T>;
 //# sourceMappingURL=worker.d.ts.map