@oscarpalmer/atoms 0.192.0 → 0.193.1

package/src/internal/is.ts

@@ -1,244 +0,0 @@
-import type {
-	ArrayOrPlainObject,
-	Constructor,
-	Key,
-	PlainObject,
-	Primitive,
-	TypedArray,
-} from '../models';
-
-// #region Functions
-
-/**
- * Is the value an array or a plain object?
- *
- * @param value Value to check
- * @returns `true` if the value is an array or a plain object, otherwise `false`
- */
-export function isArrayOrPlainObject(value: unknown): value is ArrayOrPlainObject {
-	return Array.isArray(value) || isPlainObject(value);
-}
-
-/**
- * Is the value a constructor function?
- *
- * @param value Value to check
- * @returns `true` if the value is a constructor function, otherwise `false`
- */
-export function isConstructor(value: unknown): value is Constructor {
-	return typeof value === 'function' && value.prototype?.constructor === value;
-}
-
-/**
- * Is the value an instance of the constructor?
- *
- * @param constructor Class constructor
- * @param value Value to check
- * @returns `true` if the value is an instance of the constructor, otherwise `false`
- */
-export function isInstanceOf<Instance>(
-	constructor: Constructor<Instance>,
-	value: unknown,
-): value is Instance {
-	return isConstructor(constructor) && value instanceof constructor;
-}
-
-/**
- * Is the value a _Key_?
- *
- * @param value Value to check
- * @returns `true` if the value is a _Key_ _(`number` or `string`)_, otherwise `false`
- */
-export function isKey(value: unknown): value is Key {
-	return typeof value === 'number' || typeof value === 'string';
-}
-
-/**
- * Is the value not an array or a plain object?
- *
- * @param value Value to check
- * @returns `true` if the value is not an array or a plain object, otherwise `false`
- */
-export function isNonArrayOrPlainObject<Value>(
-	value: Value,
-): value is Exclude<Value, ArrayOrPlainObject> {
-	return !isArrayOrPlainObject(value);
-}
-
-/**
- * Is the value not a constructor function?
- *
- * @param value Value to check
- * @returns `true` if the value is not a constructor function, otherwise `false`
- */
-export function isNonConstructor<Value>(value: Value): value is Exclude<Value, Constructor> {
-	return !isConstructor(value);
-}
-
-/**
- * Is the value not an instance of the constructor?
- *
- * @param constructor Class constructor
- * @param value Value to check
- * @returns `true` if the value is not an instance of the constructor, otherwise `false`
- */
-export function isNonInstanceOf<Instance, Value>(
-	constructor: Constructor<Instance>,
-	value: Value,
-): value is Exclude<Value, Instance> {
-	return !isInstanceOf(constructor, value);
-}
-
-/**
- * Is the value not a _Key_?
- *
- * @param value Value to check
- * @returns `true` if the value is not a _Key_ _(`number` or `string`)_, otherwise `false`
- */
-export function isNonKey<Value>(value: Value): value is Exclude<Value, Key> {
-	return !isKey(value);
-}
-
-/**
- * Is the value not a number?
- *
- * @param value Value to check
- * @returns `true` if the value is not a `number`, otherwise `false`
- */
-export function isNonNumber<Value>(value: Value): value is Exclude<Value, number> {
-	return !isNumber(value);
-}
-
-/**
- * Is the value not a plain object?
- *
- * @param value Value to check
- * @returns `true` if the value is not a plain object, otherwise `false`
- */
-export function isNonPlainObject<Value>(value: Value): value is Exclude<Value, PlainObject> {
-	return !isPlainObject(value);
-}
-
-/**
- * Is the value not a primitive value?
- *
- * @param value Value to check
- * @returns `true` if the value is not a primitive value, otherwise `false`
- */
-export function isNonPrimitive<Value>(value: Value): value is Exclude<Value, Primitive> {
-	return !isPrimitive(value);
-}
-
-/**
- * Is the value not a template strings array?
- *
- * @param value Value to check
- * @returns `true` if the value is not a `TemplateStringsArray`, otherwise `false`
- */
-export function isNonTemplateStringsArray<Value>(
-	value: Value,
-): value is Exclude<Value, TemplateStringsArray> {
-	return !isTemplateStringsArray(value);
-}
-
-/**
- * Is the value not a typed array?
- *
- * @param value Value to check
- * @returns `true` if the value is not a typed array, otherwise `false`
- */
-export function isNonTypedArray<Value>(value: Value): value is Exclude<Value, TypedArray> {
-	return !isTypedArray(value);
-}
-
-/**
- * Is the value a number?
- *
- * @param value Value to check
- * @returns `true` if the value is a `number`, otherwise `false`
- */
-export function isNumber(value: unknown): value is number {
-	return typeof value === 'number' && !Number.isNaN(value);
-}
-
-/**
- * Is the value a plain object?
- *
- * @param value Value to check
- * @returns `true` if the value is a plain object, otherwise `false`
- */
-export function isPlainObject(value: unknown): value is PlainObject {
-	if (value === null || typeof value !== 'object') {
-		return false;
-	}
-
-	if (Symbol.toStringTag in value || Symbol.iterator in value) {
-		return false;
-	}
-
-	const prototype = Object.getPrototypeOf(value);
-
-	return (
-		prototype === null ||
-		prototype === Object.prototype ||
-		Object.getPrototypeOf(prototype) === null
-	);
-}
-
-/**
- * Is the value a primitive value?
- *
- * @param value Value to check
- * @returns `true` if the value is a primitive value, otherwise `false`
- */
-export function isPrimitive(value: unknown): value is Primitive {
-	if (value == null) {
-		return true;
-	}
-
-	const type = typeof value;
-
-	return (
-		type === 'bigint' ||
-		type === 'boolean' ||
-		type === 'number' ||
-		type === 'string' ||
-		type === 'symbol'
-	);
-}
-
-/**
- * Is the value a template strings array?
- *
- * @param value Value to check
- * @returns `true` if the value is a `TemplateStringsArray`, otherwise `false`
- */
-export function isTemplateStringsArray(value: unknown): value is TemplateStringsArray {
-	return Array.isArray(value) && Array.isArray((value as unknown as TemplateStringsArray).raw);
-}
-
-/**
- * Is the value a typed array?
- *
- * @param value Value to check
- * @returns `true` if the value is a typed array, otherwise `false`
- */
-export function isTypedArray(value: unknown): value is TypedArray {
-	(isTypedArray as any).types ??= new Set<unknown>([
-		Int8Array,
-		Uint8Array,
-		Uint8ClampedArray,
-		Int16Array,
-		Uint16Array,
-		Int32Array,
-		Uint32Array,
-		Float32Array,
-		Float64Array,
-		BigInt64Array,
-		BigUint64Array,
-	]);
-
-	return (isTypedArray as any).types.has((value as TypedArray)?.constructor);
-}
-
-// #endregion

