@oscarpalmer/atoms 0.193.0 → 0.193.1

package/src/array/select.ts

@@ -1,260 +0,0 @@
-import {FIND_VALUES_ALL, findValues} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterCallback Callback to get an item's value for matching
- * @param filterValue Value to match against
- * @param mapCallback Callback to map the matched items
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id,
- *   2,
- *   item => item.name,
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item,
-	FilterCallback extends (item: Item, index: number, array: Item[]) => unknown,
-	MapCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	filterCallback: FilterCallback,
-	filterValue: ReturnType<FilterCallback>,
-	mapCallback: MapCallback,
-): Array<ReturnType<MapCallback>>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterCallback Callback to get an item's value for matching
- * @param filterValue Value to match against
- * @param mapKey Key to get an item's value for mapping
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id,
- *   2,
- *   'name',
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item extends PlainObject,
-	FilterCallback extends (item: Item, index: number, array: Item[]) => unknown,
-	MapKey extends keyof Item,
->(
-	array: Item[],
-	filterCallback: FilterCallback,
-	filterValue: ReturnType<FilterCallback>,
-	mapKey: MapKey,
-): Array<Item[MapKey]>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterKey Key to get an item's value for matching
- * @param filterValue Value to match against
- * @param mapCallback Callback to map the matched items
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   'id',
- *   2,
- *   item => item.name,
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	MapCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	filterKey: ItemKey,
-	filterValue: Item[ItemKey],
-	mapCallback: MapCallback,
-): Array<ReturnType<MapCallback>>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterKey Key to get an item's value for matching
- * @param filterValue Value to match against
- * @param mapKey Key to get an item's value for mapping
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   'id',
- *   2,
- *   'name',
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item extends PlainObject,
-	ItemKey extends keyof Item,
-	MapKey extends keyof Item,
->(
-	array: Item[],
-	filterKey: ItemKey,
-	filterValue: Item[ItemKey],
-	mapKey: MapKey,
-): Array<Item[MapKey]>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterCallback Filter callback to match items
- * @param mapCallback Callback to map the matched items
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id === 2,
- *   item => item.name,
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item,
-	FilterCallback extends (item: Item, index: number, array: Item[]) => unknown,
-	MapCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	filterCallback: FilterCallback,
-	filterValue: ReturnType<FilterCallback>,
-	mapCallback: MapCallback,
-): Array<ReturnType<MapCallback>>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filterCallback Filter callback to match items
- * @param mapKey Key to get an item's value for mapping
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id,
- *   2,
- *   'name'
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item extends PlainObject,
-	FilterCallback extends (item: Item, index: number, array: Item[]) => unknown,
-	MapKey extends keyof Item,
->(
-	array: Item[],
-	filterCallback: FilterCallback,
-	filterValue: ReturnType<FilterCallback>,
-	mapKey: MapKey,
-): Array<Item[MapKey]>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @param map Callback to map the matched items
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id === 2,
- *   item => item.name,
- * ); // => ['Bob']
- * ```
- */
-export function select<
-	Item,
-	MapCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-	map: MapCallback,
-): Array<ReturnType<MapCallback>>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @param map Key to get an item's value for mapping
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [{id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}, {id: 3, name: 'Charlie'}],
- *   item => item.id === 2,
- *   'name'
- * ); // => ['Bob']
- * ```
- */
-export function select<Item extends PlainObject, MapKey extends keyof Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-	map: MapKey,
-): Array<Item[MapKey]>;
-
-/**
- * Get a filtered and mapped array of items
- *
- * @param array Array to search in
- * @param item Item to match against
- * @param map Callback to map the matched items
- * @returns Filtered and mapped array of items
- *
- * @example
- * ```typescript
- * select(
- *   [1, 2, 3, 2, 1],
- *   3,
- *   value => value ** 2,
- * ); // => [9]
- * ```
- */
-export function select<
-	Item,
-	MapCallback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], item: Item, map: MapCallback): Array<ReturnType<MapCallback>>;
-
-export function select(array: unknown[], ...parameters: unknown[]): unknown[] {
-	const mapper = parameters.pop();
-
-	return findValues(FIND_VALUES_ALL, array, parameters, mapper).matched;
-}
-
-// #endregion

package/src/array/single.ts

