@everyonesoftware/common 3.0.0 → 4.0.0

package/sources/toStringFunctions.ts

@@ -1,185 +0,0 @@
-import { Iterable } from "./iterable";
-import { Iterator } from "./iterator";
-import { isMap, Map, MapEntry } from "./map";
-import { isSet, Set } from "./set";
-import { escapeAndQuote, join } from "./strings";
-import { isArray, isIterable, isNumber, isObject, isString } from "./types";
-
-/**
- * A collection of {@link ToStringFunction}s.
- */
-export class ToStringFunctions
-{
-    private readonly functions: ((value: unknown) => (string | undefined))[];
-
-    private constructor()
-    {
-        this.functions = [];
-    }
-
-    public static create(): ToStringFunctions
-    {
-        return new ToStringFunctions();
-    }
-
-    private defaultToString(value: unknown): string
-    {
-        let result: string;
-        if (isMap(value))
-        {
-            result = this.mapToString(value);
-        }
-        else if (isSet(value))
-        {
-            result = this.setToString(value);
-        }
-        else if (isIterable(value))
-        {
-            result = this.iterableToString(value);
-        }
-        else if (isNumber(value))
-        {
-            result = value.toString();
-        }
-        else if (value === undefined)
-        {
-            result = "undefined";
-        }
-        else if (value === null)
-        {
-            result = "null";
-        }
-        else if (isString(value))
-        {
-            result = escapeAndQuote(value);
-        }
-        else if (isArray(value))
-        {
-            result = `[${join(",", value.map(x => this.toString(x)))}]`;
-        }
-        else if (isObject(value))
-        {
-            result = `{${join(",", Object.entries(value).map(p => join(":", p.map(x => this.toString(x)))))}}`;
-        }
-        else
-        {
-            result = JSON.stringify(value);
-        }
-        return result;
-    }
-
-    /**
-     * Get the {@link String} representation of the value with the registered
-     * {@link ToStringFunction}s.
-     * @param value The value to get the {@link String} representation of.
-     */
-    public toString(value: unknown): string
-    {
-        let result: string | undefined;
-        for (const toStringFunction of this.functions)
-        {
-            result = toStringFunction(value);
-            if (result !== undefined)
-            {
-                break;
-            }
-        }
-
-        if (result === undefined)
-        {
-            result = this.defaultToString(value);
-        }
-
-        return result;
-    }
-
-    public add(toStringFunction: (value: unknown) => (string | undefined)): this;
-    public add<T>(typeCheckFunction: (value: unknown) => value is T, typedToStringFunction: (value: T) => string): this;
-    add<T>(typeCheckFunctionOrToStringFunction: ((value: unknown) => (string | undefined)) | ((value: unknown) => value is T), typedToStringFunction?: (value: T) => string): this
-    {
-        let toStringFunction: (value: unknown) => (string | undefined);
-        if (typedToStringFunction)
-        {
-            const typeCheckFunction = typeCheckFunctionOrToStringFunction as (value: unknown) => value is T;
-            toStringFunction = (value: unknown) =>
-            {
-                let result: string | undefined;
-                if (typeCheckFunction(value))
-                {
-                    result = typedToStringFunction!(value);
-                }
-                return result;
-            };
-        }
-        else
-        {
-            toStringFunction = typeCheckFunctionOrToStringFunction as (value: unknown) => (string | undefined);
-        }
-
-        this.functions.unshift(toStringFunction);
-
-        return this;
-    }
-
-    private iterableToString(values: Iterable<unknown>): string
-    {
-        let result: string = "";
-        result += "[";
-
-        const iterator: Iterator<unknown> = values.iterate().start().await();
-        if (iterator.hasCurrent())
-        {
-            result += this.toString(iterator.takeCurrent().await());
-            while (iterator.hasCurrent())
-            {
-                result += ",";
-                result += this.toString(iterator.takeCurrent().await());
-            }
-        }
-
-        result += "]";
-        return result;
-    }
-
-    private mapToString(values: Map<unknown,unknown>): string
-    {
-        let result = "";
-        result += "{";
-
-        const iterator: Iterator<MapEntry<unknown,unknown>> = values.iterate();
-        if (iterator.next().await())
-        {
-            let entry: MapEntry<unknown,unknown> = iterator.getCurrent();
-            result += `${this.toString(entry.key)}:${this.toString(entry.value)}`;
-            while (iterator.next().await())
-            {
-                result += ",";
-
-                entry = iterator.getCurrent();
-                result += `${this.toString(entry.key)}:${this.toString(entry.value)}`;
-            }
-        }
-
-        result += "}";
-        return result;
-    }
-
-    private setToString(values: Set<unknown>): string
-    {
-        let result = "";
-        result += "{";
-
-        const iterator: Iterator<unknown> = values.iterate();
-        if (iterator.next().await())
-        {
-            result += this.toString(iterator.getCurrent());
-            while (iterator.next().await())
-            {
-                result += `,${this.toString(iterator.getCurrent())}`;
-            }
-        }
-
-        result += "}";
-        return result;
-    }
-}