package/src/internal/math/aggregate.ts

@@ -1,164 +0,0 @@
-import type {NumericalValues, PlainObject} from '../../models';
-import {isNonNumber} from '../is';
-
-// #region Types
-
-type Aggregation = {
-	count: number;
-	value: number;
-};
-
-type AggregationCallback = (current: number, value: number, notNumber: boolean) => number;
-
-export type AggregationType = 'average' | 'max' | 'min' | 'sum';
-
-type NonAverageAggregationType = 'max' | 'min' | 'sum';
-
-// #endregion
-
-// #region Functions
-
-export function aggregate(type: AggregationType, array: unknown[], key: unknown): Aggregation {
-	const length = Array.isArray(array) ? array.length : 0;
-
-	if (length === 0) {
-		return {
-			count: 0,
-			value: Number.NaN,
-		};
-	}
-
-	const aggregator = aggregators[type];
-	const callback = getAggregateCallback(key);
-
-	let counted = 0;
-	let aggregated = Number.NaN;
-	let notNumber = true;
-
-	for (let index = 0; index < length; index += 1) {
-		const item = array[index];
-
-		const value = callback == null ? item : callback(item as never, index, array);
-
-		if (isNonNumber(value)) {
-			continue;
-		}
-
-		aggregated = aggregator(aggregated, value, notNumber);
-
-		counted += 1;
-		notNumber = false;
-	}
-
-	return {
-		count: counted,
-		value: aggregated,
-	};
-}
-
-export function getAggregateCallback(key: unknown): Function | undefined {
-	if (key == null) {
-		return;
-	}
-
-	return typeof key === 'function' ? key : (item: PlainObject): unknown => item[key as never];
-}
-
-/**
- * Get the maximum value from a list of items
- *
- * @example
- * ```typescript
- * max(
- *   [{id: 1, value: 10}, {id: 2, value: 20}],
- *   item => item.value,
- * ); // => 20
- *
- * max([], item => item.value); // => Number.NaN
- * ```
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @returns Maximum value, or `Number.NaN` if no maximum can be found
- */
-export function max<Item>(
-	items: Item[],
-	callback: (item: Item, index: number, array: Item[]) => number,
-): number;
-
-/**
- * Get the maximum value from a list of items
- *
- * @example
- * ```typescript
- * max(
- *   [{id: 1, value: 10}, {id: 2, value: 20}],
- *   'value',
- * ); // => 20
- *
- * max([], 'value'); // => Number.NaN
- * ```
- *
- * @param items List of items
- * @param key Key to use for value
- * @returns Maximum value, or `Number.NaN` if no maximum can be found
- */
-export function max<Item extends PlainObject, ItemKey extends keyof NumericalValues<Item>>(
-	items: Item[],
-	key: ItemKey,
-): number;
-
-/**
- * Get the maximum value from a list of numbers
- *
- * @example
- * ```typescript
- * max([10, 20]); // => 20
- * max([]);       // => Number.NaN
- * ```
- *
- * @param values List of numbers
- * @returns Maximum value, or `Number.NaN` if no maximum can be found
- */
-export function max(values: number[]): number;
-
-export function max(array: unknown[], key?: unknown): number {
-	return getAggregated(AGGREGATION_MAX as NonAverageAggregationType, array, key);
-}
-
-function calculateSum(current: number, value: number, notNumber: boolean): number {
-	return notNumber ? value : current + value;
-}
-
-export function getAggregated(
-	type: NonAverageAggregationType,
-	array: unknown[],
-	key?: unknown,
-): number {
-	const aggregated = aggregate(type, array, key);
-
-	return aggregated.count > 0 ? aggregated.value : Number.NaN;
-}
-
-// #endregion
-
-// #region Variables
-
-export const AGGREGATION_AVERAGE: AggregationType = 'average';
-
-export const AGGREGATION_MAX = 'max';
-
-export const AGGREGATION_MIN = 'min';
-
-export const AGGREGATION_SUM = 'sum';
-
-const aggregators: Record<AggregationType, AggregationCallback> = {
-	average: calculateSum,
-	max: (current: number, value: number, notNumber: boolean) =>
-		notNumber || value > current ? value : current,
-	min: (current: number, value: number, notNumber: boolean) =>
-		notNumber || value < current ? value : current,
-	sum: calculateSum,
-};
-
-// #endregion

