@oscarpalmer/atoms 0.193.0 → 0.193.1

package/src/result/work/pipe.ts

@@ -1,496 +0,0 @@
-import {asyncPipe, pipe} from '../../function/work';
-import {isError, isOk} from '../../internal/result';
-import type {GenericCallback} from '../../models';
-import {attempt} from '../index';
-import type {Result, UnwrapValue} from '../models';
-
-// #region Types
-
-type WrapValue<Value> = Result<UnwrapValue<Value>>;
-
-// #endregion
-
-// #region Functions
-
-// #region Asynchronous
-
-/**
- * Attempt to pipe a value through a function
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, Piped>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	pipe: (value: UnwrapValue<Initial>) => Piped,
-): Promise<WrapValue<Piped>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, First, Second>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-): Promise<WrapValue<Second>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, First, Second, Third>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-): Promise<WrapValue<Third>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-): Promise<WrapValue<Fourth>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-): Promise<WrapValue<Fifth>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-): Promise<WrapValue<Sixth>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
->(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-): Promise<WrapValue<Seventh>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
-	Eighth,
->(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-): Promise<WrapValue<Eighth>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
-	Eighth,
-	Ninth,
->(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-	ninth: (value: UnwrapValue<Eighth>) => Ninth,
-): Promise<WrapValue<Ninth>>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
-	Eighth,
-	Ninth,
-	Tenth,
->(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-	ninth: (value: UnwrapValue<Eighth>) => Ninth,
-	tenth: (value: UnwrapValue<Ninth>) => Tenth,
-): Promise<WrapValue<Tenth>>;
-
-/**
- * Attempt to pipe a result through a series of functions
- *
- * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
- *
- * @param initial Initial result
- * @returns _Piped_ result
- */
-export async function attemptAsyncPipe<Initial>(
-	initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>,
-	first?: (value: UnwrapValue<Initial>) => unknown,
-	...seconds: Array<(value: unknown) => unknown>
-): Promise<WrapValue<Initial>>;
-
-export async function attemptAsyncPipe(
-	initial: unknown,
-	first?: (value: unknown) => unknown,
-	...seconds: Array<(value: unknown) => unknown>
-): Promise<Result<unknown>> {
-	return attempt.async(() => {
-		if (isError(initial)) {
-			throw initial.error;
-		}
-
-		const value =
-			typeof initial === 'function'
-				? (initial as Function)()
-				: isOk(initial)
-					? initial.value
-					: initial;
-
-		if (first == null) {
-			return value;
-		}
-
-		return asyncPipe(value, ...([first, ...seconds] as GenericCallback[]));
-	});
-}
-
-// #endregion
-
-// #region Synchronous
-
-/**
- * Attempt to pipe a value through a function
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, Pipe>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	pipe: (value: UnwrapValue<Initial>) => Pipe,
-): WrapValue<Pipe>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-): WrapValue<Second>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-): WrapValue<Third>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third, Fourth>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-): WrapValue<Fourth>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-): WrapValue<Fifth>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-): WrapValue<Sixth>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-): WrapValue<Seventh>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-): WrapValue<Eighth>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
-	Eighth,
-	Ninth,
->(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-	ninth: (value: UnwrapValue<Eighth>) => Ninth,
-): WrapValue<Ninth>;
-
-/**
- * Attempt to pipe a value through a series of functions
- *
- * @param initial Initial value
- * @returns _Piped_ result
- */
-export function attemptPipe<
-	Initial,
-	First,
-	Second,
-	Third,
-	Fourth,
-	Fifth,
-	Sixth,
-	Seventh,
-	Eighth,
-	Ninth,
-	Tenth,
->(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first: (value: UnwrapValue<Initial>) => First,
-	second: (value: UnwrapValue<First>) => Second,
-	third: (value: UnwrapValue<Second>) => Third,
-	fourth: (value: UnwrapValue<Third>) => Fourth,
-	fifth: (value: UnwrapValue<Fourth>) => Fifth,
-	sixth: (value: UnwrapValue<Fifth>) => Sixth,
-	seventh: (value: UnwrapValue<Sixth>) => Seventh,
-	eighth: (value: UnwrapValue<Seventh>) => Eighth,
-	ninth: (value: UnwrapValue<Eighth>) => Ninth,
-	tenth: (value: UnwrapValue<Ninth>) => Tenth,
-): WrapValue<Tenth>;
-
-/**
- * Attempt to pipe a result through a series of functions
- *
- * @param initial Initial result
- * @returns _Piped_ result
- */
-export function attemptPipe<Initial>(
-	initial: GenericCallback | Initial | Result<Initial>,
-	first?: (value: UnwrapValue<Initial>) => unknown,
-	...seconds: Array<(value: unknown) => unknown>
-): WrapValue<Initial>;
-
-export function attemptPipe(
-	initial: unknown,
-	first?: (value: unknown) => unknown,
-	...seconds: Array<(value: unknown) => unknown>
-): WrapValue<unknown> {
-	return attempt(() => {
-		if (isError(initial)) {
-			throw initial.error;
-		}
-
-		const value =
-			typeof initial === 'function'
-				? (initial as Function)()
-				: isOk(initial)
-					? initial.value
-					: initial;
-
-		if (first == null) {
-			return value;
-		}
-
-		return pipe(value, ...([first, ...seconds] as GenericCallback[]));
-	});
-}
-
-attemptPipe.async = attemptAsyncPipe;
-
-// #endregion
-
-// #endregion