package/sources/types.ts

@@ -1,371 +0,0 @@
-import { Iterable } from "./iterable";
-import { Iterator } from "./iterator";
-import { JavascriptAsyncIterable, JavascriptAsyncIterator, JavascriptIterable, JavascriptIterator } from "./javascript";
-
-/**
- * A {@link Type} that can be used to pass types as parameters.
- */
-export type Type<T> = Function & { prototype: T };
-
-/**
- * Get whether the provided value is an instance of {@link Type} {@link T}.
- * @param typeOrTypeCheck The {@link Type} to look for or type check {@link Function} to determine
- * if the provided value is a {@link T}.
- * @param value The value to check.
- */
-export function instanceOf<T>(value: unknown, typeCheck: (value: unknown) => value is T): value is T;
-/**
- * Get whether the provided value is an instance of {@link Type} {@link T}.
- * @param typeOrTypeCheck The {@link Type} to look for or type check {@link Function} to determine
- * if the provided value is a {@link T}.
- * @param value The value to check.
- */
-export function instanceOf<T>(value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T): value is T;
-export function instanceOf<T>(value: unknown, typeOrTypeCheck: Type<T> | ((value: unknown) => value is T), typeCheck?: (value: unknown) => value is T): value is T
-{
-    let result: boolean;
-    if (!isUndefinedOrNull(typeCheck))
-    {
-        result = typeCheck(value);
-    }
-    else if (value instanceof typeOrTypeCheck)
-    {
-        result = true;
-    }
-    else if (isFunctionWithParameterCount(typeOrTypeCheck, 1))
-    {
-        typeCheck = typeOrTypeCheck as ((value: unknown) => value is T);
-        result = typeCheck(value);
-    }
-    else
-    {
-        result = false;
-    }
-    return result;
-}
-
-/**
- * Get whether the provided value is an instance of the provided {@link Type}. This will return
- * false if value only implements the provided {@link Type} but doesn't extend it.
- * @param value The value to check.
- * @param type The {@link Type} to see if value is an instance of.
- */
-export function instanceOfType<T>(value: unknown, type: Type<T>): value is T
-{
-    return value instanceof type;
-}
-
-/**
- * If the provided {@link value} is of type {@link T} (according to the provided {@link typeCheck}),
- * then return the {@link value}. Otherwise return undefined.
- * @param value The value to check.
- * @param typeOrTypeCheck The {@link Type} to look for or type check {@link Function} to determine
- * if the provided value is a {@link T}.
- */
-export function as<T>(value: unknown, typeOrTypeCheck: Type<T> | ((value: unknown) => value is T)): T | undefined
-{
-    return instanceOf(value, typeOrTypeCheck) ? value as T : undefined;
-}
-
-/**
- * Get whether the provided value is undefined.
- * @param value The value to check.
- */
-export function isUndefined(value: unknown): value is undefined
-{
-    return value === undefined;
-}
-
-/**
- * Get whether the provided value is null.
- * @param value The value to check.
- */
-export function isNull(value: unknown): value is null
-{
-    return value === null;
-}
-
-/**
- * Return the provided value if it is null, otherwise return undefined.
- * @param value The value to check.
- */
-export function asNull(value: unknown): null | undefined
-{
-    return as(value, isNull);
-}
-
-/**
- * Get whether the provided value is undefined or null.
- * @param value The value to check.
- */
-export function isUndefinedOrNull(value: unknown): value is undefined | null
-{
-    return isUndefined(value) || isNull(value);
-}
-
-/**
- * Get whether the provided value is a {@link boolean}.
- * @param value The value to check.
- */
-export function isBoolean(value: unknown): value is boolean
-{
-    return typeof value === "boolean";
-}
-
-/**
- * Return the provided value if it is a boolean, otherwise return undefined.
- * @param value The value to check.
- */
-export function asBoolean(value: unknown): boolean | undefined
-{
-    return as(value, isBoolean);
-}
-
-/**
- * Get whether the provided value is a {@link number}.
- * @param value The value to check.
- */
-export function isNumber(value: unknown): value is number
-{
-    return typeof value === "number";
-}
-
-/**
- * Return the provided value if it is a number, otherwise return undefined.
- * @param value The value to check.
- */
-export function asNumber(value: unknown): number | undefined
-{
-    return as(value, isNumber);
-}
-
-/**
- * Get whether the provided value is a {@link string}.
- * @param value The value to check.
- */
-export function isString(value: unknown): value is string
-{
-    return typeof value === "string";
-}
-
-/**
- * Return the provided value if it is a string, otherwise return undefined.
- * @param value The value to check.
- */
-export function asString(value: unknown): string | undefined
-{
-    return as(value, isString);
-}
-
-/**
- * Get whether the provided value is a {@link function}.
- * @param value The value to check.
- */
-export function isFunction(value: unknown): value is Function
-{
-    return typeof value === "function";
-}
-
-/**
- * Return the provided value if it is a function, otherwise return undefined.
- * @param value The value to check.
- */
-export function asFunction(value: unknown): Function | undefined
-{
-    return as(value, isFunction);
-}
-
-/**
- * Get the number of parameters that the provided {@link Function} takes.
- * @param value The {@link Function} to get the parameter count for.
- */
-export function getParameterCount(value: Function): number
-{
-    return value.length;
-}
-
-/**
- * Get whether the provided value is a function with the provided parameter count.
- * @param value The value to check.
- * @param parameterCount The number of parameters the function must have.
- */
-export function isFunctionWithParameterCount(value: unknown, parameterCount: number): value is Function
-{
-    return isFunction(value) && getParameterCount(value) === parameterCount;
-}
-
-/**
- * Return the provided value if it is a function with the provided {@link parameterCount}, otherwise
- * return undefined.
- * @param value The value to check.
- */
-export function asFunctionWithParameterCount(value: unknown, parameterCount: number): Function | undefined
-{
-    return as(value, (v: unknown) => isFunctionWithParameterCount(v, parameterCount));
-}
-
-/**
- * Get whether the provided value is an {@link Array}.
- * @param value The value to check.
- */
-export function isArray(value: unknown): value is unknown[]
-{
-    return Array.isArray(value);
-}
-
-/**
- * Return the provided value if it is an array, otherwise return undefined.
- * @param value The value to check.
- */
-export function asArray(value: unknown): unknown[] | undefined
-{
-    return as(value, isArray);
-}
-
-/**
- * Get whether the provided value is an {@link Object} or is null.
- * @param value The value to check.
- */
-export function isObjectOrArrayOrNull(value: unknown): value is {} | unknown[] | null
-{
-    return typeof value === "object";
-}
-
-/**
- * Return the provided value if it is an array, otherwise return undefined.
- * @param value The value to check.
- */
-export function asObjectOrArrayOrNull(value: unknown): {} | unknown[] | null | undefined
-{
-    return as(value, isObjectOrArrayOrNull);
-}
-
-/**
- * Get whether the provided value is an {@link Object}.
- * @param value The value to check.
- * @returns 
- */
-export function isObject(value: unknown): value is {}
-{
-    return isObjectOrArrayOrNull(value) && !!value && !isArray(value);
-}
-
-/**
- * Return the provided value if it is an {@link Object}, otherwise return undefined.
- * @param value The value to check.
- */
-export function asObject(value: unknown): {} | undefined
-{
-    return as(value, isObject);
-}
-
-/**
- * Get an {@link Iterator} that can be used to iterate through the properties of the provided value.
- * @param value The value to iterate over.
- */
-export function getPropertyNames(value: {}): Iterable<string>
-{
-    return Iterable.create(Object.keys(value));
-}
-
-/**
- * Get whether the provided value has a property with the provided key.
- * @param value The value to check.
- * @param propertyKey The key of the property to look for.
- */
-export function hasProperty<TValue, TPropertyKey extends PropertyKey>(value: TValue, propertyKey: TPropertyKey): value is TValue & Record<TPropertyKey, unknown>
-{
-    return value !== undefined && value !== null && (value as any)[propertyKey] !== undefined;
-}
-
-/**
- * Get whether the value has a function with the provided name.
- * @param value The value to check.
- * @param functionName The name of the function to look for.
- */
-export function hasFunction<TValue, TPropertyKey extends PropertyKey>(value: TValue, functionName: TPropertyKey, parameterCount?: number): value is TValue & Record<TPropertyKey,Function>
-{
-    let result: boolean = false;
-    if (value !== undefined && value !== null)
-    {
-        const func: unknown = (value as any)[functionName];
-        if (isUndefinedOrNull(parameterCount))
-        {
-            result = isFunction(func);
-        }
-        else
-        {
-            result = isFunctionWithParameterCount(func, parameterCount);
-        }
-    }
-    return result;
-}
-
-/**
- * Get whether the provided value is a {@link JavascriptIterator}.
- * @param value The value to check.
- */
-export function isJavascriptIterator<T>(value: unknown): value is JavascriptIterator<T>
-{
-    return hasFunction(value, "next");
-}
-
-/**
- * Get whether the provided value is a {@link JavascriptIterable}.
- * @param value The value to check.
- */
-export function isJavascriptIterable<T>(value: unknown): value is JavascriptIterable<T>
-{
-    return hasFunction(value, Symbol.iterator);
-}
-
-export function isIterable<T>(value: unknown): value is Iterable<T>
-{
-    return isJavascriptIterable(value) &&
-        hasFunction(value, "iterate", 0);
-}
-
-/**
- * Get whether the provided value is a {@link JavascriptAsyncIterator}.
- * @param value The value to check.
- */
-export function isJavascriptAsyncIterator<T>(value: unknown): value is JavascriptAsyncIterator<T>
-{
-    return hasFunction(value, "next");
-}
-
-/**
- * Get whether the provided value is a {@link JavascriptAsyncIterable}.
- * @param value The value to check.
- */
-export function isJavascriptAsyncIterable<T>(value: unknown): value is JavascriptAsyncIterable<T>
-{
-    return hasFunction(value, Symbol.asyncIterator);
-}
-
-export function isAsyncIterable<T>(value: unknown): value is AsyncIterable<T>
-{
-    return isJavascriptAsyncIterable(value) &&
-        hasFunction(value, "iterate", 0);
-}
-
-/**
- * Get the name of the provided {@link Type}.
- * @param type The {@link Type} to get the name of.
- */
-export function getName(type: Type<unknown>): string
-{
-    return type.name;
-}
-
-export function isPromiseLike<T>(value: unknown): value is PromiseLike<T>
-{
-    return hasFunction(value, "then", 2);
-}
-
-export function isPromise<T>(value: unknown): value is Promise<T>
-{
-    return isPromiseLike<T>(value) &&
-        hasFunction(value, "catch", 1) &&
-        hasFunction(value, "finally", 1);
-}

