@oscarpalmer/atoms 0.193.0 → 0.193.1

package/src/logger.ts

@@ -1,230 +0,0 @@
-import {noop} from './internal/function/misc';
-
-// #region Types
-
-type Logger = {
-	/**
-	 * Log any number of values at the "debug" log level
-	 */
-	get debug(): typeof console.debug;
-
-	/**
-	 * Log the value and shows all its properties
-	 */
-	get dir(): typeof console.dir;
-
-	/**
-	 * Is logging to the console enabled? _(defaults to `true`)_
-	 */
-	get enabled(): boolean;
-
-	/**
-	 * Enable or disable logging to the console
-	 */
-	set enabled(value: boolean);
-
-	/**
-	 * Log any number of values at the "error" log level
-	 */
-	get error(): typeof console.error;
-
-	/**
-	 * Log any number of values at the "info" log level
-	 */
-	get info(): typeof console.info;
-
-	/**
-	 * Log any number of values at the "log" log level
-	 */
-	get log(): typeof console.log;
-
-	/**
-	 * Log data as a table, with optional properties to use as columns
-	 */
-	get table(): typeof console.table;
-
-	/**
-	 * Log any number of values together with a trace from where it was called
-	 */
-	get trace(): typeof console.trace;
-
-	/**
-	 * Log any number of values at the "warn" log level
-	 */
-	get warn(): typeof console.warn;
-
-	/**
-	 * Start a timed logger with a label
-	 *
-	 * @param label Label for the logger
-	 * @returns _TimedLogger_ instance
-	 */
-	time(label: string): TimedLogger;
-};
-
-/**
- * A named timer that can be used to log durations to the console
- */
-type TimedLogger = {
-	/**
-	 * Is the timer active? _(i.e. has it been started and not stopped, and is logging enabled?)_
-	 */
-	get active(): boolean;
-
-	/**
-	 * Log the current duration of the timer _(ignored if logging is disabled)_
-	 */
-	get log(): () => void;
-
-	/**
-	 * Stop the timer and logs the total duration
-	 *
-	 * _(Will always log the total duration, even if logging is disabled)_
-	 */
-	get stop(): () => void;
-};
-
-type TimeState = {
-	label: string;
-	started: boolean;
-	stopped: boolean;
-};
-
-// #endregion
-
-// #region Functions
-
-function isLogger(value: unknown): value is Logger {
-	return isLoggerInstance<Logger>(NAME_LOGGER, value);
-}
-
-function isLoggerInstance<Instance>(name: string, value: unknown): value is Instance {
-	return (
-		typeof value === 'object' &&
-		value !== null &&
-		(value as Record<string, unknown>)[KEY_LOGGER] === name
-	);
-}
-
-function isTimedLogger(value: unknown): value is TimedLogger {
-	return isLoggerInstance<TimedLogger>(NAME_TIMED, value);
-}
-
-function timedLogger(label: string): TimedLogger {
-	function stop() {
-		const fn = stopper;
-
-		state.stopped = true;
-
-		logger = undefined as never;
-		stopper = undefined as never;
-
-		return fn;
-	}
-
-	let logger = console.timeLog.bind(console, label);
-	let stopper = console.timeEnd.bind(console, label);
-
-	const state: TimeState = {
-		label,
-		started: enabled,
-		stopped: false,
-	};
-
-	const instance = {};
-
-	Object.defineProperties(instance, {
-		[KEY_LOGGER]: {
-			enumerable: false,
-			value: NAME_TIMED,
-		},
-		active: {
-			enumerable: true,
-			get() {
-				return state.started && !state.stopped && enabled;
-			},
-		},
-		log: {
-			enumerable: true,
-			get() {
-				return this.active ? logger : noop;
-			},
-		},
-		stop: {
-			enumerable: true,
-			get() {
-				return (instance as TimedLogger).active ? stop() : noop;
-			},
-		},
-	});
-
-	if (state.started) {
-		console.time(label);
-	}
-
-	return Object.freeze(instance) as TimedLogger;
-}
-
-// #endregion
-
-// #region Variables
-
-const KEY_LOGGER = '$logger';
-
-const NAME_LOGGER = 'Logger';
-
-const NAME_TIMED = 'TimedLogger';
-
-const methods = ['debug', 'dir', 'error', 'info', 'log', 'table', 'trace', 'warn'] as const;
-
-/**
- * A logger that can be used to log messages to the console
- *
- * _(Logging can be enabled or disabled by setting the `enabled` property)_
- */
-const Logger = (() => {
-	const instance = {};
-
-	Object.defineProperties(instance, {
-		[KEY_LOGGER]: {
-			enumerable: false,
-			value: NAME_LOGGER,
-		},
-		enabled: {
-			enumerable: true,
-			get() {
-				return enabled;
-			},
-			set(value: boolean) {
-				enabled = typeof value === 'boolean' ? value : enabled;
-			},
-		},
-		time: {
-			enumerable: true,
-			value(label: string) {
-				return timedLogger(label);
-			},
-		},
-	});
-
-	for (const method of methods) {
-		Object.defineProperty(instance, method, {
-			enumerable: true,
-			get() {
-				return enabled ? console[method].bind(console) : noop;
-			},
-		});
-	}
-
-	return Object.freeze(instance);
-})() as Logger;
-
-let enabled = true;
-
-// #endregion
-
-// #region Exports
-
-export {isLogger, isTimedLogger, Logger, type TimedLogger};
-
-// #endregion

