@oscarpalmer/atoms 0.193.0 → 0.194.0

package/src/models.ts

@@ -1,286 +0,0 @@
-// #region Types
-
-/**
- * A generic array or object
- */
-export type ArrayOrPlainObject = unknown[] | Record<PropertyKey, unknown>;
-
-/**
- * An asynchronous callback that can be canceled
- */
-export type AsyncCancelableCallback<Callback extends GenericAsyncCallback | GenericCallback> =
-	(ReturnType<Callback> extends Promise<any>
-		? (...args: Parameters<Callback>) => Promise<Awaited<ReturnType<Callback>>>
-		: (...args: Parameters<Callback>) => Promise<ReturnType<Callback>>) & {
-		/**
-		 * Cancel the callback
-		 */
-		cancel: () => void;
-	};
-
-/**
- * For matching any `void`, `Date`, primitive, or `RegExp` values
- *
- * _(Thanks, type-fest!)_
- */
-export type BuiltIns = void | Date | Primitive | RegExp;
-
-/**
- * A synchronous callback that can be canceled
- */
-export type CancelableCallback<Callback extends GenericCallback> = Callback & {
-	/**
-	 * Cancel the callback
-	 */
-	cancel: () => void;
-};
-
-/**
- * A generic class constructor
- */
-export type Constructor<Instance = unknown> = new (...args: any[]) => Instance;
-
-/**
- * Position of an event
- */
-export type EventPosition = {
-	x: number;
-	y: number;
-};
-
-/**
- * A generic async callback function
- */
-export type GenericAsyncCallback = (...args: any[]) => Promise<any>;
-
-/**
- * A generic callback function
- */
-export type GenericCallback = (...args: any[]) => any;
-
-/**
- * A generic key type
- */
-export type Key = number | string;
-
-export type KeyedValue<Item, ItemKey extends keyof Item> = Item[ItemKey] extends PropertyKey
-	? Item[ItemKey]
-	: never;
-
-/**
- * A nested array
- */
-export type NestedArray<Value> =
-	Value extends Array<infer NestedValue> ? NestedArray<NestedValue> : Value;
-
-/**
- * All nested keys of an object as dot notation strings _(up to 5 levels deep)_
- */
-export type NestedKeys<Value extends PlainObject> = _NestedKeys<Value>;
-
-type _NestedKeys<Value, Depth extends number = 5> = Depth extends 0
-	? never
-	: Value extends readonly any[]
-		? Value extends readonly [any, ...any]
-			? // Tuple: extract actual indices
-				{
-					[ItemKey in keyof Value]-?: ItemKey extends `${number}`
-						? NonNullable<Value[ItemKey]> extends readonly any[] | PlainObject
-							?
-									| `${ItemKey}`
-									| `${ItemKey}.${_NestedKeys<NonNullable<Value[ItemKey]>, SubtractDepth<Depth>>}`
-							: `${ItemKey}`
-						: never;
-				}[number]
-			: // Array: use no indices
-				never
-		: Value extends PlainObject
-			? {
-					[ItemKey in keyof Value]-?: ItemKey extends number | string
-						? NonNullable<Value[ItemKey]> extends readonly any[] | PlainObject
-							?
-									| `${ItemKey}`
-									| `${ItemKey}.${_NestedKeys<NonNullable<Value[ItemKey]>, SubtractDepth<Depth>>}`
-							: `${ItemKey}`
-						: never;
-				}[keyof Value]
-			: never;
-
-/**
- * An extended version of `Partial` that allows for nested properties to be optional
- */
-export type NestedPartial<Value> = {
-	[ItemKey in keyof Value]?: Value[ItemKey] extends object
-		? NestedPartial<Value[ItemKey]>
-		: Value[ItemKey];
-};
-
-/**
- * The value for a nested key of an object
- */
-export type NestedValue<Value extends PlainObject, Path extends string> = _NestedValue<Value, Path>;
-
-type _NestedValue<Value, Path extends string> = Path extends `${infer ItemKey}.${infer Rest}`
-	? ItemKey extends keyof Value
-		? undefined extends Value[ItemKey]
-			? _NestedValue<Exclude<Value[ItemKey], undefined>, Rest> | undefined
-			: _NestedValue<Value[ItemKey], Rest>
-		: ItemKey extends `${number}`
-			? Value extends readonly any[]
-				? _NestedValue<Value[number], Rest>
-				: never
-			: never
-	: Path extends `${number}`
-		? Value extends readonly any[]
-			? Value[number]
-			: never
-		: Path extends keyof Value
-			? Value[Path]
-			: never;
-
-/**
- * The nested _(keyed)_ values of an object _(up to 5 levels deep)_
- */
-export type NestedValues<Value extends PlainObject> = {
-	[Path in NestedKeys<Value>]: NestedValue<Value, Path>;
-};
-
-/**
- * The numerical keys of an object
- */
-export type NumericalKeys<Value> = {
-	[ItemKey in keyof Value]: ItemKey extends number
-		? ItemKey
-		: ItemKey extends `${number}`
-			? ItemKey
-			: never;
-}[keyof Value];
-
-/**
- * The numerical values of an object
- */
-export type NumericalValues<Item extends PlainObject> = {
-	[ItemKey in keyof Item as Item[ItemKey] extends number ? ItemKey : never]: Item[ItemKey];
-};
-
-/**
- * An asynchronous function that can only be called once, returning the same value on subsequent calls
- */
-export type OnceAsyncCallback<Callback extends GenericAsyncCallback> = {
-	/**
-	 * Did the callback's promise reject?
-	 */
-	readonly error: boolean;
-	/**
-	 * Has the callback finished?
-	 */
-	readonly finished: boolean;
-} & Callback &
-	OnceCallbackProperties;
-
-/**
- * A callback function that can only be called once, returning the same value on subsequent calls
- */
-export type OnceCallback<Callback extends GenericCallback> = Callback & OnceCallbackProperties;
-
-type OnceCallbackProperties = {
-	/**
-	 * Has the callback been called?
-	 */
-	readonly called: boolean;
-	/**
-	 * Has the callback's value been cleared?
-	 */
-	readonly cleared: boolean;
-	/**
-	 * Clear the callback's cached value
-	 */
-	clear: () => void;
-};
-
-/**
- * A generic object
- */
-export type PlainObject = Record<PropertyKey, unknown>;
-
-/**
- * A primitive value
- *
- * _(Thanks, type-fest!)_
- */
-export type Primitive = null | undefined | string | number | boolean | symbol | bigint;
-
-/**
- * Set required keys for a type
- */
-export type RequiredKeys<Model extends object, Keys extends keyof Model> = Required<
-	Pick<Model, Keys>
-> &
-	Omit<Model, Keys>;
-
-/**
- * Flattens the type to improve type hints in IDEs
- *
- * _(Thanks, type-fest!)_
- */
-export type Simplify<Value> = {[ValueKey in keyof Value]: Value[ValueKey]} & {};
-
-type SubtractDepth<Value extends number> = Value extends 5
-	? 4
-	: Value extends 4
-		? 3
-		: Value extends 3
-			? 2
-			: Value extends 2
-				? 1
-				: Value extends 1
-					? 0
-					: never;
-
-/**
- * Get the value's type as a string
- *
- * _(Thanks, type-fest!)_
- */
-export type ToString<Value> = Value extends string | number ? `${Value}` : never;
-
-/**
- * A union type of all typed arrays
- */
-export type TypedArray =
-	| Int8Array
-	| Uint8Array
-	| Uint8ClampedArray
-	| Int16Array
-	| Uint16Array
-	| Int32Array
-	| Uint32Array
-	| Float32Array
-	| Float64Array
-	| BigInt64Array
-	| BigUint64Array;
-
-/**
- * Converts a union type to an intersection type
- *
- * @example
- * ```typescript
- * type A = {a: string};
- * type B = {b: number};
- * type C = UnionToIntersection<A | B>; // => {a: string} & {b: number}
- * ```
- *
- * Thanks, type-fest!
- */
-export type UnionToIntersection<Union> = (
-	Union extends unknown ? (distributedUnion: Union) => void : never
-) extends (mergedIntersection: infer Intersection) => void
-	? Intersection & Union
-	: never;
-
-/**
- * A function that unsubscribes from a subscription
- */
-export type Unsubscriber = () => void;
-
-// #endregion