package/src/internal/math/misc.ts

@@ -1,28 +0,0 @@
-/**
- * Round a number
- *
- * @param value Number to round
- * @param decimals Number of decimal places to round to _(defaults to `0`)_
- * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
- */
-export function round(value: number, decimals?: number): number {
-	return roundNumber(Math.round, value, decimals);
-}
-
-export function roundNumber(
-	callback: (value: number) => number,
-	value: number,
-	decimals?: number,
-): number {
-	if (typeof value !== 'number') {
-		return Number.NaN;
-	}
-
-	if (typeof decimals !== 'number' || decimals < 1) {
-		return callback(value);
-	}
-
-	const mod = 10 ** decimals;
-
-	return callback((value + Number.EPSILON) * mod) / mod;
-}

package/src/internal/number.ts

@@ -1,129 +0,0 @@
-import {isNumber} from './is';
-
-// #region Functions
-
-/**
- * Is the number between a minimum and maximum value?
- *
- * @param value Value to check
- * @param minimum Minimum value
- * @param maximum Maximum value
- * @returns `true` if the value is between the minimum and maximum, otherwise `false`
- */
-export function between(value: number, minimum: number, maximum: number): boolean {
-	if (![value, minimum, maximum].every(isNumber)) {
-		return false;
-	}
-
-	if (Object.is(minimum, maximum)) {
-		return Object.is(value, minimum);
-	}
-
-	const max = maximum > minimum ? maximum : minimum;
-	const min = maximum > minimum ? minimum : maximum;
-
-	return value >= min && value <= max;
-}
-
-/**
- * Clamp a number between a minimum and maximum value
- *
- * @param value Value to clamp
- * @param minimum Minimum value
- * @param maximum Maximum value
- * @param loop If `true`, the value will loop around when smaller than the minimum or larger than the maximum _(defaults to `false`)_
- * @returns Clamped value
- *
- * @example
- * ```typescript
- * clamp(10, 0, 5);       // => 5
- * clamp(10, 0, 5, true); // => 0
- * ```
- */
-export function clamp(value: number, minimum: number, maximum: number, loop?: boolean): number {
-	if (![value, minimum, maximum].every(isNumber)) {
-		return Number.NaN;
-	}
-
-	if (value < minimum) {
-		return loop === true ? maximum : minimum;
-	}
-
-	const next = loop === true ? minimum : maximum;
-
-	return value > maximum ? next : value;
-}
-
-/**
- * Get the number value from an unknown value
- *
- * _(Based on Lodash)_
- *
- * @param value Original value
- * @returns Original value as a number, or `Number.NaN` if the value is unable to be parsed
- */
-export function getNumber(value: unknown): number {
-	if (typeof value === 'number') {
-		return value;
-	}
-
-	if (typeof value === 'bigint' || typeof value === 'boolean') {
-		return Number(value);
-	}
-
-	if (value == null || typeof value === 'symbol') {
-		return Number.NaN;
-	}
-
-	if (typeof value === 'function') {
-		return getNumber(value());
-	}
-
-	let parsed = value.valueOf();
-
-	if (typeof parsed === 'object') {
-		parsed = parsed.toString();
-	}
-
-	if (typeof parsed !== 'string') {
-		return getNumber(parsed);
-	}
-
-	const trimmed = parsed.trim();
-
-	if (trimmed.length === 0) {
-		return Number.NaN;
-	}
-
-	if (EXPRESSION_ZEROISH.test(parsed)) {
-		return 0;
-	}
-
-	const isBinary = EXPRESSION_BINARY.test(trimmed);
-
-	if (isBinary || EXPRESSION_OCTAL.test(trimmed)) {
-		return Number.parseInt(trimmed.slice(2), isBinary ? 2 : OCTAL_VALUE);
-	}
-
-	return Number(trimmed);
-}
-
-export function getNumberOrDefault(value: unknown, defaultValue: number, minimum?: number): number {
-	return typeof value === 'number' && !Number.isNaN(value) && value >= (minimum ?? 0)
-		? Math.floor(value)
-		: defaultValue;
-}
-
-// #endregion
-
-// #region Variables
-
-const EXPRESSION_BINARY = /^0b[01]+$/i;
-
-const EXPRESSION_OCTAL = /^0o[0-7]+$/i;
-
-const EXPRESSION_ZEROISH = /^\s*0+\s*$/;
-
-const OCTAL_VALUE = 8;
-
-// #endregion

