gingersnap 0.23.9 → 0.23.11

package/data-structures/object/BufferQueue.cjs

@@ -58,6 +58,31 @@ class BufferQueue extends WatchableObject.WatchableObject {
             });
         }));
     }
+    flushableStream(ignoreCache = false) {
+        let pointer = ignoreCache ? this.tail : 0;
+        return new stream.Stream(((signal) => {
+            const value = this.get(pointer);
+            if (value !== undefined) {
+                pointer++;
+                return {
+                    value,
+                    done: () => {
+                        this.delete(pointer);
+                    },
+                };
+            }
+            return new Promise((resolve) => {
+                const unsubscribe = this.on(pointer, (v) => {
+                    pointer++;
+                    resolve(v);
+                }, false);
+                signal.onabort = () => {
+                    unsubscribe();
+                    resolve(new stream_state.ExecutorState(true));
+                };
+            });
+        }));
+    }
     clone() {
         const obj = super.clone();
         obj.head = this.head;

package/data-structures/object/BufferQueue.d.ts

@@ -11,6 +11,10 @@ export declare class BufferQueue<T> extends WatchableObject<number, T> {
     constructor(objectMaxSize?: number, expiryPeriod?: WaitPeriod);
     ingest(stream: Stream<T>): Future<void>;
     streamEntries(ignoreCache?: boolean): Stream<T>;
+    flushableStream(ignoreCache?: boolean): Stream<{
+        value: T;
+        done: () => void;
+    }>;
     clone(): BufferQueue<T>;
     enqueue(value: T, tracker?: string | number): void;
     clear(): void;

package/data-structures/object/BufferQueue.mjs

@@ -37,6 +37,31 @@ class BufferQueue extends WatchableObject {
             });
         }));
     }