package/src/number.ts

@@ -1 +0,0 @@
-export {between, clamp, getNumber} from './internal/number';

package/src/promise/delay.ts

@@ -1,62 +0,0 @@
-import {getTimer, TIMER_WAIT} from '../internal/function/timer';
-import {getPromiseOptions} from './helpers';
-import {settlePromise} from './misc';
-import {PROMISE_ABORT_OPTIONS, PROMISE_ABORT_EVENT, type PromiseOptions} from './models';
-
-// #region Functions
-
-/**
- * Create a delayed promise that resolves after a certain amount of time, or rejects if aborted
- *
- * @param options Options for the delay
- * @returns Delayed promise
- */
-export function delay(options?: PromiseOptions): Promise<void>;
-
-/**
- * Create a delayed promise that resolves after a certain amount of time
- *
- * @param time How long to wait for _(in milliseconds; defaults to `0`)_
- * @returns Delayed promise
- */
-export function delay(time?: number): Promise<void>;
-
-export function delay(options?: unknown): Promise<void> {
-	const {signal, time} = getPromiseOptions(options);
-
-	if (signal?.aborted ?? false) {
-		return Promise.reject(signal!.reason);
-	}
-
-	function abort(): void {
-		timer.cancel();
-
-		rejector(signal!.reason);
-	}
-
-	const timer = getTimer(
-		TIMER_WAIT,
-		() => {
-			settlePromise(abort, resolver, undefined, signal);
-		},
-		time,
-	);
-
-	signal?.addEventListener(PROMISE_ABORT_EVENT, abort, PROMISE_ABORT_OPTIONS);
-
-	let rejector: (reason: unknown) => void;
-	let resolver: () => void;
-
-	return new Promise((resolve, reject) => {
-		rejector = reject;
-		resolver = resolve;
-
-		if (time === 0) {
-			settlePromise(abort, resolve, undefined, signal);
-		} else {
-			timer();
-		}
-	});
-}
-
-// #endregion