@@ -1,93 +0,0 @@
-import {FIND_VALUES_ALL, findValues} from '../internal/array/find';
-import type {PlainObject} from '../models';
-
-// #region Functions
-
-/**
- * Get the _only_ item matching the given value
- *
- * Throws an error if multiple items match the value
- *
- * @param array Array to search in
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns Only item that matches the value, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * single(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2
- * ); // => {id: 2}
- * ```
- */
-export function single<
-	Item,
-	Callback extends (item: Item, index: number, array: Item[]) => unknown,
->(array: Item[], callback: Callback, value: ReturnType<Callback>): Item | undefined;
-
-/**
- * Get the _only_ item matching the given value by key
- *
- * Throws an error if multiple items match the value
- *
- * @param array Array to search in
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns Only item that matches the value, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * single(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2
- * ); // => {id: 2}
- * ```
- */
-export function single<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item | undefined;
-
-/**
- * Get the _only_ item matching the filter
- *
- * Throws an error if multiple items match the filter
- *
- * @param array Array to search in
- * @param filter Filter callback to match items
- * @returns Only item that matches the filter, or `undefined` if no match is found
- *
- * @example
- * ```typescript
- * single(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2
- * ); // => {id: 2}
- * ```
- */
-export function single<Item>(
-	array: Item[],
-	filter: (item: Item, index: number, array: Item[]) => boolean,
-): Item | undefined;
-
-export function single(array: unknown[], ...parameters: unknown[]): unknown {
-	const {matched} = findValues(FIND_VALUES_ALL, array, parameters);
-
-	if (matched.length > 1) {
-		throw new Error(SINGLE_MESSAGE);
-	}
-
-	return matched[0];
-}
-
-// #endregion
-
-// #region Variables
-
-const SINGLE_MESSAGE = 'Multiple items were found';
-
-// #endregion

package/src/array/slice.ts

