@everyonesoftware/common 5.0.0 → 7.0.0

package/outputs/characterWriteStream-ogvZec-U.d.cts

@@ -0,0 +1,798 @@
+/**
+ * The result of comparing two values.
+ */
+declare enum Comparison {
+    /**
+     * The left value is less than the right value.
+     */
+    LessThan = 0,
+    /**
+     * The two values are equal.
+     */
+    Equal = 1,
+    /**
+     * The left value is greater than the right value.
+     */
+    GreaterThan = 2
+}
+
+/**
+ * An type that can be compared against another type.
+ */
+declare abstract class Comparable<T> {
+    protected constructor();
+    /**
+     * Compare this value against the provided value.
+     * @param value The value to compare against.
+     */
+    abstract compareTo(value: T): Comparison;
+    /**
+     * Get whether this value is less than the provided value.
+     * @param value The value to compare against.
+     */
+    lessThan(value: T): boolean;
+    /**
+     * Get whether the left value is less than the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static lessThan<T>(left: Comparable<T>, right: T): boolean;
+    /**
+     * Get whether this value is less than or equal to the provided value.
+     * @param value The value to compare against.
+     */
+    lessThanOrEqualTo(value: T): boolean;
+    /**
+     * Get whether the left value is less than or equal to the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static lessThanOrEqualTo<T>(left: Comparable<T>, right: T): boolean;
+    /**
+     * Get whether this value equals the provided value.
+     * @param value The value to compare against.
+     */
+    equals(value: T): boolean;
+    /**
+     * Get whether the left value equals the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static equals<T>(left: Comparable<T>, right: T): boolean;
+    /**
+     * Get whether this value is not equal to the provided value.
+     * @param value The value to compare against.
+     */
+    notEquals(value: T): boolean;
+    /**
+     * Get whether the left value is not equal to the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static notEquals<T>(left: Comparable<T>, right: T): boolean;
+    /**
+     * Get whether this value is greater than or equal to the provided value.
+     * @param value The value to compare against.
+     */
+    greaterThanOrEqualTo(value: T): boolean;
+    /**
+     * Get whether the left value is greater than or equal to the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static greaterThanOrEqualTo<T>(left: Comparable<T>, right: T): boolean;
+    /**
+     * Get whether this value is greater than the provided value.
+     * @param value The value to compare against.
+     */
+    greaterThan(value: T): boolean;
+    /**
+     * Get whether the left value is greater than the right value.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    static greaterThan<T>(left: Comparable<T>, right: T): boolean;
+}
+
+declare class PromiseAsyncResult<T> implements AsyncResult<T> {
+    private readonly promise;
+    private constructor();
+    static create<T>(actionOrPromise: (() => (T | Promise<T>)) | Promise<T>): PromiseAsyncResult<T>;
+    static empty(): PromiseAsyncResult<void>;
+    static value<T>(value: T): PromiseAsyncResult<T>;
+    static error<T>(error: unknown): PromiseAsyncResult<T>;
+    static yield(): PromiseAsyncResult<void>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseAsyncResult<TResult1 | TResult2>;
+    onValue(onValueFunction: (value: T) => (void | Promise<void>)): PromiseAsyncResult<T>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): PromiseAsyncResult<T | TResult>;
+    catch<TError, TResult = never>(errorType: Type<TError>, onrejected: (reason: TError) => (TResult | PromiseLike<TResult>)): PromiseAsyncResult<T | TResult>;
+    onError(onErrorFunction: (reason: unknown) => (void | PromiseLike<void>)): PromiseAsyncResult<T>;
+    onError<TError>(errorType: Type<TError>, onErrorFunction: (reason: TError) => (void | PromiseLike<void>)): PromiseAsyncResult<T>;
+    convertError(convertErrorFunction: (reason: unknown) => (unknown | PromiseLike<unknown>)): PromiseAsyncResult<T>;
+    convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => (unknown | PromiseLike<unknown>)): PromiseAsyncResult<T>;
+    finally(onfinally?: (() => (void | Promise<void>)) | null): PromiseAsyncResult<T>;
+    readonly [Symbol.toStringTag]: string;
+}
+
+declare class SyncResult<T> implements AsyncResult<T> {
+    private value;
+    private error;
+    private constructor();
+    static create<T>(action: () => T): SyncResult<T>;
+    static value<T>(value: T): SyncResult<T>;
+    static error<T>(error: unknown): SyncResult<T>;
+    await(): T;
+    then<TResult1 = T, TResult2 = never>(onfullfilled?: ((value: T) => TResult1) | null, onrejected?: ((reason: unknown) => TResult2) | null): SyncResult<TResult1 | TResult2>;
+    then<TResult1 = T, TResult2 = never>(onfullfilled?: ((value: T) => (TResult1 | PromiseLike<TResult1>)) | null, onrejected?: ((reason: unknown) => (TResult2 | PromiseLike<TResult2>)) | null): SyncResult<TResult1 | TResult2>;
+    onValue(onValueFunction: (value: T) => void): SyncResult<T>;
+    onValue(onValueFunction: (value: T) => Promise<void>): PromiseAsyncResult<T>;
+    catch<TResult = never>(onrejected: (reason: unknown) => TResult): SyncResult<T | TResult>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): SyncResult<T | TResult> | PromiseAsyncResult<T | TResult>;
+    catch<TError, TResult = never>(errorType: Type<TError>, onrejected: (reason: TError) => TResult): SyncResult<T | TResult>;
+    catch<TError, TResult = never>(errorType: Type<TError>, onrejected: (reason: TError) => PromiseLike<TResult>): PromiseAsyncResult<T | TResult>;
+    onError(onErrorFunction: (reason: unknown) => void): SyncResult<T>;
+    onError(onErrorFunction: (reason: unknown) => PromiseLike<void>): PromiseAsyncResult<T>;
+    onError<TError>(errorType: Type<TError>, onErrorFunction: (reason: TError) => void): SyncResult<T>;
+    onError<TError>(errorType: Type<TError>, onErrorFunction: (reason: TError) => PromiseLike<void>): PromiseAsyncResult<T>;
+    convertError(convertErrorFunction: (reason: unknown) => unknown): SyncResult<T>;
+    convertError(onErrorFunction: (reason: unknown) => PromiseLike<unknown>): PromiseAsyncResult<T>;
+    convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => unknown): SyncResult<T>;
+    convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => PromiseLike<unknown>): PromiseAsyncResult<T>;
+    finally(onfinally?: (() => void) | null): SyncResult<T>;
+    finally(onfinally?: (() => Promise<void>) | null): PromiseAsyncResult<T>;
+    readonly [Symbol.toStringTag]: string;
+}
+
+/**
+ * A collection of {@link Function}s that can be used to determine if two values are equal.
+ */
+declare class EqualFunctions {
+    private readonly equalFunctions;
+    private constructor();
+    static create(): EqualFunctions;
+    private defaultEqualFunction;
+    /**
+     * Get whether the provided values are equal based on the registered equal {@link Function}s.
+     * @param left The left value in the comparison.
+     * @param right The right value in the comparison.
+     */
+    areEqual(left: unknown, right: unknown): SyncResult<boolean>;
+    add(equalFunction: (left: unknown, right: unknown) => (boolean | undefined)): this;
+}
+
+/**
+ * The built-in {@link Array} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
+ */
+type JavascriptArray<T> = Array<T>;
+/**
+ * The built-in {@link Iterator} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators#iterators
+ */
+type JavascriptIterator<T> = Iterator<T>;
+/**
+ * The built-in {@link IteratorResult} type.
+ */
+type JavascriptIteratorResult<T> = IteratorResult<T, T>;
+/**
+ * The built-in {@link Iterable} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators#iterables
+ */
+type JavascriptIterable<T> = Iterable<T>;
+/**
+ * The built-in {@link Map} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
+ */
+type JavascriptMap<TKey, TValue> = Map<TKey, TValue>;
+/**
+ * The built-in {@link Map} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
+ */
+declare const JavascriptMap: MapConstructor;
+/**
+ * The built-in {@link AsyncIterator} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator
+ */
+type JavascriptAsyncIterator<T> = AsyncIterator<T>;
+interface JavascriptAsyncIterable<T> {
+    [Symbol.asyncIterator](): JavascriptAsyncIterator<T>;
+}
+/**
+ * The built-in {@link Set} type.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ */
+type JavascriptSet<T> = Set<T>;
+declare const JavascriptSet: SetConstructor;
+
+/**
+ * A type that can be used to iterate over a collection.
+ */
+declare abstract class Iterator$1<T> implements JavascriptIterable<T> {
+    /**
+     * Create a new {@link Iterator} that contains the provided values.
+     * @param values The values that the new {@link Iterator} will iterate over.
+     */
+    static create<T>(values: JavascriptIterator<T> | JavascriptIterable<T>): Iterator$1<T>;
+    /**
+     * Move to the next value in the collection. Return whether this {@link Iterator} points to a
+     * value after the move.
+     */
+    abstract next(): SyncResult<boolean>;
+    /**
+     * Get whether this {@link Iterator} has started iterating over the values in the collection.
+     */
+    abstract hasStarted(): boolean;
+    /**
+     * Get whether this {@link Iterator} currently points at a value in the collection.
+     */
+    abstract hasCurrent(): boolean;
+    /**
+     * Get the value that this {@link Iterator} points to.
+     */
+    abstract getCurrent(): T;
+    /**
+     * Move to the first value if this {@link Iterator} hasn't started yet.
+     * @returns This object for method chaining.
+     */
+    start(): SyncResult<this>;
+    /**
+     * Move the provided {@link Iterator} to its first value if it hasn't started yet.
+     */
+    static start<T, TIterator extends Iterator$1<T>>(iterator: TIterator): SyncResult<TIterator>;
+    /**
+     * Get the current value from this {@link Iterator} and advance this {@link Iterator} to the
+     * next value.
+     */
+    takeCurrent(): SyncResult<T>;
+    static takeCurrent<T>(iterator: Iterator$1<T>): SyncResult<T>;
+    [Symbol.iterator](): JavascriptIterator<T>;
+    /**
+     * Convert the provided {@link Iterator} to a {@link IteratorToJavascriptIteratorAdapter}.
+     * @param iterator The {@link Iterator} to convert.
+     */
+    static [Symbol.iterator]<T>(iterator: Iterator$1<T>): JavascriptIterator<T>;
+    /**
+     * Get whether this {@link Iterator} contains any values.
+     * Note: This may advance the {@link Iterator} to the first value if it hasn't been
+     * started yet.
+     */
+    any(): SyncResult<boolean>;
+    /**
+     * Get whether this {@link Iterator} contains any values.
+     * Note: This may advance the {@link Iterator} to the first value if it hasn't been
+     * started yet.
+     */
+    static any<T>(iterator: Iterator$1<T>): SyncResult<boolean>;
+    /**
+     * Get the number of values in this {@link Iterator}.
+     * Note: This will consume all of the values in this {@link Iterator}.
+     */
+    getCount(): SyncResult<number>;
+    /**
+     * Get the number of values in the provided {@link Iterator}.
+     * Note: This will consume all of the values in the provided {@link Iterator}.
+     */
+    static getCount<T>(iterator: Iterator$1<T>): SyncResult<number>;
+    /**
+     * Get all of the remaining values in this {@link Iterator} in a {@link T} {@link Array}.
+     */
+    toArray(): SyncResult<T[]>;
+    /**
+     * Get all of the remaining values in the provided {@link Iterator} in a {@link T}
+     * {@link Array}.
+     */
+    static toArray<T>(iterator: Iterator$1<T>): SyncResult<T[]>;
+    concatenate(...toConcatenate: JavascriptIterable<T>[]): Iterator$1<T>;
+    static concatenate<T>(iterator: Iterator$1<T>, ...toConcatenate: JavascriptIterable<T>[]): Iterator$1<T>;
+    /**
+     * Get an {@link Iterator} that will only return values that match the provided condition.
+     * @param condition The condition to run against each of the values in this {@link Iterator}.
+     */
+    where(condition: (value: T) => (boolean | SyncResult<boolean>)): Iterator$1<T>;
+    static where<T>(iterator: Iterator$1<T>, condition: (value: T) => (boolean | SyncResult<boolean>)): Iterator$1<T>;
+    /**
+     * Get a {@link MapIterator} that will map all {@link T} values from this {@link Iterator} to
+     * {@link TOutput} values.
+     * @param mapping The mapping that maps {@link T} values to {@link TOutput} values.
+     */
+    map<TOutput>(mapping: (value: T) => (TOutput | SyncResult<TOutput>)): Iterator$1<TOutput>;
+    static map<T, TOutput>(iterator: Iterator$1<T>, mapping: (value: T) => (TOutput | SyncResult<TOutput>)): Iterator$1<TOutput>;
+    flatMap<TOutput>(mapping: (value: T) => JavascriptIterable<TOutput>): Iterator$1<TOutput>;
+    static flatMap<T, TOutput>(iterator: Iterator$1<T>, mapping: (value: T) => JavascriptIterable<TOutput>): Iterator$1<TOutput>;
+    /**
+     * Get an {@link Iterator} that will filter this {@link Iterator} to only the values that are
+     * instances of {@link U} based on the provided type check {@link Function}.
+     * @param typeCheck The {@link Function} that will be used to determine if values are of type
+     * {@link U}.
+     */
+    whereInstanceOf<U extends T>(typeCheck: (value: T) => value is U): Iterator$1<U>;
+    static whereInstanceOf<T, U extends T>(iterator: Iterator$1<T>, typeCheck: (value: T) => value is U): Iterator$1<U>;
+    /**
+     * Get an {@link Iterator} that will filter this {@link Iterator} to only the values that are
+     * instances of the provided {@link Type}.
+     * @param type The type of values to return from the new {@link Iterator}.
+     */
+    whereInstanceOfType<U extends T>(type: Type<U>): Iterator$1<U>;
+    static whereInstanceOfType<T, U extends T>(iterator: Iterator$1<T>, type: Type<U>): Iterator$1<U>;
+    /**
+     * If the condition function is undefined, then this function will return the first value in
+     * this {@link Iterator}. If this condition function is provided, then this function will return
+     * the first value that matches the provided condition.
+     * @param condition The condition that the returned value must satisfy.
+     */
+    first(condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * If the condition function is undefined, then this function will return the first value in
+     * the {@link Iterator}. If this condition function is provided, then this function will return
+     * the first value that matches the provided condition.
+     * @param iterator The {@link Iterator} to get the first value from.
+     */
+    static first<T>(iterator: Iterator$1<T>, condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * If the condition function is undefined, then this function will return the last value in this
+     * {@link Iterator}. If this condition function is provided, then this function will return the
+     * last value that matches the provided condition.
+     * @param condition The condition that the returned value must satisfy.
+     */
+    last(condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * If the condition function is undefined, then this function will return the last value in the
+     * {@link Iterator}. If this condition function is provided, then this function will return the
+     * last value that matches the provided condition.
+     * @param iterator The {@link Iterator} to get the last value from.
+     */
+    static last<T>(iterator: Iterator$1<T>, condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * Find the maximum value in the provided {@link Iterator}.
+     * @param iterator The values to find the maximum of.
+     */
+    static findMaximum<T extends Comparable<T>>(iterator: JavascriptIterator<T> | Iterator$1<T>): SyncResult<T>;
+    /**
+     * Get a new {@link Iterator} that wraps around this {@link Iterator} and only
+     * returns a maximum number of values from this {@link Iterator}.
+     * @param maximumToTake The maximum number of values to take from this {@link Iterator}.
+     */
+    take(maximumToTake: number): Iterator$1<T>;
+    static take<T>(iterator: Iterator$1<T>, maximumToTake: number): Iterator$1<T>;
+    /**
+     * Get a new {@link Iterator} that wraps around this {@link Iterator} and will skip the initial
+     * provided number of values before beginning to return values.
+     * @param maximumToSkip The maximum number of values to skip from this {@link Iterator}.
+     */
+    skip(maximumToSkip: number): Iterator$1<T>;
+    static skip<T>(iterator: Iterator$1<T>, maximumToSkip: number): Iterator$1<T>;
+}
+
+/**
+ * A collection of {@link ToStringFunction}s.
+ */
+declare class ToStringFunctions {
+    private readonly functions;
+    private constructor();
+    static create(): ToStringFunctions;
+    private defaultToString;
+    /**
+     * 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.
+     */
+    toString(value: unknown): string;
+    add(toStringFunction: (value: unknown) => (string | undefined)): this;
+    add<T>(typeCheckFunction: (value: unknown) => value is T, typedToStringFunction: (value: T) => string): this;
+    private iterableToString;
+    private mapToString;
+    private setToString;
+}
+
+/**
+ * An object that can be iterated over.
+ */
+declare abstract class Iterable$1<T> implements JavascriptIterable<T> {
+    static create<T>(values?: JavascriptIterable<T>): Iterable$1<T>;
+    /**
+     * Iterate over the values in this {@link Iterable}.
+     */
+    abstract iterate(): Iterator$1<T>;
+    [Symbol.iterator](): JavascriptIterator<T>;
+    static [Symbol.iterator]<T>(iterable: Iterable$1<T>): JavascriptIterator<T>;
+    /**
+     * Get all of the values in this {@link Iterable} in an {@link Array}.
+     */
+    toArray(): SyncResult<T[]>;
+    /**
+     * Get all of the values in the provided {@link Iterable} in an {@link Array}.
+     */
+    static toArray<T>(iterable: Iterable$1<T>): SyncResult<T[]>;
+    /**
+     * Get whether this {@link Iterable} contains any values.
+     */
+    any(): SyncResult<boolean>;
+    /**
+     * Get whether the provided {@link JavascriptIterable} contains any values.
+     */
+    static any<T>(iterable: JavascriptIterable<T>): SyncResult<boolean>;
+    /**
+     * Get the number of values in this {@link Iterable}.
+     */
+    getCount(): SyncResult<number>;
+    /**
+     * Get the number of values in the provided {@link Iterable}.
+     */
+    static getCount<T>(iterable: Iterable$1<T>): SyncResult<number>;
+    /**
+     * Get whether this {@link Iterable} is equal to the provided {@link Iterable}.
+     * @param right The {@link Iterable} to compare against this {@link Iterable}.
+     * @param equalFunctions The optional {@link EqualFunctions} to use to determine if the two
+     * {@link Iterable}s are equal.
+     */
+    equals(right: JavascriptIterable<T>, equalFunctions?: EqualFunctions): SyncResult<boolean>;
+    static equals<T>(left: JavascriptIterable<T>, right: JavascriptIterable<T>, equalFunctions?: EqualFunctions): SyncResult<boolean>;
+    /**
+     * Get the {@link String} representation of this {@link Iterable}.
+     */
+    toString(toStringFunctions?: ToStringFunctions): string;
+    /**
+     * Get the {@link String} representation of the provided {@link Iterable}.
+     */
+    static toString<T>(iterable: Iterable$1<T>, toStringFunctions?: ToStringFunctions): string;
+    concatenate(...toConcatenate: JavascriptIterable<T>[]): Iterable$1<T>;
+    static concatenate<T>(iterable: Iterable$1<T>, ...toConcatenate: JavascriptIterable<T>[]): Iterable$1<T>;
+    /**
+     * Get a {@link MapIterable} that maps all of the {@link T} values in this {@link Iterable} to
+     * {@link TOutput} values.
+     * @param mapping The mapping function to use to convert values of type {@link T} to
+     * {@link TOutput}.
+     */
+    map<TOutput>(mapping: (value: T) => (TOutput | SyncResult<TOutput>)): Iterable$1<TOutput>;
+    /**
+     * Get a {@link MapIterable} that maps all of the {@link T} values in the provided
+     * {@link Iterable} to {@link TOutput} values.
+     * @param mapping The mapping function to use to convert values of type {@link T} to
+     * {@link TOutput}.
+     */
+    static map<TInput, TOutput>(iterable: Iterable$1<TInput>, mapping: (value: TInput) => (TOutput | SyncResult<TOutput>)): Iterable$1<TOutput>;
+    flatMap<TOutput>(mapping: (value: T) => JavascriptIterable<TOutput>): Iterable$1<TOutput>;
+    static flatMap<T, TOutput>(iterable: Iterable$1<T>, mapping: (value: T) => JavascriptIterable<TOutput>): Iterable$1<TOutput>;
+    /**
+     * Get an {@link Iterable} that contains values from this {@link Iterable} that match the
+     * provided condition.
+     * @param condition The condition to run against each of the values in this {@link Iterable}.
+     */
+    where(condition: (value: T) => (boolean | SyncResult<boolean>)): Iterable$1<T>;
+    /**
+     * Get an {@link Iterable} that contains values from the provided {@link Iterable} that match
+     * the provided condition.
+     * @param iterable The {@link Iterable} to get values from.
+     * @param condition The condition that the values must match to be contained in the new
+     * {@link Iterable}.
+     */
+    static where<T>(iterable: JavascriptIterable<T>, condition: (value: T) => (boolean | SyncResult<boolean>)): Iterable$1<T>;
+    /**
+     * Get an {@link Iterable} that contains values from this {@link Iterable} that match the
+     * provided {@link Type} or type check function.
+     * @param typeOrTypeCheck The {@link Type} or type check function that returned values must
+     * match.
+     */
+    instanceOf<TOutput extends T>(typeOrTypeCheck: Type<TOutput> | ((value: T) => value is TOutput)): Iterable$1<TOutput>;
+    /**
+     * Get an {@link Iterable} that contains values from the provided {@link Iterable} that match
+     * the provided {@link Type} or type check function.
+     * @param iterable The {@link Iterable} to get values from.
+     * @param typeOrTypeCheck The {@link Type} or type check function that returned values must
+     * match.
+     */
+    static instanceOf<TInput, TOutput extends TInput>(iterable: JavascriptIterable<TInput>, typeOrTypeCheck: Type<TOutput> | ((value: TInput) => value is TOutput)): Iterable$1<TOutput>;
+    /**
+     * Get the first value in this {@link Iterable}.
+     */
+    first(condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * Get the first value from the provided {@link JavascriptIterable}.
+     * @param iterable The {@link JavascriptIterable} to get the first value from.
+     */
+    static first<T>(iterable: JavascriptIterable<T>, condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * Get the last value in this {@link Iterable}.
+     */
+    last(condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * Get the last value from the provided {@link JavascriptIterable}.
+     * @param iterable The {@link JavascriptIterable} to get the last value from.
+     */
+    static last<T>(iterable: JavascriptIterable<T>, condition?: (value: T) => (boolean | SyncResult<boolean>)): SyncResult<T>;
+    /**
+     * Find the maximum value in the provided {@link Iterable}.
+     * @param iterable The values to find the maximum of.
+     */
+    static findMaximum<T extends Comparable<T>>(iterable: JavascriptIterable<T> | Iterable$1<T>): SyncResult<T>;
+    contains(value: T, equalFunctions?: EqualFunctions): SyncResult<boolean>;
+    static contains<T>(iterable: Iterable$1<T>, value: T, equalFunctions?: EqualFunctions): SyncResult<boolean>;
+}
+
+/**
+ * A {@link Type} that can be used to pass types as parameters.
+ */
+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.
+ */
+declare 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.
+ */
+declare function instanceOf<T>(value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T): value is T;
+/**
+ * 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.
+ */
+declare function instanceOfType<T>(value: unknown, type: Type<T>): value is T;
+/**
+ * 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}.
+ */
+declare function as<T>(value: unknown, typeOrTypeCheck: Type<T> | ((value: unknown) => value is T)): T | undefined;
+/**
+ * Get whether the provided value is undefined.
+ * @param value The value to check.
+ */
+declare function isUndefined(value: unknown): value is undefined;
+/**
+ * Get whether the provided value is null.
+ * @param value The value to check.
+ */
+declare function isNull(value: unknown): value is null;
+/**
+ * Return the provided value if it is null, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asNull(value: unknown): null | undefined;
+/**
+ * Get whether the provided value is undefined or null.
+ * @param value The value to check.
+ */
+declare function isUndefinedOrNull(value: unknown): value is undefined | null;
+/**
+ * Get whether the provided value is a {@link boolean}.
+ * @param value The value to check.
+ */
+declare function isBoolean(value: unknown): value is boolean;
+/**
+ * Return the provided value if it is a boolean, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asBoolean(value: unknown): boolean | undefined;
+/**
+ * Get whether the provided value is a {@link number}.
+ * @param value The value to check.
+ */
+declare function isNumber(value: unknown): value is number;
+/**
+ * Return the provided value if it is a number, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asNumber(value: unknown): number | undefined;
+/**
+ * Get whether the provided value is a {@link string}.
+ * @param value The value to check.
+ */
+declare function isString(value: unknown): value is string;
+/**
+ * Return the provided value if it is a string, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asString(value: unknown): string | undefined;
+/**
+ * Get whether the provided value is a {@link function}.
+ * @param value The value to check.
+ */
+declare function isFunction(value: unknown): value is Function;
+/**
+ * Return the provided value if it is a function, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asFunction(value: unknown): Function | undefined;
+/**
+ * Get the number of parameters that the provided {@link Function} takes.
+ * @param value The {@link Function} to get the parameter count for.
+ */
+declare function getParameterCount(value: Function): number;
+/**
+ * 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.
+ */
+declare function isFunctionWithParameterCount(value: unknown, parameterCount: number): value is Function;
+/**
+ * Return the provided value if it is a function with the provided {@link parameterCount}, otherwise
+ * return undefined.
+ * @param value The value to check.
+ */
+declare function asFunctionWithParameterCount(value: unknown, parameterCount: number): Function | undefined;
+/**
+ * Get whether the provided value is an {@link Array}.
+ * @param value The value to check.
+ */
+declare function isArray(value: unknown): value is unknown[];
+/**
+ * Return the provided value if it is an array, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asArray(value: unknown): unknown[] | undefined;
+/**
+ * Get whether the provided value is an {@link Object} or is null.
+ * @param value The value to check.
+ */
+declare function isObjectOrArrayOrNull(value: unknown): value is {} | unknown[] | null;
+/**
+ * Return the provided value if it is an array, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asObjectOrArrayOrNull(value: unknown): {} | unknown[] | null | undefined;
+/**
+ * Get whether the provided value is an {@link Object}.
+ * @param value The value to check.
+ * @returns
+ */
+declare function isObject(value: unknown): value is {};
+/**
+ * Return the provided value if it is an {@link Object}, otherwise return undefined.
+ * @param value The value to check.
+ */
+declare function asObject(value: unknown): {} | undefined;
+/**
+ * Get an {@link Iterator} that can be used to iterate through the properties of the provided value.
+ * @param value The value to iterate over.
+ */
+declare function getPropertyNames(value: {}): Iterable$1<string>;
+/**
+ * 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.
+ */
+declare function hasProperty<TValue, TPropertyKey extends PropertyKey>(value: TValue, propertyKey: TPropertyKey): value is TValue & Record<TPropertyKey, unknown>;
+/**
+ * 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.
+ */
+declare function hasFunction<TValue, TPropertyKey extends PropertyKey>(value: TValue, functionName: TPropertyKey, parameterCount?: number): value is TValue & Record<TPropertyKey, Function>;
+/**
+ * Get whether the provided value is a {@link JavascriptIterator}.
+ * @param value The value to check.
+ */
+declare function isJavascriptIterator<T>(value: unknown): value is JavascriptIterator<T>;
+/**
+ * Get whether the provided value is a {@link JavascriptIterable}.
+ * @param value The value to check.
+ */
+declare function isJavascriptIterable<T>(value: unknown): value is JavascriptIterable<T>;
+declare function isIterable<T>(value: unknown): value is Iterable$1<T>;
+/**
+ * Get whether the provided value is a {@link JavascriptAsyncIterator}.
+ * @param value The value to check.
+ */
+declare function isJavascriptAsyncIterator<T>(value: unknown): value is JavascriptAsyncIterator<T>;
+/**
+ * Get whether the provided value is a {@link JavascriptAsyncIterable}.
+ * @param value The value to check.
+ */
+declare function isJavascriptAsyncIterable<T>(value: unknown): value is JavascriptAsyncIterable<T>;
+declare function isAsyncIterable<T>(value: unknown): value is AsyncIterable<T>;
+/**
+ * Get the name of the provided {@link Type}.
+ * @param type The {@link Type} to get the name of.
+ */
+declare function getName(type: Type<unknown>): string;
+declare function isPromiseLike<T>(value: unknown): value is PromiseLike<T>;
+declare function isPromise<T>(value: unknown): value is Promise<T>;
+
+/**
+ * A result object that adds extra behavior beyond the standard {@link Promise}.
+ */
+declare abstract class AsyncResult<T> implements Promise<T> {
+    static create<T>(actionOrPromise: (() => (T | Promise<T>)) | Promise<T>): AsyncResult<T>;
+    /**
+     * Get an {@link AsyncResult} that is already completed and doesn't do anything.
+     */
+    static empty(): AsyncResult<void>;
+    /**
+     * Create a new {@link AsyncResult} that contains the provided value.
+     * @param value The value to wrap in a {@link AsyncResult}.
+     */
+    static value<T>(value: T): AsyncResult<T>;
+    /**
+     * Create a new {@link AsyncResult} that contains the provided error.
+     * @param error The error to wrap in a {@link AsyncResult}.
+     */
+    static error<T>(error: Error): AsyncResult<T>;
+    static yield(): AsyncResult<void>;
+    /**
+     * 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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    abstract convertError<TError>(errorType: Type<TError>, convertErrorFunction: (reason: TError) => (unknown | PromiseLike<unknown>)): AsyncResult<T>;
+    abstract finally(onfinally?: (() => (void | Promise<void>)) | null): AsyncResult<T>;
+    readonly abstract [Symbol.toStringTag]: string;
+}
+
+declare abstract class CharacterWriteStream {
+    /**
+     * Write the provided text to this {@link CharacterWriteStream}.
+     * @param text The text to write.
+     * @returns The number of characters that were written.
+     */
+    abstract writeString(text: string): AsyncResult<number>;
+    /**
+     * Write the provided text (if provided) and then write a newline character sequence to this
+     * {@link CharacterWriteStream}.
+     * @param text The optional text to write before the newline character sequence.
+     * @returns The number of characters that were written.
+     */
+    writeLine(text?: string): AsyncResult<number>;
+    static writeLine(writeStream: CharacterWriteStream, text?: string): AsyncResult<number>;
+}
+
+export { isUndefined as $, AsyncResult as A, instanceOf as B, CharacterWriteStream as C, instanceOfType as D, EqualFunctions as E, isArray as F, isAsyncIterable as G, isBoolean as H, Iterable$1 as I, type JavascriptArray as J, isFunction as K, isFunctionWithParameterCount as L, isIterable as M, isJavascriptAsyncIterable as N, isJavascriptAsyncIterator as O, PromiseAsyncResult as P, isJavascriptIterable as Q, isJavascriptIterator as R, SyncResult as S, ToStringFunctions as T, isNull as U, isNumber as V, isObject as W, isObjectOrArrayOrNull as X, isPromise as Y, isPromiseLike as Z, isString as _, Comparable as a, isUndefinedOrNull as a0, Comparison as b, Iterator$1 as c, type JavascriptAsyncIterable as d, type JavascriptAsyncIterator as e, type JavascriptIterable as f, type JavascriptIterator as g, type JavascriptIteratorResult as h, JavascriptMap as i, JavascriptSet as j, type Type as k, as as l, asArray as m, asBoolean as n, asFunction as o, asFunctionWithParameterCount as p, asNull as q, asNumber as r, asObject as s, asObjectOrArrayOrNull as t, asString as u, getName as v, getParameterCount as w, getPropertyNames as x, hasFunction as y, hasProperty as z };