package/src/promise/helpers.ts

@@ -1,96 +0,0 @@
-import {getNumberOrDefault} from '../internal/number';
-import type {RequiredKeys} from '../models';
-import {error, ok} from '../result/misc';
-import type {Result} from '../result/models';
-import {
-	PROMISE_STRATEGY_ALL,
-	PROMISE_STRATEGY_DEFAULT,
-	PROMISE_TYPE_FULFILLED,
-	PROMISE_TYPE_REJECTED,
-	type FulfilledPromise,
-	type PromiseOptions,
-	type PromisesOptions,
-	type PromiseStrategy,
-	type PromisesValue,
-	type RejectedPromise,
-} from './models';
-
-// #region Functions
-
-export function getPromiseOptions(input: unknown): RequiredKeys<PromiseOptions, 'time'> {
-	if (typeof input === 'number') {
-		return {
-			time: getNumberOrDefault(input, 0),
-		};
-	}
-
-	if (input instanceof AbortSignal) {
-		return {signal: input, time: 0};
-	}
-
-	const options = typeof input === 'object' && input !== null ? (input as PromiseOptions) : {};
-
-	return {
-		signal: options.signal instanceof AbortSignal ? options.signal : undefined,
-		time: getNumberOrDefault(options.time, 0),
-	};
-}
-
-export function getPromisesOptions(input: unknown): RequiredKeys<PromisesOptions, 'strategy'> {
-	if (typeof input === 'string') {
-		return {
-			strategy: getStrategyOrDefault(input),
-		};
-	}
-
-	if (input instanceof AbortSignal) {
-		return {signal: input, strategy: PROMISE_STRATEGY_DEFAULT};
-	}
-
-	const options = typeof input === 'object' && input !== null ? (input as PromisesOptions) : {};
-
-	return {
-		signal: options.signal instanceof AbortSignal ? options.signal : undefined,
-		strategy: getStrategyOrDefault(options.strategy),
-	};
-}
-
-export function getResultsFromPromises<Value>(promised: PromisesValue<Value>[]): Result<Value>[] {
-	return promised.map(result =>
-		isFulfilled(result) ? ok(result.value) : error(result.reason),
-	) as Result<Value>[];
-}
-
-export function getStrategyOrDefault(value: unknown): PromiseStrategy {
-	return PROMISE_STRATEGY_ALL.has(value as PromiseStrategy)
-		? (value as PromiseStrategy)
-		: PROMISE_STRATEGY_DEFAULT;
-}
-
-/**
- * Is the value a fulfilled _Promise_ result?
- *
- * @param value Value to check
- * @returns `true` if the value is a fulfilled _Promise_ result, otherwise `false`
- */
-export function isFulfilled<Value>(value: unknown): value is FulfilledPromise<Value> {
-	return isType(value, PROMISE_TYPE_FULFILLED);
-}
-
-/**
- * Is the value a rejected _Promise_ result?
- *
- * @param value Value to check
- * @returns `true` if the value is a rejected _Promise_ result, otherwise `false`
- */
-export function isRejected(value: unknown): value is RejectedPromise {
-	return isType(value, PROMISE_TYPE_REJECTED);
-}
-
-function isType(value: unknown, type: string): boolean {
-	return (
-		typeof value === 'object' && value !== null && (value as PromisesValue<unknown>).status === type
-	);
-}
-
-// #endregion