@@ -1,335 +0,0 @@
-import {getArrayCallbacks} from '../internal/array/callbacks';
-import type {PlainObject} from '../models';
-
-// #region Types
-
-type ExtractType = 'drop' | 'take';
-
-// #endregion
-
-// #region Functions
-
-/**
- * Drop items from the start of an array until they match a value
- *
- * @param array Original array
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns New array with items dropped
- *
- * @example
- * ```typescript
- * drop(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => [{id: 2}, {id: 3}]
- * ```
- */
-export function drop<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(
-	array: Item[],
-	callback: Callback,
-	value: ReturnType<Callback>,
-): Item[];
-
-/**
- * Drop items from the start of an array until they match a value
- *
- * @param array Original array
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns New array with items dropped
- *
- * @example
- * ```typescript
- * drop(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => [{id: 2}, {id: 3}]
- * ```
- */
-export function drop<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item[];
-
-/**
- * Drop items from the start of an array while they match a filter
- *
- * @param array Original array
- * @param callback Filter callback to match items
- * @returns New array with items dropped
- *
- * @example
- * ```typescript
- * drop(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => [{id: 2}, {id: 3}]
- * ```
- */
-export function drop<Item extends PlainObject>(
-	array: Item[],
-	callback: (item: Item, index: number, array: Item[]) => boolean,
-): Item[];
-
-/**
- * Drop a specified number of items, from the start if `>= 0`, or from the end if `< 0`
- *
- * @param array Original array
- * @param count Number of items to drop
- * @returns New array with items dropped
- *
- * @example
- * ```typescript
- * drop([1, 2, 3, 4, 5], 2);  // => [3, 4, 5]
- * drop([1, 2, 3, 4, 5], -2); // => [1, 2, 3]
- * ```
- */
-export function drop(array: unknown[], count: number): unknown[];
-
-export function drop(array: unknown[], first?: unknown, second?: unknown): unknown[] {
-	return extract(EXTRACT_DROP, array, first, second);
-}
-
-function extract(
-	type: ExtractType,
-	array: unknown[],
-	first?: unknown,
-	second?: unknown,
-): unknown[] {
-	if (!Array.isArray(array)) {
-		return [];
-	}
-
-	const {length} = array;
-
-	if (length === 0) {
-		return [];
-	}
-
-	const isTake = type === EXTRACT_TAKE;
-
-	if (typeof first === 'number') {
-		if (Math.abs(first) >= length) {
-			return isTake ? array.slice() : [];
-		}
-
-		if (first === 0) {
-			return isTake ? [] : array.slice();
-		}
-
-		if (isTake) {
-			return first >= 0 ? array.slice(0, first) : array.slice(array.length + first);
-		}
-
-		return first >= 0 ? array.slice(first) : array.slice(0, array.length + first);
-	}
-
-	const callbacks =
-		second == null ? getArrayCallbacks(first) : getArrayCallbacks(undefined, undefined, first);
-
-	const isBoolean = callbacks?.bool != null;
-
-	if (callbacks?.bool == null && callbacks?.value == null) {
-		return isTake ? array.slice() : [];
-	}
-
-	const extracted: unknown[] = [];
-
-	let push = false;
-
-	for (let index = 0; index < length; index += 1) {
-		const item = array[index];
-
-		const matches = isBoolean
-			? callbacks.bool!(item, index, array)
-			: Object.is(callbacks!.value!(item, index, array), second);
-
-		if (isTake) {
-			if (isBoolean ? !matches : matches) {
-				break;
-			}
-
-			extracted.push(item);
-
-			continue;
-		}
-
-		if (push) {
-			extracted.push(item);
-		} else if (isBoolean ? !matches : matches) {
-			push = true;
-
-			if (isBoolean) {
-				extracted.push(item);
-			}
-		}
-	}
-
-	return extracted;
-}
-
-/**
- * Slice an array _(returning a new array with a specified range of items)_
- *
- * @param array Original array
- * @param start Start index _(inclusive)_
- * @param end End index _(exclusive)_
- * @returns New array with sliced items
- *
- * @example
- * ```typescript
- * slice([1, 2, 3, 4, 5], 1, 4); // => [2, 3, 4]
- * ```
- */
-export function slice<Item>(array: Item[], start: number, end: number): Item[];
-
-/**
- * Slice an array _(returning a new array with a specified number of items, from the start)_
- *
- * @param array Original array
- * @param count Maximum size of the new array
- * @returns New array with sliced items
- *
- * @example
- * ```typescript
- * slice([1, 2, 3, 4, 5], 3); // => [1, 2, 3]
- * ```
- */
-export function slice<Item>(array: Item[], count: number): Item[];
-
-/**
- * Slice an array _(returning a new array with all items)_
- *
- * @param array Array to slice
- * @returns Sliced array
- *
- * @example
- * ```typescript
- * slice([1, 2, 3]); // => [1, 2, 3]
- * ```
- */
-export function slice<Item>(array: Item[]): Item[];
-
-export function slice(array: unknown[], first?: number, second?: number): unknown[] {
-	if (!Array.isArray(array) || array.length === 0) {
-		return [];
-	}
-
-	const firstIsNumber = typeof first === 'number';
-	const secondIsNumber = typeof second === 'number';
-
-	if (!firstIsNumber && !secondIsNumber) {
-		return array.slice();
-	}
-
-	if (!secondIsNumber) {
-		return first! >= 0 ? array.slice(0, first) : array.slice(array.length + first!);
-	}
-
-	if (!firstIsNumber) {
-		return array.slice();
-	}
-
-	return first! >= 0
-		? array.slice(first!, second!)
-		: array.slice(array.length + first!, array.length + second!);
-}
-
-/**
- * Take items from the start of an array until they match a value
- *
- * @param array Original array
- * @param callback Callback to get an item's value for matching
- * @param value Value to match against
- * @returns New array with taken items
- *
- * @example
- * ```typescript
- * take(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id,
- *   2,
- * ); // => [{id: 1}]
- * ```
- */
-export function take<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(
-	array: Item[],
-	callback: Callback,
-	value: ReturnType<Callback>,
-): Item[];
-
-/**
- * Take items from the start of an array until they match a value
- *
- * @param array Original array
- * @param key Key to get an item's value for matching
- * @param value Value to match against
- * @returns New array with taken items
- *
- * @example
- * ```typescript
- * take(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   'id',
- *   2,
- * ); // => [{id: 1}]
- * ```
- */
-export function take<Item extends PlainObject, ItemKey extends keyof Item>(
-	array: Item[],
-	key: ItemKey,
-	value: Item[ItemKey],
-): Item[];
-
-/**
- * Take items from the start of an array while they match a filter
- *
- * @param array Original array
- * @param callback Filter callback to match items
- * @returns New array with taken items
- *
- * @example
- * ```typescript
- * take(
- *   [{id: 1}, {id: 2}, {id: 3}],
- *   item => item.id === 2,
- * ); // => [{id: 1}]
- * ```
- */
-export function take<Item extends PlainObject>(
-	array: Item[],
-	callback: (item: Item, index: number, array: Item[]) => boolean,
-): Item[];
-
-/**
- * Take a specified number of items, from the start if `>= 0`, or from the end if `< 0`
- *
- * @param array Original array
- * @param count Number of items to take
- * @returns New array with taken items
- *
- * @example
- * ```typescript
- * take([1, 2, 3, 4, 5], 2);  // => [1, 2]
- * take([1, 2, 3, 4, 5], -2); // => [4, 5]
- * ```
- */
-export function take(array: unknown[], count: number): unknown[];
-
-export function take(array: unknown[], first?: unknown, second?: unknown): unknown[] {
-	return extract(EXTRACT_TAKE, array, first, second);
-}
-
-// #endregion
-
-// #region Variables
-
-const EXTRACT_DROP: ExtractType = 'drop';
-
-const EXTRACT_TAKE: ExtractType = 'take';
-
-// #endregion