@everyonesoftware/common 2.0.0 → 3.0.0

package/sources/asyncIteratorToJavascriptAsyncIteratorAdapter.ts

@@ -1,48 +1,48 @@
-import { AsyncIterator } from "./asyncIterator";
-import { JavascriptAsyncIterator, JavascriptIteratorResult } from "./javascript";
-import { PreCondition } from "./preCondition";
-
-/**
- * A type that adapts an {@link AsyncIterator} to match a {@link JavascriptAsyncIterator}.
- */
-export class AsyncIteratorToJavascriptAsyncIteratorAdapter<T> implements JavascriptAsyncIterator<T>
-{
-    private readonly iterator: AsyncIterator<T>;
-    private hasStarted: boolean;
-
-    private constructor(iterator: AsyncIterator<T>)
-    {
-        PreCondition.assertNotUndefinedAndNotNull(iterator, "iterator");
-
-        this.iterator = iterator;
-        this.hasStarted = false;
-    }
-
-    public static create<T>(iterator: AsyncIterator<T>): AsyncIteratorToJavascriptAsyncIteratorAdapter<T>
-    {
-        return new AsyncIteratorToJavascriptAsyncIteratorAdapter<T>(iterator);
-    }
-    
-    public async next(): Promise<JavascriptIteratorResult<T>>
-    {
-        if (!this.hasStarted)
-        {
-            this.hasStarted = true;
-            await this.iterator.start();
-        }
-        else
-        {
-            await this.iterator.next();
-        }
-
-        const result: JavascriptIteratorResult<T> = {
-            done: !this.iterator.hasCurrent(),
-            value: undefined!,
-        };
-        if (!result.done)
-        {
-            result.value = this.iterator.getCurrent();
-        }
-        return result;
-    }
+import { AsyncIterator } from "./asyncIterator";
+import { JavascriptAsyncIterator, JavascriptIteratorResult } from "./javascript";
+import { PreCondition } from "./preCondition";
+
+/**
+ * A type that adapts an {@link AsyncIterator} to match a {@link JavascriptAsyncIterator}.
+ */
+export class AsyncIteratorToJavascriptAsyncIteratorAdapter<T> implements JavascriptAsyncIterator<T>
+{
+    private readonly iterator: AsyncIterator<T>;
+    private hasStarted: boolean;
+
+    private constructor(iterator: AsyncIterator<T>)
+    {
+        PreCondition.assertNotUndefinedAndNotNull(iterator, "iterator");
+
+        this.iterator = iterator;
+        this.hasStarted = false;
+    }
+
+    public static create<T>(iterator: AsyncIterator<T>): AsyncIteratorToJavascriptAsyncIteratorAdapter<T>
+    {
+        return new AsyncIteratorToJavascriptAsyncIteratorAdapter<T>(iterator);
+    }
+    
+    public async next(): Promise<JavascriptIteratorResult<T>>
+    {
+        if (!this.hasStarted)
+        {
+            this.hasStarted = true;
+            await this.iterator.start();
+        }
+        else
+        {
+            await this.iterator.next();
+        }
+
+        const result: JavascriptIteratorResult<T> = {
+            done: !this.iterator.hasCurrent(),
+            value: undefined!,
+        };
+        if (!result.done)
+        {
+            result.value = this.iterator.getCurrent();
+        }
+        return result;
+    }
 }

package/sources/asyncResult.ts

@@ -1,95 +1,95 @@
-import { PromiseAsyncResult } from "./promiseAsyncResult";
-import { isPromise, Type } from "./types";
-
-/**
- * A result object that adds extra behavior beyond the standard {@link Promise}.
- */
-export abstract class AsyncResult<T> implements Promise<T>
-{
-    public static create<T>(action: () => (T | Promise<T>)): AsyncResult<T>;
-    public static create<T>(promise: Promise<T>): AsyncResult<T>;
-    static create<T>(actionOrPromise: (() => (T | Promise<T>)) | Promise<T>): AsyncResult<T>
-    {
-        return PromiseAsyncResult.create<T>(isPromise<T>(actionOrPromise) ? actionOrPromise : new Promise<T>(actionOrPromise));
-    }
-
-    /**
-     * Create a new {@link AsyncResult} that contains the provided value.
-     * @param value The value to wrap in a {@link AsyncResult}.
-     */
-    public static value<T>(value: T): AsyncResult<T>
-    {
-        return PromiseAsyncResult.value(value);
-    }
-
-    /**
-     * Create a new {@link AsyncResult} that contains the provided error.
-     * @param error The error to wrap in a {@link AsyncResult}.
-     */
-    public static error<T>(error: Error): AsyncResult<T>
-    {
-        return PromiseAsyncResult.error<T>(error);
-    }
-
-    public static yield(): AsyncResult<void>
-    {
-        return PromiseAsyncResult.yield();
-    }
-
-    /**
-     * Get a {@link AsyncResult} that runs the provided function if this {@link AsyncResult} is successful.
-     * @param thenFunction The function to run if this {@link AsyncResult} is successful.
-     */
-    public abstract then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): AsyncResult<TResult1 | TResult2>
-
-    /**
-     * Run the provided onValueFunction if this {@link AsyncResult} is successful. The value or error
-     * contained by this {@link AsyncResult} will be contained by the returned {@link AsyncResult}.
-     * @param onValueFunction The function to run if this {@link AsyncResult} is successful.
-     */
-    public abstract onValue(onValueFunction: (value: T) => (void | Promise<void>)): AsyncResult<T>
-
-    /**
-     * Run the provided catchFunction if this {@link AsyncResult} contains an error.
-     * @param catchFunction The function to run if an error is caught.
-     */
-    public abstract catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): AsyncResult<T | TResult>
-    /**
-     * Run the provided catchFunction if this {@link AsyncResult} contains an error of the provided type.
-     * @param errorType The type of error to catch.
-     * @param catchFunction The function to run if the error is caught.
-     */
-    public abstract catch<TError,TResult = never>(errorType: Type<TError>, onrejected: (reason: TError) => (TResult | PromiseLike<TResult>)): AsyncResult<T | TResult>
-
-    /**
-     * Run the provided onErrorFunction if this {@link AsyncResult} contains an error.
-     * @param onErrorFunction The function to run if an error is found.
-     */
-    public abstract onError(onErrorFunction: (reason: unknown) => (void | PromiseLike<void>)): AsyncResult<T>;
-    /**
-     * Run the provided onErrorFunction if this {@link AsyncResult} contains an error of the provided
-     * type.
-     * @param errorType The type of error to respond to.
-     * @param onErrorFunction The function to run if the error is found.
-     */
-    public abstract onError<TError>(errorType: Type<TError>, onErrorFunction: (reason: TError) => (void | PromiseLike<void>)): AsyncResult<T>;
-
-    /**
-     * Run the provided convertErrorFunction if this {@link AsyncResult} contains an error. The value
-     * returned from the convertErrorFunction will be the error for the returned {@link AsyncResult}.
-     * @param convertErrorFunction The function that will return the new error. 
-     */
-    public abstract convertError(convertErrorFunction: (reason: unknown) => (unknown | PromiseLike<unknown>)): AsyncResult<T>;
-    /**
-     * Run the provided convertErrorFunction if this {@link AsyncResult} contains an error of the
-     * provided type. The value returned from the convertErrorFunction will be the error for the
-     * returned {@link AsyncResult}.
-     * @param errorType The type of error to respond to.
-     * @param convertErrorFunction The function that will return the new error. 
-     */
-    public abstract convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => (unknown | PromiseLike<unknown>)): AsyncResult<T>;
-
-    public abstract finally(onfinally?: (() => (void | Promise<void>)) | null): AsyncResult<T>;
-
-    readonly abstract [Symbol.toStringTag]: string;
-}
+import { PromiseAsyncResult } from "./promiseAsyncResult";
+import { isPromise, Type } from "./types";
+
+/**
+ * A result object that adds extra behavior beyond the standard {@link Promise}.
+ */
+export abstract class AsyncResult<T> implements Promise<T>
+{
+    public static create<T>(action: () => (T | Promise<T>)): AsyncResult<T>;
+    public static create<T>(promise: Promise<T>): AsyncResult<T>;
+    static create<T>(actionOrPromise: (() => (T | Promise<T>)) | Promise<T>): AsyncResult<T>
+    {
+        return PromiseAsyncResult.create<T>(isPromise<T>(actionOrPromise) ? actionOrPromise : new Promise<T>(actionOrPromise));
+    }
+
+    /**
+     * Create a new {@link AsyncResult} that contains the provided value.
+     * @param value The value to wrap in a {@link AsyncResult}.
+     */
+    public static value<T>(value: T): AsyncResult<T>
+    {
+        return PromiseAsyncResult.value(value);
+    }
+
+    /**
+     * Create a new {@link AsyncResult} that contains the provided error.
+     * @param error The error to wrap in a {@link AsyncResult}.
+     */
+    public static error<T>(error: Error): AsyncResult<T>
+    {
+        return PromiseAsyncResult.error<T>(error);
+    }
+
+    public static yield(): AsyncResult<void>
+    {
+        return PromiseAsyncResult.yield();
+    }
+
+    /**
+     * Get a {@link AsyncResult} that runs the provided function if this {@link AsyncResult} is successful.
+     * @param thenFunction The function to run if this {@link AsyncResult} is successful.
+     */
+    public abstract then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): AsyncResult<TResult1 | TResult2>
+
+    /**
+     * Run the provided onValueFunction if this {@link AsyncResult} is successful. The value or error
+     * contained by this {@link AsyncResult} will be contained by the returned {@link AsyncResult}.
+     * @param onValueFunction The function to run if this {@link AsyncResult} is successful.
+     */
+    public abstract onValue(onValueFunction: (value: T) => (void | Promise<void>)): AsyncResult<T>
+
+    /**
+     * Run the provided catchFunction if this {@link AsyncResult} contains an error.
+     * @param catchFunction The function to run if an error is caught.
+     */
+    public abstract catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): AsyncResult<T | TResult>
+    /**
+     * Run the provided catchFunction if this {@link AsyncResult} contains an error of the provided type.
+     * @param errorType The type of error to catch.
+     * @param catchFunction The function to run if the error is caught.
+     */
+    public abstract catch<TError,TResult = never>(errorType: Type<TError>, onrejected: (reason: TError) => (TResult | PromiseLike<TResult>)): AsyncResult<T | TResult>
+
+    /**
+     * Run the provided onErrorFunction if this {@link AsyncResult} contains an error.
+     * @param onErrorFunction The function to run if an error is found.
+     */
+    public abstract onError(onErrorFunction: (reason: unknown) => (void | PromiseLike<void>)): AsyncResult<T>;
+    /**
+     * Run the provided onErrorFunction if this {@link AsyncResult} contains an error of the provided
+     * type.
+     * @param errorType The type of error to respond to.
+     * @param onErrorFunction The function to run if the error is found.
+     */
+    public abstract onError<TError>(errorType: Type<TError>, onErrorFunction: (reason: TError) => (void | PromiseLike<void>)): AsyncResult<T>;
+
+    /**
+     * Run the provided convertErrorFunction if this {@link AsyncResult} contains an error. The value
+     * returned from the convertErrorFunction will be the error for the returned {@link AsyncResult}.
+     * @param convertErrorFunction The function that will return the new error. 
+     */
+    public abstract convertError(convertErrorFunction: (reason: unknown) => (unknown | PromiseLike<unknown>)): AsyncResult<T>;
+    /**
+     * Run the provided convertErrorFunction if this {@link AsyncResult} contains an error of the
+     * provided type. The value returned from the convertErrorFunction will be the error for the
+     * returned {@link AsyncResult}.
+     * @param errorType The type of error to respond to.
+     * @param convertErrorFunction The function that will return the new error. 
+     */
+    public abstract convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => (unknown | PromiseLike<unknown>)): AsyncResult<T>;
+
+    public abstract finally(onfinally?: (() => (void | Promise<void>)) | null): AsyncResult<T>;
+
+    readonly abstract [Symbol.toStringTag]: string;
+}