feat(utilities): add objectValues function (#474)

* feat(utilities): add `objectValues` function

* test(objectValues): cover readonly types

* fix(objectValues): return type

* chore(utilities): re-order export for `objectValues`

* Update packages/utilities/src/lib/objectValues.ts

Co-authored-by: Jeroen Claassens <jeroen.claassens@live.nl>

packages/utilities/src/index.ts

@@ -33,6 +33,7 @@ export * from './lib/mergeDefault';
 export * from './lib/mergeObjects';
 export * from './lib/noop';
 export * from './lib/objectToTuples';
+export * from './lib/objectValues';
 export * from './lib/parseUrl';
 export * from './lib/partition';
 export * from './lib/range';

packages/utilities/src/lib/objectValues.ts

@@ -0,0 +1,5 @@
+import type { NonNullObject } from './utilityTypes';
+
+export function objectValues<T extends NonNullObject>(obj: T): T extends ArrayLike<any> ? T[number][] : T[keyof T][] {
+	return Object.values(obj) as T extends ArrayLike<infer Values> ? Values[] : T[keyof T][];
+}

packages/utilities/tests/objectValues.test.ts

@@ -0,0 +1,31 @@
+import { objectValues } from '../src';
+
+describe('objectValues', () => {
+	test('GIVEN basic readonly THEN returns expected', () => {
+		const source = { a: 'Hello', b: 420 } as const;
+		const expected = ['Hello', 420];
+
+		expect<('Hello' | 420)[]>(objectValues(source)).toEqual(expected);
+	});
+
+	test('GIVEN deep readonly THEN returns expected', () => {
+		const source = { a: 'Hello', b: 420, deep: { i: [] } } as const;
+		const expected = ['Hello', 420, { i: [] }];
+
+		expect<('Hello' | 420 | { i: readonly [] })[]>(objectValues(source)).toEqual(expected);
+	});
+
+	test('GIVEN basic readonly THEN returns expected', () => {
+		const source = { a: 'Hello', b: 420 };
+		const expected = ['Hello', 420];
+
+		expect(objectValues(source)).toEqual(expected);
+	});
+
+	test('GIVEN deep THEN returns expected', () => {
+		const source = { a: 'Hello', b: 420, deep: { i: [] } };
+		const expected = ['Hello', 420, { i: [] }];
+
+		expect(objectValues(source)).toEqual(expected);
+	});
+});