@estarlincito/utils
Version:
A collection of utility functions designed to simplify and speed up development tasks in JavaScript and TypeScript projects.
81 lines (80 loc) • 3.12 kB
TypeScript
type NestedPaths<T, Depth extends any[] = []> = T extends object ? Depth['length'] extends 3 ? never : {
[K in keyof T]: K extends string ? T[K] extends any[] ? `${K}` : `${K}` | `${K}:${NestedPaths<T[K], [...Depth, any]>}` : never;
}[keyof T] : never;
type NestedValue<T, P extends string> = P extends `${infer K}:${infer Rest}` ? K extends keyof T ? NestedValue<T[K], Rest> : never : P extends keyof T ? T[P] : never;
/**
* Utility class for array operations.
* This class cannot be instantiated.
*/
export declare class ArrayUtils {
private constructor();
/**
* Get unique objects by nested keys with full type safety
* @example
* const data = [
* {
* category: 'Tech',
* url: '/tech',
* data: { pathnames: { cat: 'alpha', sub: 'beta' } }
* },
* {
* category: 'Health',
* url: '/health',
* data: { pathnames: { cat: 'gamma', sub: 'delta' } }
* },
* {
* category: 'Tech',
* url: '/tech',
* data: { pathnames: { cat: 'alpha', sub: 'epsilon' } }
* }
* ];
*
* // Get unique items by nested category
* const result = ArrayUtils.getUniqueByKey(
* data,
* 'data:pathnames:cat', // Group by nested category
* 'category', // Include top-level category
* 'url' // Include URL
* );
*
* // Result type: Array<{ 'data:pathnames:cat': string, category: string, url: string }>
* console.log(result);
* // Output:
* // [
* // {
* // 'data:pathnames:cat': 'alpha',
* // category: 'Tech',
* // url: '/tech'
* // },
* // {
* // 'data:pathnames:cat': 'gamma',
* // category: 'Health',
* // url: '/health'
* // }
* // ]
*/
static getUniqueByKey<T extends object, GK extends NestedPaths<T>, IK extends NestedPaths<T>[]>(array: T[], groupKey: GK, ...includeKeys: IK): Record<GK | IK[number], NestedValue<T, GK | IK[number]>>[];
/**
* Extracts unique values from an array of objects based on a specified key.
*
* @template T - The object type in the array.
* @template K - The key in the object whose unique values should be extracted.
* @param {T[]} array - The array of objects to process.
* @param {K} key - The key whose unique values should be returned.
* @returns {T[K][]} An array of unique values for the specified key.
*
* @example
* const data = [
* { id: 1, category: 'Tech', url: 'https://example.com/tech' },
* { id: 2, category: 'Health', url: 'https://example.com/health' },
* { id: 3, category: 'Tech', url: 'https://example.com/tech' },
* { id: 4, category: 'Education', url: 'https://example.com/education' },
* ];
*
* const uniqueCategories = getUniqueValues(data, 'category');
* console.log(uniqueCategories);
* // Output: ['Tech', 'Health', 'Education']
*/
static getUniqueValues: <T, K extends keyof T>(array: T[], key: K) => T[K][];
}
export {};