+    flushableStream(ignoreCache = false) {
+        let pointer = ignoreCache ? this.tail : 0;
+        return new Stream(((signal) => {
+            const value = this.get(pointer);
+            if (value !== undefined) {
+                pointer++;
+                return {
+                    value,
+                    done: () => {
+                        this.delete(pointer);
+                    },
+                };
+            }
+            return new Promise((resolve) => {
+                const unsubscribe = this.on(pointer, (v) => {
+                    pointer++;
+                    resolve(v);
+                }, false);
+                signal.onabort = () => {
+                    unsubscribe();
+                    resolve(new ExecutorState(true));
+                };
+            });
+        }));
+    }
     clone() {
         const obj = super.clone();
         obj.head = this.head;

package/data-structures/object/Queue.cjs

@@ -7,6 +7,7 @@ var future = require('../../future/future.cjs');
 require('ramda');
 var synchronize = require('../../synchronize.cjs');
 var stream = require('../../stream.cjs');
+var stream_state = require('../../stream/state.cjs');
 var QueueFullError = require('../../errors/QueueFullError.cjs');
 var ValueDestroyedError = require('../../errors/ValueDestroyedError.cjs');
 var Publisher = require('./Publisher.cjs');
@@ -26,6 +27,41 @@ class Queue extends WatchableObject.WatchableObject {
     get streamEntries() {
         return stream.Stream.of(this.asyncIterator);
     }
+    /**
+     * A stream where data is only removed from the queue once the terminal action of the stream is finished with the data.
+     * Useful for cases where the stream is canceled in the middle and that data must not be removed from the queue as
+     * operations on it were not finished.
+     *
+     * Important Note: transactions means the data is not removed until finalized, therefore if more than one transactionalStream
+     * is open, each stream may see the same data from the queue if one stream is faster than another
+     */
+    get transactionStream() {
+        let collected = [];
+        return new stream.Stream((signal) => {
+            if (this.closed) {
+                return new stream_state.ExecutorState(true);
+            }
+            const forwardHead = collected || collected[collected.length - 1] > this.head ? this.head + collected.length : this.head;
+            collected.push(forwardHead);
+            if (forwardHead > this.tail) {
+                return this.await(forwardHead, signal);
+            }
+            return this.get(forwardHead);
+        }).onFinalAction(() => {
+            try {
+                const lastHead = collected[collected.length - 1];
+                while (this.head <= lastHead) {
+                    this.internalDequeue(true);
+                }
+            }
+            catch (e) {
+                // possible cause is another transaction is running
+            }
+            finally {
+                collected = [];
+            }
+        });
+    }
     createPublisher(transformer) {
         return new Publisher.Publisher(this, transformer);
     }
@@ -68,17 +104,7 @@ class Queue extends WatchableObject.WatchableObject {
         }));
     }
     dequeue() {
-        if (this.closed) {
-            throw new ValueDestroyedError.ValueDestroyedError();
-        }
-        const value = this.get(this.head);
-        if (value !== undefined && value !== null) {
-            this.delete(this.head);
-            this.head++;
-            this.dequeueEvt.set();
-            return value;
-        }
-        throw new QueueEmptyError.QueueEmptyError();
+        return this.internalDequeue();
     }
     awaitDequeue(abortSignal) {
         if (this.empty && !this.closed) {
@@ -182,6 +208,19 @@ class Queue extends WatchableObject.WatchableObject {
     throw(e) {
         throw e;
     }
+    internalDequeue(soft = false) {
+        if (this.closed && !soft) {
+            throw new ValueDestroyedError.ValueDestroyedError();
+        }
+        const value = this.get(this.head);
+        if (value !== undefined && value !== null) {
+            this.delete(this.head);
+            this.head++;
+            this.dequeueEvt.set();
+            return value;
+        }
+        throw new QueueEmptyError.QueueEmptyError();
+    }
 }
 
 exports.Queue = Queue;

package/data-structures/object/Queue.d.ts

@@ -13,6 +13,15 @@ export declare class Queue<T> extends WatchableObject<number, T> implements Iter
     private readonly dequeueEvt;
     constructor(objectMaxSize?: number, expiryPeriod?: WaitPeriod);
     get streamEntries(): Stream<T>;
+    /**
+     * A stream where data is only removed from the queue once the terminal action of the stream is finished with the data.
+     * Useful for cases where the stream is canceled in the middle and that data must not be removed from the queue as
+     * operations on it were not finished.
+     *
+     * Important Note: transactions means the data is not removed until finalized, therefore if more than one transactionalStream
+     * is open, each stream may see the same data from the queue if one stream is faster than another
+     */
+    get transactionStream(): Stream<T>;
     createPublisher<K>(transformer: (v: K) => T): Publisher<T, K>;
     close(): void;
     clone(): Queue<T>;
@@ -31,4 +40,5 @@ export declare class Queue<T> extends WatchableObject<number, T> implements Iter
     next(...args: [] | [undefined]): IteratorResult<T, any>;
     return?(value?: any): IteratorResult<T, any>;
     throw?(e?: any): IteratorResult<T, any>;
+    private internalDequeue;
 }

package/data-structures/object/Queue.mjs

@@ -5,6 +5,7 @@ import { Future } from '../../future/future.mjs';
 import 'ramda';
 import { FutureEvent } from '../../synchronize.mjs';
 import { Stream } from '../../stream.mjs';
+import { ExecutorState } from '../../stream/state.mjs';
 import { QueueFullError } from '../../errors/QueueFullError.mjs';
 import { ValueDestroyedError } from '../../errors/ValueDestroyedError.mjs';
 import { Publisher } from './Publisher.mjs';
@@ -24,6 +25,41 @@ class Queue extends WatchableObject {
     get streamEntries() {
         return Stream.of(this.asyncIterator);
     }
+    /**
+     * A stream where data is only removed from the queue once the terminal action of the stream is finished with the data.
+     * Useful for cases where the stream is canceled in the middle and that data must not be removed from the queue as
+     * operations on it were not finished.
+     *
+     * Important Note: transactions means the data is not removed until finalized, therefore if more than one transactionalStream
+     * is open, each stream may see the same data from the queue if one stream is faster than another
+     */
+    get transactionStream() {
+        let collected = [];
+        return new Stream((signal) => {
+            if (this.closed) {
+                return new ExecutorState(true);
+            }
+            const forwardHead = collected || collected[collected.length - 1] > this.head ? this.head + collected.length : this.head;
+            collected.push(forwardHead);
+            if (forwardHead > this.tail) {
+                return this.await(forwardHead, signal);
+            }
+            return this.get(forwardHead);
+        }).onFinalAction(() => {
+            try {
+                const lastHead = collected[collected.length - 1];
+                while (this.head <= lastHead) {
+                    this.internalDequeue(true);
+                }
+            }
+            catch (e) {
+                // possible cause is another transaction is running
+            }
+            finally {
+                collected = [];
+            }
+        });
+    }
     createPublisher(transformer) {
         return new Publisher(this, transformer);
     }
@@ -66,17 +102,7 @@ class Queue extends WatchableObject {
         }));
     }
     dequeue() {
-        if (this.closed) {
-            throw new ValueDestroyedError();
-        }
-        const value = this.get(this.head);
-        if (value !== undefined && value !== null) {
-            this.delete(this.head);
-            this.head++;
-            this.dequeueEvt.set();
-            return value;
-        }
-        throw new QueueEmptyError();
+        return this.internalDequeue();
     }
     awaitDequeue(abortSignal) {
         if (this.empty && !this.closed) {
@@ -180,6 +206,19 @@ class Queue extends WatchableObject {
     throw(e) {
         throw e;
     }
+    internalDequeue(soft = false) {
+        if (this.closed && !soft) {
+            throw new ValueDestroyedError();
+        }
+        const value = this.get(this.head);
+        if (value !== undefined && value !== null) {
+            this.delete(this.head);
+            this.head++;
+            this.dequeueEvt.set();
+            return value;
+        }
+        throw new QueueEmptyError();
+    }
 }
 
 export { Queue };

package/package.json

@@ -1 +1 @@
-{"name":"gingersnap","version":"0.23.9","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/AtomicValue":{"import":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.mjs"},"require":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.cjs"}},"./data/store":{"import":{"types":"./data/store/index.d.ts","default":"./data/store.mjs"},"require":{"types":"./data/store/index.d.ts","default":"./data/store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}
+{"name":"gingersnap","version":"0.23.11","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/AtomicValue":{"import":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.mjs"},"require":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.cjs"}},"./data/store":{"import":{"types":"./data/store/index.d.ts","default":"./data/store.mjs"},"require":{"types":"./data/store/index.d.ts","default":"./data/store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}

package/stream/index.d.ts

@@ -32,6 +32,7 @@ export declare class Stream<T> implements AsyncGenerator<T> {
     }>;
     protected cancelHooks: Set<() => any>;
     protected completionHooks: Set<() => any>;
+    protected finalActionHooks: Set<() => any>;
     protected completionHookInvoked: boolean;
     protected monitorHooks: Set<(v: T) => void>;
     private frozen;
@@ -143,6 +144,7 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      * @param callback
      */
     filter(callback: (v: T) => boolean | Promise<boolean> | Future<boolean>): Stream<T>;
+    filterNotNull(): Stream<NonNullable<T>>;
     reduce<K, V>(initialData: K, functor: (v: T, prev: K | V) => V, exhaustive?: boolean): Stream<V>;
     reduceWhile<K, V>(predicate: (v: T) => boolean, initialData: K, functor: (v: T, prev: K | V) => V, exhaustive?: boolean): Stream<V>;
     /**
@@ -180,7 +182,17 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      * @param hook
      */
     onCompletion(hook: () => any): this;
+    /**
+     * Register hook that is called at the terminal end of a stream after each value is being consumed
+     * E.g. stream.onFinalAction(() => console.log('called after every foreach')).forEach(v => ....)
+     *
+     * Terminal Actions are those that consume the stream, and would be the final action that can be performed on the stream,
+     * usually returning a future
+     * @param hook
+     */
+    onFinalAction(hook: () => any): this;
     removeCompletionHook(hook: () => any): this;
+    removeFinalActionHook(hook: () => any): this;
     /**
      * Cancels the stream
      * @param reason
@@ -258,7 +270,7 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      */
     catch<K>(callback: (v: Error) => K | null | undefined): Stream<InferErrorResult<K, T> | T>;
     /**
-     * Consumes the entire stream and store the data in an array. Future is immediately executed
+     * Consumes the entire stream and store the data in a collection. Future is immediately executed
      */
     collect<K>(collector: Collector<K, T>): Future<K>;
     /**
@@ -271,7 +283,7 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      * Iterates over the stream of values, used as a collector. Future is immediately executed
      * @param callback
      */
-    forEach(callback: (v: T) => void | Future<void>): Future<void>;
+    forEach(callback: (v: T) => void | Future<void> | Promise<void>): Future<void>;
     forEachLatest(callback: (v: T) => void | Future<void>): Future<void>;
     /**
      * Runs the stream only once. After this call, the stream is closed. Future is immediately executed

package/stream.cjs

@@ -65,6 +65,7 @@ class Stream {
         this.backlog = [];
         this.cancelHooks = new Set();
         this.completionHooks = new Set();
+        this.finalActionHooks = new Set();
         this.completionHookInvoked = false;
         this.runLock = new synchronize.Lock();
         this.concurrencyLimit = 0;
@@ -225,6 +226,7 @@ class Stream {
                     }
                     else {
                         resolve(v.value);
+                        this.finalActionHooks.forEach((hook) => hook());
                     }
                 })
                     .catch(reject);
@@ -358,6 +360,7 @@ class Stream {
         newStream.done = this.done;
         newStream.cancelHooks = new Set(this.cancelHooks);
         newStream.completionHooks = new Set(this.completionHooks);
+        newStream.finalActionHooks = new Set(this.finalActionHooks);
         newStream.completionHookInvoked = this.completionHookInvoked;
         return newStream;
     }
@@ -393,6 +396,9 @@ class Stream {
         });
         return this;
     }
+    filterNotNull() {
+        return this.filter((it) => it !== null || it !== undefined);
+    }
     reduce(initialData, functor, exhaustive = true) {
         if (!this.canAlterStream)
             throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
@@ -553,6 +559,7 @@ class Stream {
         newStream.backlog = [...this.backlog];
         newStream.cancelHooks = new Set(this.cancelHooks);
         newStream.completionHooks = new Set(this.completionHooks);
+        newStream.finalActionHooks = new Set(this.finalActionHooks);
         newStream.completionHookInvoked = this.completionHookInvoked;
         if (withSignals) {
             newStream.controller = this.controller;
@@ -579,10 +586,26 @@ class Stream {
         this.completionHooks.add(hook);
         return this;
     }
+    /**
+     * Register hook that is called at the terminal end of a stream after each value is being consumed
+     * E.g. stream.onFinalAction(() => console.log('called after every foreach')).forEach(v => ....)
+     *
+     * Terminal Actions are those that consume the stream, and would be the final action that can be performed on the stream,
+     * usually returning a future
+     * @param hook
+     */
+    onFinalAction(hook) {
+        this.finalActionHooks.add(hook);
+        return this;
+    }
     removeCompletionHook(hook) {
         this.completionHooks.delete(hook);
         return this;
     }
+    removeFinalActionHook(hook) {
+        this.finalActionHooks.delete(hook);
+        return this;
+    }
     /**
      * Cancels the stream
      * @param reason
@@ -861,10 +884,18 @@ class Stream {
         return this;
     }
     /**
-     * Consumes the entire stream and store the data in an array. Future is immediately executed
+     * Consumes the entire stream and store the data in a collection. Future is immediately executed
      */
     collect(collector) {
-        return collector(this.isParallel ? this.join() : this).schedule();
+        return collector(this.isParallel
+            ? this.join().map((v) => {
+                this.finalActionHooks.forEach((hook) => hook());
+                return v;
+            })
+            : this.map((v) => {
+                this.finalActionHooks.forEach((hook) => hook());
+                return v;
+            })).schedule();
     }
     /**
      * Continuously exhaust the stream until the stream ends or the limit is reached. No result will be provided at
@@ -887,6 +918,7 @@ class Stream {
                             _h = false;
                             try {
                                 const _ = _c;
+                                this.finalActionHooks.forEach((hook) => hook());
                                 if (++index >= limit)
                                     break;
                             }
@@ -911,6 +943,7 @@ class Stream {
                             _l = false;
                             try {
                                 const _ = _f;
+                                this.finalActionHooks.forEach((hook) => hook());
                             }
                             finally {
                                 _l = true;
@@ -937,16 +970,38 @@ class Stream {
      * @param callback
      */
     forEach(callback) {
-        return new future.Future((resolve, reject, signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a;
+        return new future.Future((resolve, reject) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a, e_4, _b, _c;
+            var _d;
             try {
-                yield this.map((value) => callback(value))
-                    .consume()
-                    .registerSignal(signal);
+                try {
+                    for (var _e = true, _f = _tslib.__asyncValues(this), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                        _c = _g.value;
+                        _e = false;
+                        try {
+                            const value = _c;
+                            const result = callback(value);
+                            if (result instanceof future.Future || result instanceof Promise) {
+                                yield result;
+                            }
+                            this.finalActionHooks.forEach((hook) => hook());
+                        }
+                        finally {
+                            _e = true;
+                        }
+                    }
+                }
+                catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                finally {
+                    try {
+                        if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                    }
+                    finally { if (e_4) throw e_4.error; }
+                }
                 resolve();
             }
             catch (error) {
-                reject(error instanceof FutureError.FutureError ? error : new FutureError.FutureError((_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : "Unknown"));
+                reject(error instanceof FutureError.FutureError ? error : new FutureError.FutureError((_d = error === null || error === void 0 ? void 0 : error.message) !== null && _d !== void 0 ? _d : "Unknown"));
             }
         })).schedule();
     }
@@ -957,6 +1012,7 @@ class Stream {
                 let pending = null;
                 while (!signal.aborted) {
                     const value = yield this.internalNext().registerSignal(signal);
+                    this.finalActionHooks.forEach((hook) => hook());
                     if (!value.done) {
                         pending === null || pending === void 0 ? void 0 : pending.cancel();
                         const result = callback(value.value);
@@ -990,6 +1046,7 @@ class Stream {
                 if (value !== null && value !== undefined) {
                     this.monitorHooks.forEach((hook) => hook(value));
                 }
+                this.finalActionHooks.forEach((hook) => hook());
                 if (state !== exports.State.CONTINUE) {
                     this.done = true;
                     this.invokeCompletionHooks();
@@ -1097,6 +1154,7 @@ class Stream {
                             const preResult = yield this.yieldTrueResult(preProcessor(data), signal);
                             const result = yield this.yieldTrueResult(functor(preResult instanceof Promise ? yield preResult : preResult), signal);
                             if (result === null || result === undefined) {
+                                this.finalActionHooks.forEach((hook) => hook());
                                 return resolve({ state: exports.State.CONTINUE });
                             }
                             data = result;
@@ -1309,7 +1367,7 @@ class Stream {
     }
     forwardExecute(preProcessor = R__namespace.identity) {
         return future.Future.of((resolve, reject, signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a, e_4, _b, _c;
+            var _a, e_5, _b, _c;
             let pending = [];
             try {
                 for (var _d = true, _e = _tslib.__asyncValues(this.sourceStream.internalIterator()), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
@@ -1333,12 +1391,12 @@ class Stream {
                     }
                 }
             }
-            catch (e_4_1) { e_4 = { error: e_4_1 }; }
+            catch (e_5_1) { e_5 = { error: e_5_1 }; }
             finally {
                 try {
                     if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
                 }
-                finally { if (e_4) throw e_4.error; }
+                finally { if (e_5) throw e_5.error; }
             }
             const { state, value } = yield this.collectResult(pending, signal);
             if (state === exports.State.CONTINUE) {

package/stream.mjs

@@ -44,6 +44,7 @@ class Stream {
         this.backlog = [];
         this.cancelHooks = new Set();
         this.completionHooks = new Set();
+        this.finalActionHooks = new Set();
         this.completionHookInvoked = false;
         this.runLock = new Lock();
         this.concurrencyLimit = 0;
@@ -204,6 +205,7 @@ class Stream {
                     }
                     else {
                         resolve(v.value);
+                        this.finalActionHooks.forEach((hook) => hook());
                     }
                 })
                     .catch(reject);
@@ -337,6 +339,7 @@ class Stream {
         newStream.done = this.done;
         newStream.cancelHooks = new Set(this.cancelHooks);
         newStream.completionHooks = new Set(this.completionHooks);
+        newStream.finalActionHooks = new Set(this.finalActionHooks);
         newStream.completionHookInvoked = this.completionHookInvoked;
         return newStream;
     }
@@ -372,6 +375,9 @@ class Stream {
         });
         return this;
     }
+    filterNotNull() {
+        return this.filter((it) => it !== null || it !== undefined);
+    }
     reduce(initialData, functor, exhaustive = true) {
         if (!this.canAlterStream)
             throw new IllegalOperationError("Cannot alter the stream as it is frozen");
@@ -532,6 +538,7 @@ class Stream {
         newStream.backlog = [...this.backlog];
         newStream.cancelHooks = new Set(this.cancelHooks);
         newStream.completionHooks = new Set(this.completionHooks);
+        newStream.finalActionHooks = new Set(this.finalActionHooks);
         newStream.completionHookInvoked = this.completionHookInvoked;
         if (withSignals) {
             newStream.controller = this.controller;
@@ -558,10 +565,26 @@ class Stream {
         this.completionHooks.add(hook);
         return this;
     }
+    /**
+     * Register hook that is called at the terminal end of a stream after each value is being consumed
+     * E.g. stream.onFinalAction(() => console.log('called after every foreach')).forEach(v => ....)
+     *
+     * Terminal Actions are those that consume the stream, and would be the final action that can be performed on the stream,
+     * usually returning a future
+     * @param hook
+     */
+    onFinalAction(hook) {
+        this.finalActionHooks.add(hook);
+        return this;
+    }
     removeCompletionHook(hook) {
         this.completionHooks.delete(hook);
         return this;
     }
+    removeFinalActionHook(hook) {
+        this.finalActionHooks.delete(hook);
+        return this;
+    }
     /**
      * Cancels the stream
      * @param reason
@@ -840,10 +863,18 @@ class Stream {
         return this;
     }
     /**
-     * Consumes the entire stream and store the data in an array. Future is immediately executed
+     * Consumes the entire stream and store the data in a collection. Future is immediately executed
      */
     collect(collector) {
-        return collector(this.isParallel ? this.join() : this).schedule();
+        return collector(this.isParallel
+            ? this.join().map((v) => {
+                this.finalActionHooks.forEach((hook) => hook());
+                return v;
+            })
+            : this.map((v) => {
+                this.finalActionHooks.forEach((hook) => hook());
+                return v;
+            })).schedule();
     }
     /**
      * Continuously exhaust the stream until the stream ends or the limit is reached. No result will be provided at
@@ -866,6 +897,7 @@ class Stream {
                             _h = false;
                             try {
                                 const _ = _c;
+                                this.finalActionHooks.forEach((hook) => hook());
                                 if (++index >= limit)
                                     break;
                             }
@@ -890,6 +922,7 @@ class Stream {
                             _l = false;
                             try {
                                 const _ = _f;
+                                this.finalActionHooks.forEach((hook) => hook());
                             }
                             finally {
                                 _l = true;
@@ -916,16 +949,38 @@ class Stream {
      * @param callback
      */
     forEach(callback) {
-        return new Future((resolve, reject, signal) => __awaiter(this, void 0, void 0, function* () {
-            var _a;
+        return new Future((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+            var _a, e_4, _b, _c;
+            var _d;
             try {
-                yield this.map((value) => callback(value))
-                    .consume()
-                    .registerSignal(signal);
+                try {
+                    for (var _e = true, _f = __asyncValues(this), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                        _c = _g.value;
+                        _e = false;
+                        try {
+                            const value = _c;
+                            const result = callback(value);
+                            if (result instanceof Future || result instanceof Promise) {
+                                yield result;
+                            }
+                            this.finalActionHooks.forEach((hook) => hook());
+                        }
+                        finally {
+                            _e = true;
+                        }
+                    }
+                }
+                catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                finally {
+                    try {
+                        if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                    }
+                    finally { if (e_4) throw e_4.error; }
+                }
                 resolve();
             }
             catch (error) {
-                reject(error instanceof FutureError ? error : new FutureError((_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : "Unknown"));
+                reject(error instanceof FutureError ? error : new FutureError((_d = error === null || error === void 0 ? void 0 : error.message) !== null && _d !== void 0 ? _d : "Unknown"));
             }
         })).schedule();
     }
@@ -936,6 +991,7 @@ class Stream {
                 let pending = null;
                 while (!signal.aborted) {
                     const value = yield this.internalNext().registerSignal(signal);
+                    this.finalActionHooks.forEach((hook) => hook());
                     if (!value.done) {
                         pending === null || pending === void 0 ? void 0 : pending.cancel();
                         const result = callback(value.value);
@@ -969,6 +1025,7 @@ class Stream {
                 if (value !== null && value !== undefined) {
                     this.monitorHooks.forEach((hook) => hook(value));
                 }
+                this.finalActionHooks.forEach((hook) => hook());
                 if (state !== State.CONTINUE) {
                     this.done = true;
                     this.invokeCompletionHooks();
@@ -1076,6 +1133,7 @@ class Stream {
                             const preResult = yield this.yieldTrueResult(preProcessor(data), signal);
                             const result = yield this.yieldTrueResult(functor(preResult instanceof Promise ? yield preResult : preResult), signal);
                             if (result === null || result === undefined) {
+                                this.finalActionHooks.forEach((hook) => hook());
                                 return resolve({ state: State.CONTINUE });
                             }
                             data = result;
@@ -1288,7 +1346,7 @@ class Stream {
     }
     forwardExecute(preProcessor = R.identity) {
         return Future.of((resolve, reject, signal) => __awaiter(this, void 0, void 0, function* () {
-            var _a, e_4, _b, _c;
+            var _a, e_5, _b, _c;
             let pending = [];
             try {
                 for (var _d = true, _e = __asyncValues(this.sourceStream.internalIterator()), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
@@ -1312,12 +1370,12 @@ class Stream {
                     }
                 }
             }
-            catch (e_4_1) { e_4 = { error: e_4_1 }; }
+            catch (e_5_1) { e_5 = { error: e_5_1 }; }
             finally {
                 try {
                     if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
                 }
-                finally { if (e_4) throw e_4.error; }
+                finally { if (e_5) throw e_5.error; }
             }
             const { state, value } = yield this.collectResult(pending, signal);
             if (state === State.CONTINUE) {