package/src/internal/random.ts

@@ -1,49 +0,0 @@
-import {isNumber} from './is';
-
-// #region Functions
-
-function getRandomFloatingNumberValue(
-	inclusive: boolean,
-	minimum?: number,
-	maximum?: number,
-): number {
-	let maxFloat =
-		isNumber(maximum) && maximum <= Number.MAX_SAFE_INTEGER ? maximum : Number.MAX_SAFE_INTEGER;
-
-	let minFloat =
-		isNumber(minimum) && minimum >= Number.MIN_SAFE_INTEGER ? minimum : Number.MIN_SAFE_INTEGER;
-
-	if (minFloat === maxFloat) {
-		return minFloat;
-	}
-
-	if (minFloat > maxFloat) {
-		[minFloat, maxFloat] = [maxFloat, minFloat];
-	}
-
-	return Math.random() * (maxFloat + (inclusive ? 1 : 0) - minFloat) + minFloat;
-}
-
-/**
- * Get a random floating-point number
- *
- * @param minimum Minimum value
- * @param maximum Maximum value
- * @returns Random floating-point number
- */
-export function getRandomFloatingNumber(minimum?: number, maximum?: number): number {
-	return getRandomFloatingNumberValue(false, minimum, maximum);
-}
-
-/**
- * Get a random integer
- *
- * @param minimum Minimum value
- * @param maximum Maximum value
- * @returns Random integer
- */
-export function getRandomInteger(minimum?: number, maximum?: number): number {
-	return Math.floor(getRandomFloatingNumberValue(true, minimum, maximum));
-}
-
-// #endregion