package/src/sized/map.ts

@@ -1,110 +0,0 @@
-import {getSizedMaximum} from '../internal/sized';
-
-// #region Types and classes
-
-/**
- * A _Map_ with a maximum size
- *
- * Behavior is similar to a _LRU_ cache, where the least recently used entries are removed
- */
-export class SizedMap<SizedKey = unknown, SizedValue = unknown> extends Map<SizedKey, SizedValue> {
-	/**
-	 * The maximum size of the _Map_
-	 */
-	readonly #maximumSize: number;
-
-	/**
-	 * Is the _Map_ full?
-	 */
-	get full(): boolean {
-		return super.size >= this.#maximumSize;
-	}
-
-	get maximum(): number {
-		return this.#maximumSize;
-	}
-
-	/**
-	 * Create a new _SizedMap_ with entries and a maximum size _(2^20)_
-	 *
-	 * @param entries Array of key-value pairs to initialize the _SizedMap_ with
-	 * @template SizedKey Type of the keys in the _SizedMap_
-	 * @template SizedValue Type of the values in the _SizedMap_
-	 */
-	constructor(entries: [SizedKey, SizedValue][]);
-
-	/**
-	 * Create a new _SizedMap_ with a maximum size _(but clamped at 2^24)_
-	 *
-	 * @param maximum Maximum size of the _SizedMap_
-	 * @template SizedKey Type of the keys in the _SizedMap_
-	 * @template SizedValue Type of the values in the _SizedMap_
-	 */
-	constructor(maximum: number);
-
-	/**
-	 * Create a new _SizedMap_ with _(optional)_ entries and a maximum size
-	 *
-	 * @param entries Array of key-value pairs to initialize the _SizedMap_ with
-	 * @param maximum Maximum size of the _SizedMap_ _(defaults to 2^20; clamped at 2^24)_
-	 * @template SizedKey Type of the keys in the _SizedMap_
-	 * @template SizedValue Type of the values in the _SizedMap_
-	 */
-	constructor(entries?: [SizedKey, SizedValue][], maximum?: number);
-
-	constructor(first?: [SizedKey, SizedValue][] | number, second?: number) {
-		const maximum = getSizedMaximum(first, second);
-
-		super();
-
-		this.#maximumSize = maximum;
-
-		if (Array.isArray(first)) {
-			const {length} = first;
-
-			if (length <= maximum) {
-				for (let index = 0; index < length; index += 1) {
-					this.set(...first[index]);
-				}
-			} else {
-				for (let index = 0; index < maximum; index += 1) {
-					this.set(...first[length - maximum + index]);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	override get(key: SizedKey): SizedValue | undefined {
-		if (super.has(key)) {
-			const value = super.get(key) as SizedValue;
-
-			this.#setValue(key, value, true);
-
-			return value;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	override set(key: SizedKey, value: SizedValue): this {
-		return this.#setValue(key, value, super.has(key));
-	}
-
-	#setValue(key: SizedKey, value: SizedValue, has: boolean): this {
-		if (has) {
-			super.delete(key);
-		} else if (super.size >= this.#maximumSize) {
-			super.delete(super.keys().next().value as SizedKey);
-		}
-
-		super.set(key, value);
-
-		return this;
-	}
-}
-
-// #endregion

package/src/sized/set.ts

@@ -1,107 +0,0 @@
-import {getSizedMaximum} from '../internal/sized';
-
-// #region Types
-
-/**
- * A _Set_ with a maximum size
- *
- * Behavior is similar to a _LRU_ cache, where the oldest values are removed
- */
-export class SizedSet<Value = unknown> extends Set<Value> {
-	/**
-	 * The maximum size of the _Set_
-	 */
-	readonly #maximumSize: number;
-
-	/**
-	 * Is the _Set_ full?
-	 */
-	get full(): boolean {
-		return this.size >= this.#maximumSize;
-	}
-
-	get maximum(): number {
-		return this.#maximumSize;
-	}
-
-	/**
-	 * Create a new _SizedSet_ with values and a maximum size _(2^20)_
-	 *
-	 * @param values Array of values to initialize the _SizedSet_ with
-	 * @template Value Type of the values in the _SizedSet_
-	 */
-	constructor(values: Value[]);
-
-	/**
-	 * Create a new _SizedSet_ with a maximum size _(but clamped at 2^24)_
-	 *
-	 * @param maximum Maximum size of the _SizedSet_ _(defaults to 2^20; clamped at 2^24)_
-	 * @template Value Type of the values in the _SizedSet_
-	 */
-	constructor(maximum: number);
-
-	/**
-	 * Create a new _SizedSet_ with _(optional)_ values and a maximum size
-	 *
-	 * @param values Array of values to initialize the _SizedSet_ with
-	 * @param maximum Maximum size of the _SizedSet_ _(defaults to 2^20; clamped at 2^24)_
-	 * @template Value Type of the values in the _SizedSet_
-	 */
-	constructor(values?: Value[], maximum?: number);
-
-	constructor(first?: Value[] | number, second?: number) {
-		const maximum = getSizedMaximum(first, second);
-
-		super();
-
-		this.#maximumSize = maximum;
-
-		if (Array.isArray(first)) {
-			const {length} = first;
-
-			if (length <= maximum) {
-				for (let index = 0; index < length; index += 1) {
-					this.add(first[index]);
-				}
-			} else {
-				for (let index = 0; index < maximum; index += 1) {
-					this.add(first[length - maximum + index]);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	override add(value: Value): this {
-		if (super.has(value)) {
-			super.delete(value);
-		} else if (this.size >= this.#maximumSize) {
-			super.delete(this.values().next().value as Value);
-		}
-
-		return super.add(value);
-	}
-
-	/**
-	 * Get a value from the _SizedSet_, if it exists _(and optionally move it to the end)_
-	 *
-	 * @param value Value to get from the _SizedSet_
-	 * @param update Update the value's position in the _SizedSet_? _(defaults to `false`)_
-	 * @returns Found value if it exists, otherwise `undefined`
-	 */
-	get(value: Value, update?: boolean): Value | undefined {
-		if (super.has(value)) {
-			if (update ?? false) {
-				super.delete(value);
-
-				this.add(value);
-			}
-
-			return value;
-		}
-	}
-}
-
-// #endregion