package/src/math.ts

@@ -1,281 +0,0 @@
-import {isNumber} from './internal/is';
-import {
-	aggregate,
-	AGGREGATION_AVERAGE,
-	AGGREGATION_MIN,
-	AGGREGATION_SUM,
-	getAggregateCallback,
-	getAggregated,
-} from './internal/math/aggregate';
-import {roundNumber} from './internal/math/misc';
-import type {NumericalValues, PlainObject} from './models';
-
-// #region Functions
-
-/**
- * Get the average value from a list of items
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @returns Average value, or `Number.NaN` if no average can be calculated
- */
-export function average<Item>(
-	items: Item[],
-	callback: (item: Item, index: number, array: Item[]) => number,
-): number;
-
-/**
- * Get the average value from a list of items
- *
- * @param items List of items
- * @param key Key to use for value
- * @returns Average value, or `Number.NaN` if no average can be calculated
- */
-export function average<Item extends PlainObject>(
-	items: Item[],
-	key: keyof NumericalValues<Item>,
-): number;
-
-/**
- * Get the average value from a list of numbers
- *
- * @param numbers List of numbers
- * @returns Average value, or `Number.NaN` if no average can be calculated
- */
-export function average(numbers: number[]): number;
-
-export function average(array: unknown[], key?: unknown): number {
-	const aggregated = aggregate(AGGREGATION_AVERAGE, array, key);
-
-	return aggregated.count > 0 ? aggregated.value / aggregated.count : Number.NaN;
-}
-
-/**
- * Round a number up
- *
- * @param value Number to round up
- * @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 ceil(value: number, decimals?: number): number {
-	return roundNumber(Math.ceil, value, decimals);
-}
-
-/**
- * Count the number of items in an array that match a specific value
- *
- * @param array Array to count for
- * @param callback Callback to get an item's value
- * @param value Value to match and count
- * @returns Number of items that match the condition, or `Number.NaN` if no count can be calculated
- */
-export function count<Item>(
-	array: Item[],
-	callback: (item: Item, index: number, array: Item[]) => unknown,
-	value: unknown,
-): number;
-
-/**
- * Count the number of items in an array that have a specific value
- *
- * @param array Array to count for
- * @param key Key to use for value
- * @param value Value to match and count
- * @returns Number of items with the specified key value, or `Number.NaN` if no count can be calculated
- */
-export function count<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): number;
-
-/**
- * Count the number of items in an array
- *
- * @param values Array to count for
- * @returns Number of items, or `Number.NaN` if no count can be calculated
- */
-export function count(values: unknown[]): number;
-
-export function count(array: unknown[], key?: unknown, value?: unknown): number {
-	if (!Array.isArray(array)) {
-		return Number.NaN;
-	}
-
-	const {length} = array;
-
-	const callback = getAggregateCallback(key);
-
-	if (callback == null) {
-		return length;
-	}
-
-	let counted = 0;
-
-	for (let index = 0; index < length; index += 1) {
-		const item = array[index];
-
-		if (Object.is(callback(item as never, index, array), value)) {
-			counted += 1;
-		}
-	}
-
-	return counted;
-}
-
-/**
- * Round a number down
- *
- * @param value Number to round down
- * @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 floor(value: number, decimals?: number): number {
-	return roundNumber(Math.floor, value, decimals);
-}
-
-/**
- * Get the median value from a list of items
- *
- * @param array List of items
- * @param callback Callback to get an item's value
- * @returns Median value, or `Number.NaN` if no median can be calculated
- */
-export function median<Item>(
-	array: Item[],
-	callback: (item: Item, index: number, array: Item[]) => number,
-): number;
-
-/**
- * Get the median value from a list of items
- *
- * @param array List of items
- * @param key Key to use for value
- * @returns Median value, or `Number.NaN` if no median can be calculated
- */
-export function median<Item extends PlainObject>(
-	array: Item[],
-	key: keyof NumericalValues<Item>,
-): number;
-
-/**
- * Get the median value from a list of numbers
- *
- * @param array List of numbers
- * @returns Median value, or `Number.NaN` if no median can be calculated
- */
-export function median(array: number[]): number;
-
-export function median(array: unknown[], key?: unknown): number {
-	let length = Array.isArray(array) ? array.length : 0;
-
-	if (!Array.isArray(array) || length === 0) {
-		return Number.NaN;
-	}
-
-	let values: unknown[] = array;
-
-	const callback = getAggregateCallback(key);
-
-	if (callback != null) {
-		values = array.map((item, index) => callback(item as never, index, array));
-	}
-
-	const numbers = values.filter(isNumber).sort((first, second) => first - second);
-
-	length = numbers.length;
-
-	if (length === 1) {
-		return numbers[0];
-	}
-
-	if (length % 2 === 0) {
-		const first = length / 2 - 1;
-		const second = length / 2;
-
-		return (numbers[first] + numbers[second]) / 2;
-	}
-
-	return numbers[Math.floor(length / 2)];
-}
-
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @returns Minimum value, or `Number.NaN` if no minimum can be found
- */
-export function min<Item>(
-	items: Item[],
-	callback: (item: Item, index: number, array: Item[]) => number,
-): number;
-
-/**
- * Get the minimum value from a list of items
- *
- * @param items List of items
- * @param key Key to use for value
- * @returns Minimum value, or `Number.NaN` if no minimum can be found
- */
-export function min<Item extends PlainObject>(
-	items: Item[],
-	key: keyof NumericalValues<Item>,
-): number;
-
-/**
- * Get the minimum value from a list of numbers
- *
- * @param values List of numbers
- * @returns Minimum value, or `Number.NaN` if no minimum can be found
- */
-export function min(values: number[]): number;
-
-export function min(array: unknown[], key?: unknown): number {
-	return getAggregated(AGGREGATION_MIN, array, key);
-}
-
-/**
- * Get the sum of a list of items
- *
- * @param items List of items
- * @param callback Callback to get an item's value
- * @returns Sum of the values, or `Number.NaN` if no sum can be calculated
- */
-export function sum<Item>(
-	items: Item[],
-	callback: (item: Item, index: number, array: Item[]) => number,
-): number;
-
-/**
- * Get the sum of a list of items
- *
- * @param items List of items
- * @param key Key to use for value
- * @returns Sum of the values, or `Number.NaN` if no sum can be calculated
- */
-export function sum<Item extends PlainObject>(
-	items: Item[],
-	key: keyof NumericalValues<Item>,
-): number;
-
-/**
- * Get the sum of a list of numbers
- *
- * @param values List of numbers
- * @returns Sum of the numbers, or `Number.NaN` if no sum can be calculated
- */
-export function sum(values: number[]): number;
-
-export function sum(array: unknown[], key?: unknown): number {
-	return getAggregated(AGGREGATION_SUM, array, key);
-}
-
-// #endregion
-
-// #region Exports
-
-export {max} from './internal/math/aggregate';
-export {round} from './internal/math/misc';
-
-// #endregion