@effectionx/stream-helpers 0.4.1 → 0.6.0

package/script/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/script/test-helpers/faucet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"faucet.d.ts","sourceRoot":"","sources":["../../src/test-helpers/faucet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AAGvE;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC;IACjD;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAClC;;;OAGG;IACH,IAAI,CACF,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,GAC1D,SAAS,CAAC,IAAI,CAAC,CAAC;IACnB;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IACb;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAiB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CA0B1E"}

package/script/test-helpers/faucet.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFaucet = useFaucet;
-const effection_1 = require("effection");
-const signals_1 = require("@effectionx/signals");
-/**
- * Creates a stream that can be used to test the behavior of streams that use backpressure.
- * It's useful in tests where it can be used as a source stream. This function is used to create
- * the stream.
- *
- * The returned stream has `pour` method that can be used to send items to the stream.
- * It can accept an array of items or a generator function that will be called with a function
- * to send items to the stream.
- *
- * ```typescript
- * import { useFaucet } from "@effectionx/stream-helpers/test-helpers";
- * import { run, each, spawn } from "effection";
- *
- * await run(function* () {
- *   const faucet = yield* useFaucet({ open: true });
- *
- *   // Remember to spawn the stream subscription before sending items to the stream
- *   yield* spawn(function* () {
- *     for (let i of yield* each(faucet)) {
- *       console.log(i);
- *       yield* each.next();
- *     }
- *   });
- *
- *   // Pass an array of items to send items to the stream one at a time synchronously
- *   yield* faucet.pour([1, 2, 3]);
- *
- *   // Pass an operation to control the rate at which items are sent to the stream
- *   yield* faucet.pour(function* (send) {
- *     yield* sleep(10);
- *     send(5);
- *     yield* sleep(30);
- *     send(6);
- *     yield* sleep(10);
- *     send(7);
- *   });
- * });
- *
- * ```
- * @param options - The options for the faucet.
- * @param options.open - Whether the faucet is open.
- * @returns stream of items coming from the faucet
- */
-function* useFaucet(options) {
-    let signal = (0, effection_1.createChannel)();
-    let open = yield* (0, signals_1.createBooleanSignal)(options.open);
-    return {
-        [Symbol.iterator]: signal[Symbol.iterator],
-        *pour(items) {
-            if (Array.isArray(items)) {
-                for (let i of items) {
-                    yield* (0, signals_1.is)(open, (open) => open);
-                    yield* signal.send(i);
-                }
-            }
-            else {
-                yield* items(function* (item) {
-                    yield* (0, signals_1.is)(open, (open) => open);
-                    yield* signal.send(item);
-                });
-            }
-        },
-        close() {
-            open.set(false);
-        },
-        open() {
-            open.set(true);
-        },
-    };
-}

package/script/test-helpers.d.ts

@@ -1,2 +0,0 @@
-export * from "./test-helpers/faucet.js";
-//# sourceMappingURL=test-helpers.d.ts.map

package/script/test-helpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/script/test-helpers.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./test-helpers/faucet.js"), exports);

package/script/tracker.d.ts

@@ -1,24 +0,0 @@
-import { type Operation, type Stream } from "effection";
-export interface Tracker extends Operation<void> {
-    /**
-     * Returns a stream helper that doesn't modify the items passing through the stream,
-     * but will capture a reference to the item. Call the `markOne` or `markMany` methods
-     * with the item to indicate that it has exited the stream.
-     */
-    passthrough(): <T>(stream: Stream<T, never>) => Stream<T, never>;
-    /**
-     * Call this method with an item that has passed through the stream to indicate that it has exited the stream.
-     */
-    markOne(item: unknown): void;
-    /**
-     * Call this method with an iterable of items that have passed through the stream to indicate that they have exited the stream.
-     */
-    markMany(items: Iterable<unknown>): void;
-}
-/**
- * Creates a tracker that can be used to verify that all items that entered the stream
- * eventually exit the stream. This is helpful when you want to ensure that all items
- * were processed before terminating the operation that created the stream.
- */
-export declare function createTracker(): Operation<Tracker>;
-//# sourceMappingURL=tracker.d.ts.map

package/script/tracker.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../src/tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAY,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AAGlE,MAAM,WAAW,OAAQ,SAAQ,SAAS,CAAC,IAAI,CAAC;IAC9C;;;;OAIG;IACH,WAAW,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACjE;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,SAAS,CAAC,OAAO,CAAC,CAiClD"}