package/sources/whereAsyncIterator.ts

@@ -1,143 +0,0 @@
-import { AsyncIterator } from "./asyncIterator";
-import { PromiseAsyncResult } from "./promiseAsyncResult";
-import { JavascriptAsyncIterator } from "./javascript";
-import { PreCondition } from "./preCondition";
-import { Type } from "./types";
-
-/**
- * An {@link Iterator} that only returns values that match a condition.
- */
-export class WhereAsyncIterator<T> implements AsyncIterator<T>
-{
-    private readonly innerIterator: AsyncIterator<T>;
-    private started: boolean;
-    private readonly condition: (value: T) => (boolean | PromiseLike<boolean>);
-
-    private constructor(innerIterator: AsyncIterator<T>, condition: (value: T) => (boolean | PromiseLike<boolean>))
-    {
-        PreCondition.assertNotUndefinedAndNotNull(innerIterator, "innerIterator");
-        PreCondition.assertNotUndefinedAndNotNull(condition, "condition");
-
-        this.innerIterator = innerIterator;
-        this.started = false;
-        this.condition = condition;
-    }
-
-    public hasStarted(): boolean
-    {
-        return this.started;
-    }
-
-    public hasCurrent(): boolean
-    {
-        return this.hasStarted() && this.innerIterator.hasCurrent();
-    }
-
-    public getCurrent(): T
-    {
-        PreCondition.assertTrue(this.hasCurrent(), "this.hasCurrent()");
-
-        return this.innerIterator.getCurrent();
-    }
-
-    public static create<T>(innerIterator: AsyncIterator<T>, condition: (value: T) => (boolean | PromiseLike<boolean>)): WhereAsyncIterator<T>
-    {
-        return new WhereAsyncIterator(innerIterator, condition);
-    }
-
-    public next(): PromiseAsyncResult<boolean>
-    {
-        return PromiseAsyncResult.create(async () =>
-        {
-            if (!this.hasStarted())
-            {
-                await this.innerIterator.start();
-                this.started = true;
-
-                while (this.hasCurrent() && !await this.condition(this.getCurrent()))
-                {
-                    await this.innerIterator.next();
-                }
-            }
-            else
-            {
-                do
-                {
-                    await this.innerIterator.next();
-                }
-                while (this.hasCurrent() && !await this.condition(this.getCurrent()));
-            }
-            return this.hasCurrent();
-        });
-    }
-
-    public start(): PromiseAsyncResult<this>
-    {
-        return AsyncIterator.start<T, this>(this);
-    }
-
-    public takeCurrent(): PromiseAsyncResult<T>
-    {
-        return AsyncIterator.takeCurrent(this);
-    }
-
-    public any(): PromiseAsyncResult<boolean>
-    {
-        return AsyncIterator.any(this);
-    }
-
-    public getCount(): PromiseAsyncResult<number>
-    {
-        return AsyncIterator.getCount(this);
-    }
-
-    public toArray(): PromiseAsyncResult<T[]>
-    {
-        return AsyncIterator.toArray(this);
-    }
-
-    public where(condition: (value: T) => (boolean | PromiseLike<boolean>)): AsyncIterator<T>
-    {
-        return AsyncIterator.where(this, condition);
-    }
-
-    public map<TOutput>(mapping: (value: T) => (TOutput | PromiseLike<TOutput>)): AsyncIterator<TOutput>
-    {
-        return AsyncIterator.map(this, mapping);
-    }
-
-    public whereInstanceOf<U extends T>(typeCheck: (value: T) => value is U): AsyncIterator<U>
-    {
-        return AsyncIterator.whereInstanceOf(this, typeCheck);
-    }
-
-    public whereInstanceOfType<U extends T>(type: Type<U>): AsyncIterator<U>
-    {
-        return AsyncIterator.whereInstanceOfType(this, type);
-    }
-
-    public first(condition?: (value: T) => (boolean | PromiseLike<boolean>)): PromiseAsyncResult<T>
-    {
-        return AsyncIterator.first(this, condition);
-    }
-
-    public last(condition?: (value: T) => (boolean | PromiseLike<boolean>)): PromiseAsyncResult<T>
-    {
-        return AsyncIterator.last(this, condition);
-    }
-
-    public take(maximumToTake: number): AsyncIterator<T>
-    {
-        return AsyncIterator.take(this, maximumToTake);
-    }
-
-    public skip(maximumToSkip: number): AsyncIterator<T>
-    {
-        return AsyncIterator.skip(this, maximumToSkip);
-    }
-
-    public [Symbol.asyncIterator](): JavascriptAsyncIterator<T>
-    {
-        return AsyncIterator[Symbol.asyncIterator](this);
-    }
-}