@akala/core
Version:
203 lines (191 loc) • 8.05 kB
text/typescript
/**
* Iterates over array-like structures using forEach
* @template T - Element type
* @param {T[] | ArrayLike<T>} array - Array or array-like object to iterate
* @param {function(element: T, i: number): void} body - Callback executed for each element
* @returns {void} - No return value
*/
export function array<T>(array: T[] | ArrayLike<T>, body: (element: T, i: number) => void): void
{
Array.prototype.forEach.call(array, body);
}
/**
* Iterates over object properties
* @template TIn - Object type
* @param {TIn} o - Target object to iterate
* @param {function(element: TIn[keyof TIn], i: keyof TIn): void} body - Callback executed for each property
* @returns {void} - No return value
*/
export function object<TIn>(o: TIn, body: (element: TIn[keyof TIn], i: keyof TIn) => void): void
{
array(Object.keys(o) as (keyof TIn)[], function (key)
{
body(o[key], key);
});
}
/**
* Universal iteration function for arrays/objects
* @template T - Input type (array/object)
* @param {T | T[]} it - Target collection to iterate
* @param {function(element: any, i: any): void} body - Callback for each element/property
* @overload
* each(array: T[] | ArrayLike<T>, body: (element: T, i: number) => void): void
* @overload
* each(o: T, body: <U extends keyof T>(element: T[U], i: U) => void): void
* @returns {void} - No return value
*/
export function each<T>(array: T[] | ArrayLike<T>, body: (element: T, i: number) => void): void
export function each<T>(o: T, body: <U extends keyof T>(element: T[U], i: U) => void): void
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function each<T>(it: T | T[], body: (element: any, i: any) => void): void
{
if (isArrayLike(it))
return array(it, body);
return object(it, body);
}
/**
* Filters array-like structures
* @template T - Element type
* @param {T[] | ArrayLike<T>} it - Input collection
* @param {function(element: T, i: number): boolean} body - Filter predicate
* @returns {T[]} - Array of matching elements
*/
export function grepArray<T>(it: T[] | ArrayLike<T>, body: (element: T, i: number) => boolean): T[]
{
const result = [];
array(it, function (el, i)
{
if (body(el, i))
result.push(el);
});
return result;
}
/**
* Type representing a projected object
* @template T - Source type
* @template U - Target type
*/
export type Proxy<T, U> = { [P in keyof T]: U };
/**
* Filters object properties
* @template T - Object type
* @param {T} o - Target object
* @param {function(element: T[keyof T], i: keyof T): boolean} body - Filter predicate
* @param {boolean} asArray - Return results as array instead of object
* @returns {(Partial<T> | T[keyof T][]) - Filtered results as object or array
*/
export function grepObject<T>(o: T, body: (element: T[keyof T], i: keyof T) => boolean, asArray?: true): T[keyof T][]
export function grepObject<T>(o: T, body: (element: T[keyof T], i: keyof T) => boolean, asArray: false): Partial<T>
export function grepObject<T>(o: T, body: (element: T[keyof T], i: keyof T) => boolean, asArray: boolean): Partial<T> | T[keyof T][]
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function grepObject<T>(o: T, body: (element: T[keyof T], i: keyof T) => boolean, asArray: boolean)
{
const result: Partial<T> = {};
const resultArray: T[keyof T][] = [];
object(o, function (el, i)
{
if (body(el, i))
if (asArray)
resultArray.push(el);
else
result[i] = el;
});
if (asArray)
return resultArray;
return result;
}
/**
* Checks if value is array-like
* @template T - Element type
* @param {unknown} it - Value to check
* @returns {it is ArrayLike<T>} - True if array-like
*/
export function isArrayLike<T>(t: T[]): true
export function isArrayLike<T>(t: ArrayLike<T>): true
export function isArrayLike<T>(t: unknown): t is ArrayLike<T>
export function isArrayLike<T>(it: unknown): it is ArrayLike<T>
{
return Array.isArray(it) || typeof (it) != 'undefined' && typeof (it['length']) == 'number'
}
/**
* Unified filter function for arrays/objects
* @template T - Input type
* @param {T | T[]} it - Target collection
* @param {function(element: any, i: any): boolean} body - Filter predicate
* @param {boolean} asArray - Return results as array
* @returns {(T[] | Partial<T>)} - Filtered results
*/
export function grep<T>(array: T[] | ArrayLike<T>, body: (element: T, i: number) => boolean): T[]
export function grep<T>(o: T, body: <U extends keyof T>(element: T[U], i: U) => boolean): Partial<T>
export function grep<T, U extends keyof T>(o: T, body: (element: T[U], i: U) => boolean, asArray: true): T[U][]
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
export function grep(it: any, body: (element: any, i: any) => boolean, asArray?: boolean)
{
if (isArrayLike(it))
return grepArray(it, body);
return grepObject(it, body, asArray);
}
/**
* Transforms array elements
* @template T - Input element type
* @template U - Output element type
* @param {T[] | ArrayLike<T>} it - Input collection
* @param {function(element: T, i: number): U} body - Transformation function
* @returns {U[]} - Transformed elements
*/
export function mapArray<T, U>(it: T[] | ArrayLike<T>, body: (element: T, i: number) => U): U[]
{
const result = [];
array(it, function (el, i)
{
result.push(body(el, i));
});
return result;
}
/**
* Transforms object properties
* @template TIn - Input object type
* @template TResultValue - Output property type
* @param {TIn} o - Target object
* @param {function(element: TIn[keyof TIn], i: keyof TIn): TResultValue} body - Transformation function
* @param {boolean} asArray - Return results as array
* @returns {(TResultValue[] | {[P in keyof TIn]?: TResultValue})} - Transformed results
*/
export function mapObject<TIn, TResultValue>(o: TIn, body: (element: TIn[keyof TIn], i: keyof TIn) => TResultValue, asArray: true): TResultValue[]
export function mapObject<TIn, TResultValue>(o: TIn, body: (element: TIn[keyof TIn], i: keyof TIn) => TResultValue, asArray?: false): { [P in keyof TIn]?: TResultValue }
export function mapObject<TIn, TResultValue>(o: TIn, body: (element: TIn[keyof TIn], i: keyof TIn) => TResultValue, asArray?: boolean)
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function mapObject<TIn, TResultValue>(o: TIn, body: (element: TIn[keyof TIn], i: keyof TIn) => TResultValue, asArray?: boolean)
{
const result: Partial<Proxy<TIn, TResultValue>> = {};
const resultArray: TResultValue[] = [];
object(o, function (el, i)
{
if (asArray)
resultArray.push(body(el, i));
else
result[i] = body(el, i);
});
if (asArray)
return resultArray;
return result;
}
/**
* Unified mapping function for arrays/objects
* @template T - Input type
* @template U - Output type
* @param {T | T[]} it - Target collection
* @param {function(element: any, i: any): any} body - Transformation function
* @param {boolean} asArray - Return results as array
* @returns {(U[] | Proxy<T, U>)} - Transformed results
*/
export function map<T, U>(array: T[] | ArrayLike<T>, body: (element: T, i: number) => U): U[]
export function map<TIn, TKey extends keyof TIn, TResultValue>(o: TIn, body: (element: TIn[TKey], i: TKey) => TResultValue): Proxy<TIn, TResultValue>
export function map<TIn, TKey extends keyof TIn, TResultValue>(o: TIn, body: (element: TIn[TKey], i: TKey) => TResultValue, asArray: true): TResultValue[]
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
export function map(it: any, body: (element: any, i: any) => any, asArray?: boolean)
{
if (isArrayLike(it))
return mapArray(it, body);
return mapObject(it, body, asArray);
}