package/script/tracker.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTracker = createTracker;
-const effection_1 = require("effection");
-const signals_1 = require("@effectionx/signals");
-/**
- * Creates a tracker that can be used to verify that all items that entered the stream
- * eventually exit the stream. This is helpful when you want to ensure that all items
- * were processed before terminating the operation that created the stream.
- */
-function createTracker() {
-    return (0, effection_1.resource)(function* (provide) {
-        const tracked = yield* (0, signals_1.createSetSignal)();
-        yield* provide({
-            *[Symbol.iterator]() {
-                yield* (0, signals_1.is)(tracked, (set) => set.size === 0);
-            },
-            passthrough() {
-                return function (stream) {
-                    return {
-                        *[Symbol.iterator]() {
-                            const subscription = yield* stream;
-                            return {
-                                *next() {
-                                    const next = yield* subscription.next();
-                                    tracked.add(next.value);
-                                    return next;
-                                },
-                            };
-                        },
-                    };
-                };
-            },
-            markOne(item) {
-                tracked.delete(item);
-            },
-            markMany(items) {
-                tracked.difference(items);
-            },
-        });
-    });
-}

package/script/valve.d.ts

@@ -1,37 +0,0 @@
-import { type Operation, type Stream } from "effection";
-/**
- * Options for the valve.
- */
-export interface ValveOptions {
-    /**
-     * The buffer size when {@link ValveOptions#open} method is called.
-     */
-    openAt: number;
-    /**
-     * The buffer size when {@link ValveOptions#close} method is called.
-     */
-    closeAt: number;
-    /**
-     * The operation to resume the upstream.
-     */
-    open(): Operation<void>;
-    /**
-     * The operation to pause the upstream.
-     */
-    close(): Operation<void>;
-}
-/**
- * This function buffers incoming items, if the upstream is producing faster than the downstream
- * can consume, the buffer will grow. If the buffer size exceeds the `closeAt` threshold, the
- * `close` operation will be called which is expected to pause the upstream. The buffer will
- * drain until the buffer size is less than the `openAt` threshold, at which point the `open`
- * operation will be called to resume the upstream.
- *
- * @param options.open - The operation to resume the upstream.
- * @param options.openAt - The buffer size at which the upstream will be resumed.
- * @param options.close - The operation to pause the upstream.
- * @param options.closeAt - The buffer size at which the upstream will be paused.
- * @returns A stream with backpressure applied.
- */
-export declare function valve(options: ValveOptions): <T>(stream: Stream<T, never>) => Stream<T, never>;
-//# sourceMappingURL=valve.d.ts.map

package/script/valve.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"valve.d.ts","sourceRoot":"","sources":["../src/valve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,SAAS,EAAS,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AAGrE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB;;OAEG;IACH,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CACnB,OAAO,EAAE,YAAY,GACpB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAkCnD"}

package/script/valve.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.valve = valve;
-const effection_1 = require("effection");
-const signals_1 = require("@effectionx/signals");
-/**
- * This function buffers incoming items, if the upstream is producing faster than the downstream
- * can consume, the buffer will grow. If the buffer size exceeds the `closeAt` threshold, the
- * `close` operation will be called which is expected to pause the upstream. The buffer will
- * drain until the buffer size is less than the `openAt` threshold, at which point the `open`
- * operation will be called to resume the upstream.
- *
- * @param options.open - The operation to resume the upstream.
- * @param options.openAt - The buffer size at which the upstream will be resumed.
- * @param options.close - The operation to pause the upstream.
- * @param options.closeAt - The buffer size at which the upstream will be paused.
- * @returns A stream with backpressure applied.
- */
-function valve(options) {
-    return function (stream) {
-        return {
-            *[Symbol.iterator]() {
-                const buffer = yield* (0, signals_1.createArraySignal)([]);
-                let open = true;
-                yield* (0, effection_1.spawn)(function* () {
-                    for (const item of yield* (0, effection_1.each)(stream)) {
-                        buffer.push(item);
-                        if (open && buffer.length >= options.closeAt) {
-                            yield* options.close();
-                            open = false;
-                        }
-                        yield* effection_1.each.next();
-                    }
-                });
-                return {
-                    *next() {
-                        if (!open && buffer.length <= options.openAt) {
-                            yield* options.open();
-                            open = true;
-                        }
-                        const value = yield* buffer.shift();
-                        return {
-                            done: false,
-                            value,
-                        };
-                    },
-                };
-            },
-        };
-    };
-}