package/src/internal/result.ts

@@ -1,92 +0,0 @@
-import type {PlainObject} from '../models';
-import type {Err, ExtendedErr, Ok, Result} from '../result/models';
-import {isNonPlainObject} from './is';
-
-// #region Functions
-
-/**
- * Is the _Result_ an extended error?
- *
- * @param result _Result_ to check
- * @returns `true` if the _Result_ is an extended error, otherwise `false`
- */
-export function isError<Value, E = Error>(
-	result: ExtendedErr<E> | Result<Value, E>,
-	extended: true,
-): result is ExtendedErr<E>;
-
-/**
- * Is the _Result_ an error?
- *
- * @param result _Result_ to check
- * @returns `true` if the _Result_ is an error, otherwise `false`
- */
-export function isError<Value, E = Error>(result: Result<Value, E>): result is Err<E>;
-
-/**
- * Is the value an error?
- *
- * @param value Value to check
- * @returns `true` if the value is an error, otherwise `false`
- */
-export function isError(value: unknown): value is Err<unknown> | ExtendedErr<unknown>;
-
-export function isError(
-	value: unknown,
-	extended?: boolean,
-): value is Err<unknown> | ExtendedErr<unknown> {
-	return (
-		isResultValue(value, false) &&
-		(extended === true ? (value as ExtendedErr<unknown>).original instanceof Error : true)
-	);
-}
-
-/**
- * Is the _Result_ ok?
- *
- * @param value _Result_ to check
- * @returns `true` if the _Result_ is ok, otherwise `false`
- */
-export function isOk<Value, E = Error>(value: Result<Value, E>): value is Ok<Value>;
-
-/**
- * Is the value ok?
- *
- * @param value Value to check
- * @returns `true` if the value is ok, otherwise `false`
- */
-export function isOk(value: unknown): value is Ok<unknown>;
-
-export function isOk(value: unknown): value is Ok<unknown> {
-	return isResultValue(value, true);
-}
-
-/**
- * Is the value a _Result_?
- *
- * @param value Value to check
- * @returns `true` if the value is a _Result_, otherwise `false`
- */
-export function isResult(value: unknown): value is ExtendedErr<unknown> | Result<unknown, unknown> {
-	return isResultValue(value, true) || isResultValue(value, false);
-}
-
-function isResultValue(value: unknown, okValue: boolean): value is Result<unknown, unknown> {
-	if (isNonPlainObject(value)) {
-		return false;
-	}
-
-	return (
-		(value as PlainObject).ok === okValue && (okValue ? PROPERTY_VALUE : PROPERTY_ERROR) in value
-	);
-}
-
-// #endregion
-
-// #region Variable
-
-const PROPERTY_ERROR = 'error';
-
-const PROPERTY_VALUE = 'value';
-
-// #endregion