@fbltd/async 1.0.15 → 1.0.17

package/README.md

@@ -19,15 +19,15 @@ await delay(number);
 delay(number, 'sync');
 ```
 
-### getPromise
-getPromise is a function that creates and returns promise, its fulfillment functions
-and status flags.
-Returned type is:
+### PromiseConfiguration
+PromiseConfiguration is a class that creates and provide promise, 
+its fulfillment functions and status flags.
+Instance of the class is represented by the following type:
 ```typescript
 type IPromiseConfiguration<T> = {
-    resolve(arg: T): void, // function that resolves promise
-    reject(err: Error): void, // function that rejects promise
-    promise: Promise<T>,        // promise itself
+    readonly resolve: (arg: T) => void, // function that resolves promise
+    readonly reject: (err: Error) => void, // function that rejects promise
+    readonly promise: Promise<T>,        // promise itself
     readonly isPending: boolean, // promise status flag
     readonly isFulfilled: boolean, // reverted promise status flag
 } 

package/dist/bin/delay.js

@@ -1,4 +1,4 @@
-import { getPromise } from "./get-promise.js";
+import { PromiseConfiguration } from "./promise-configuration.js";
 export function delay(ms = 0, syncKey) {
     ms = Math.max(ms, 0);
     return delay.methods[typeof syncKey](ms);
@@ -14,7 +14,7 @@ Object.defineProperty(delay, 'methods', {
             }
         },
         undefined: (ms) => {
-            const { promise, resolve } = getPromise();
+            const { promise, resolve } = new PromiseConfiguration();
             setTimeout(() => {
                 resolve();
             }, ms);

package/dist/bin/dependency-stream/{dependency-stream.js → dependency.js}

@@ -1,11 +1,10 @@
-import { getPromise } from "../get-promise.js";
-function baseComparer(prev, cur) {
-    return prev === cur;
-}
-export class DependencyStream {
+import { PromiseConfiguration } from "../promise-configuration.js";
+import { DependencyStream } from "./dependency.stream.js";
+import { baseComparer } from "./utils.js";
+export class Dependency {
     _value;
     reactionPromise;
-    abortPromise = getPromise();
+    abortPromise = new PromiseConfiguration();
     config;
     constructor(_value, config = {}) {
         this._value = _value;
@@ -31,13 +30,16 @@ export class DependencyStream {
     get value() {
         return this._value;
     }
+    getStream() {
+        return new DependencyStream(this);
+    }
     [Symbol.asyncIterator](thisStreamConfig = {}) {
         const totalDispose = this.abortPromise;
         const externalPromises = [totalDispose.promise];
         let firstPromise;
         const withReactionOnSubscribe = this.config.withReactionOnSubscribe || thisStreamConfig.withReactionOnSubscribe;
         if (withReactionOnSubscribe) {
-            firstPromise = getPromise();
+            firstPromise = new PromiseConfiguration();
             firstPromise.resolve(this.value);
             externalPromises.push(firstPromise.promise);
         }
@@ -54,7 +56,7 @@ export class DependencyStream {
             },
             next: async () => {
                 if (!this.reactionPromise) {
-                    this.reactionPromise = getPromise();
+                    this.reactionPromise = new PromiseConfiguration();
                     this._set(this._value);
                 }
                 await Promise.race([
@@ -80,7 +82,7 @@ export class DependencyStream {
     }
     dispose() {
         this.abortPromise.resolve();
-        this.abortPromise = getPromise();
+        this.abortPromise = new PromiseConfiguration();
         this.reactionPromise = undefined;
     }
 }

package/dist/bin/dependency-stream/dependency.stream.js

@@ -0,0 +1,27 @@
+import { PromiseConfiguration } from "../promise-configuration.js";
+import { symAI } from "../constants.js";
+export class DependencyStream {
+    owner;
+    selfDispose = new PromiseConfiguration();
+    iterator;
+    get isDisposed() {
+        return this.iterator.isDisposed;
+    }
+    constructor(owner) {
+        this.owner = owner;
+        this.selfDispose = new PromiseConfiguration();
+        this.iterator = owner[symAI]({ externalDispose: this.selfDispose });
+    }
+    [symAI]() {
+        return {
+            next: () => {
+                return this.iterator.next();
+            }
+        };
+    }
+    dispose() {
+        if (this.isDisposed)
+            return;
+        this.selfDispose.resolve();
+    }
+}

package/dist/bin/dependency-stream/index.js

@@ -1,4 +1,4 @@
-export * from "./dependency-stream.js";
+export * from "./dependency.js";
+export * from "./dependency.stream.js";
 export * from "./utils/index.js";
 export * from "./integrations/index.js";
-export * from "./contracts.js";

package/dist/bin/dependency-stream/utils/once.stream.js

@@ -1,22 +1,18 @@
-import { getPromise } from "../../get-promise.js";
 import { symAI } from "../../constants.js";
 export function onceStream(dep) {
-    const externalDispose = getPromise();
-    const iterator = dep[symAI]({ externalDispose });
-    function isDisposed() {
-        return externalDispose.isFulfilled || iterator.isDisposed;
-    }
+    const stream = dep.getStream();
+    const iterator = stream[symAI]();
     return {
         get isDisposed() {
-            return isDisposed();
+            return stream.isDisposed;
         },
-        dispose: externalDispose.resolve,
+        dispose: () => stream.dispose(),
         [symAI]() {
             return {
                 next: async () => {
                     const result = await iterator.next();
-                    if (!isDisposed())
-                        externalDispose.resolve();
+                    if (!result.done)
+                        stream.dispose();
                     return result;
                 }
             };

package/dist/bin/dependency-stream/utils/race.stream.js

@@ -1,7 +1,7 @@
 import { symAI } from "../../constants.js";
-import { getPromise } from "../../get-promise.js";
+import { PromiseConfiguration } from "../../promise-configuration.js";
 export function raceStream(...deps) {
-    let selfDisposePromise = getPromise();
+    let selfDisposePromise = new PromiseConfiguration();
     let isDisposed = false;
     const streams = deps.map((dep) => dep[symAI]({
         externalDispose: selfDisposePromise

package/dist/bin/dependency-stream/utils.js

@@ -0,0 +1,3 @@
+export function baseComparer(prev, cur) {
+    return prev === cur;
+}

package/dist/bin/index.js

@@ -1,4 +1,4 @@
 export * from "./dependency-stream/index.js";
 export * from "./dependency-stream/integrations/react/index.js";
 export * from "./delay.js";
-export * from "./get-promise.js";
+export * from "./promise-configuration.js";

package/dist/bin/promise-configuration.js

@@ -0,0 +1,30 @@
+export class PromiseConfiguration {
+    promise;
+    _resolve;
+    _reject;
+    _isFulfilled = false;
+    constructor() {
+        this.promise = new Promise((res, rej) => {
+            this._resolve = ((value) => {
+                res(value);
+                this._isFulfilled = true;
+            });
+            this._reject = (error) => {
+                rej(error);
+                this._isFulfilled = true;
+            };
+        });
+    }
+    get reject() {
+        return this._reject;
+    }
+    get resolve() {
+        return this._resolve;
+    }
+    get isFulfilled() {
+        return this._isFulfilled;
+    }
+    get isPending() {
+        return !this.isFulfilled;
+    }
+}

package/dist/types/dependency-stream/contracts.d.ts

@@ -1,18 +1,24 @@
-export interface IIteratorOwner<TValue = any> {
-    value: TValue;
-    dispose(): void;
-}
-export type IStreamReturn = void;
-export type IStreamIteratorReturn = IteratorReturnResult<IStreamReturn>;
-export type IStreamIteratorYield<T> = IteratorYieldResult<T>;
+import { PromiseConfiguration } from "../promise-configuration.js";
+import { Dependency } from "./dependency.ts";
 export interface IStreamIterator<TValue = any> {
-    owner: IIteratorOwner<TValue>;
+    owner: Dependency;
     dispose(): void;
     readonly isDisposed: boolean;
-    next(): Promise<IteratorResult<TValue, IStreamReturn>>;
+    next(): Promise<IteratorResult<TValue, void>>;
 }
-export interface IStreamOwner<TValue = any> {
+export interface IDependencyStream<TValue = any> {
     dispose(): void;
     readonly isDisposed: boolean;
-    [Symbol.asyncIterator](): AsyncIterator<TValue, IStreamReturn>;
+    [Symbol.asyncIterator](): AsyncIterator<TValue, void>;
+}
+export interface IIsEquals<T> {
+    (prev: T, cur: T): boolean;
 }
+export type IAllStreamConfig<T> = {
+    withCustomEquality: IIsEquals<T>;
+    withReactionOnSubscribe: boolean;
+};
+export type IThisStreamConfig = Partial<{
+    withReactionOnSubscribe: boolean;
+    externalDispose: PromiseConfiguration<any>;
+}>;

package/dist/types/dependency-stream/dependency.d.ts

@@ -0,0 +1,26 @@
+import { IAllStreamConfig, IThisStreamConfig } from "./contracts.ts";
+import { DependencyStream } from "./dependency.stream.ts";
+export declare class Dependency<T = any> {
+    private _value;
+    private reactionPromise;
+    private abortPromise;
+    private config;
+    constructor(_value: T, config?: Partial<IAllStreamConfig<T>>);
+    private _set;
+    set value(v: T);
+    get value(): T;
+    getStream(this: Dependency<T>): DependencyStream<T>;
+    [Symbol.asyncIterator](this: Dependency<T>, thisStreamConfig?: IThisStreamConfig): {
+        owner: Dependency<T>;
+        dispose: () => void;
+        readonly isDisposed: boolean;
+        next: () => Promise<{
+            done: true;
+            value: void;
+        } | {
+            done: boolean;
+            readonly value: T;
+        }>;
+    };
+    dispose(this: Dependency<T>): void;
+}

package/dist/types/dependency-stream/dependency.stream.d.ts

@@ -0,0 +1,14 @@
+import { IDependencyStream } from "./contracts.ts";
+import { symAI } from "../constants.ts";
+import { Dependency } from "./dependency.ts";
+export declare class DependencyStream<T = any> implements IDependencyStream {
+    readonly owner: Dependency;
+    private readonly selfDispose;
+    private readonly iterator;
+    get isDisposed(): boolean;
+    constructor(owner: Dependency);
+    [symAI](): {
+        next: () => Promise<IteratorResult<T, void>>;
+    };
+    dispose(): void;
+}

package/dist/types/dependency-stream/index.d.ts

@@ -1,4 +1,4 @@
-export * from './dependency-stream.ts';
+export * from './dependency.ts';
+export * from './dependency.stream.ts';
 export * from './utils/index.ts';
 export * from './integrations/index.ts';
-export * from './contracts.ts';

package/dist/types/dependency-stream/integrations/react/src/use-stream.d.ts

@@ -1,5 +1,5 @@
-import { DependencyStream } from "../../../index";
-export declare function useStream(...streams: DependencyStream[]): {
+import { Dependency } from "../../../index";
+export declare function useStream(...streams: Dependency[]): {
     value: Array<any> | undefined;
     dispose: () => void;
 };

package/dist/types/dependency-stream/utils/next.d.ts

@@ -1,6 +1,2 @@
-import { DependencyStream } from "../dependency-stream.ts";
-export declare function next<T>(dep: DependencyStream<T>): Promise<T>;
-/**
- * @internal
- */
-export declare const InternalStreamFinishError: Error;
+import { Dependency } from "../dependency.ts";
+export declare function next<T>(dep: Dependency<T>): Promise<T>;

package/dist/types/dependency-stream/utils/once.stream.d.ts

@@ -1,3 +1,3 @@
-import { DependencyStream } from "../dependency-stream.ts";
-import { IStreamOwner } from "../contracts.ts";
-export declare function onceStream<T>(dep: DependencyStream<T>): IStreamOwner<T>;
+import { Dependency } from "../dependency.ts";
+import { IDependencyStream } from "../contracts.ts";
+export declare function onceStream<T>(dep: Dependency<T>): IDependencyStream<T>;

package/dist/types/dependency-stream/utils/race.stream.d.ts

@@ -1,12 +1,12 @@
-import { DependencyStream } from "../dependency-stream.ts";
+import { Dependency } from "../dependency.ts";
 import { symAI } from "../../constants.ts";
-export declare function raceStream<TArray extends DependencyStream[]>(...deps: NoInfer<TArray>): {
+export declare function raceStream<TArray extends Dependency[]>(...deps: NoInfer<TArray>): {
     dispose: () => void;
     readonly isDisposed: boolean;
     [Symbol.asyncIterator](): {
-        next: () => Promise<IteratorReturnResult<void> | {
+        next: () => Promise<{
             done: boolean;
-            value: any[];
+            readonly value: any;
         }>;
     };
 };

package/dist/types/dependency-stream/utils.d.ts

@@ -0,0 +1 @@
+export declare function baseComparer<T>(prev: T, cur: T): boolean;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export * from './dependency-stream/index.ts';
 export * from './dependency-stream/integrations/react/index.ts';
 export * from './delay.ts';
-export * from './get-promise.ts';
+export * from './promise-configuration.ts';

package/dist/types/promise-configuration.d.ts

@@ -0,0 +1,11 @@
+export declare class PromiseConfiguration<TReturn = void> {
+    readonly promise: Promise<TReturn>;
+    _resolve: (value: TReturn) => void;
+    _reject: (value: Error) => void;
+    _isFulfilled: boolean;
+    constructor();
+    get reject(): (value: Error) => void;
+    get resolve(): (value: TReturn) => void;
+    get isFulfilled(): boolean;
+    get isPending(): boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fbltd/async",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Miscellaneous async utils",
   "homepage": "https://github.com/GlennMiller1991/async",
   "type": "module",

package/tsconfig.json

@@ -4,6 +4,7 @@
   "compilerOptions": {
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
+    "stripInternal": true,
   },
 }
 // @formatter:on

package/dist/bin/get-promise.js

@@ -1,29 +0,0 @@
-export function getPromise() {
-    let resolve;
-    let reject;
-    let isPending = true;
-    let isFulfilled = false;
-    const promise = new Promise((res, rej) => {
-        resolve = ((value) => {
-            res(value);
-            isPending = false;
-            isFulfilled = true;
-        });
-        reject = (error) => {
-            rej(error);
-            isPending = false;
-            isFulfilled = true;
-        };
-    });
-    return {
-        resolve,
-        reject,
-        get isPending() {
-            return isPending;
-        },
-        get isFulfilled() {
-            return isFulfilled;
-        },
-        promise
-    };
-}

package/dist/types/dependency-stream/dependency-stream.d.ts

@@ -1,26 +0,0 @@
-import { IPromiseConfiguration } from "../get-promise.ts";
-import { IIteratorOwner, IStreamIterator } from "./contracts.ts";
-interface IIsEquals<T> {
-    (prev: T, cur: T): boolean;
-}
-type IAllStreamConfig<T> = {
-    withCustomEquality: IIsEquals<T>;
-    withReactionOnSubscribe: boolean;
-};
-type IThisStreamConfig = Partial<{
-    withReactionOnSubscribe: boolean;
-    externalDispose: IPromiseConfiguration<any>;
-}>;
-export declare class DependencyStream<T = any> implements IIteratorOwner<T> {
-    private _value;
-    private reactionPromise;
-    private abortPromise;
-    private config;
-    constructor(_value: T, config?: Partial<IAllStreamConfig<T>>);
-    private _set;
-    set value(v: T);
-    get value(): T;
-    [Symbol.asyncIterator](this: DependencyStream<T>, thisStreamConfig?: IThisStreamConfig): IStreamIterator<T>;
-    dispose(this: DependencyStream<T>): void;
-}
-export {};

package/dist/types/get-promise.d.ts

@@ -1,8 +0,0 @@
-export declare function getPromise<TReturn = void>(): {
-    resolve: (value: TReturn) => void;
-    reject: (value: Error) => void;
-    readonly isPending: boolean;
-    readonly isFulfilled: boolean;
-    promise: Promise<TReturn>;
-};
-export type IPromiseConfiguration<T = void> = ReturnType<typeof getPromise<T>>;