radashi 12.4.0 → 12.5.0-beta.8a7266a

package/dist/radashi.cjs

@@ -204,6 +204,15 @@ function objectify(array, getKey, getValue = (item) => item) {
   );
 }
 
+// src/array/pluck.ts
+function pluck(array, mappings) {
+  return array.map(
+    mappings ? (item) => mappings.map(
+      (mapping) => isFunction(mapping) ? mapping(item) : item[mapping]
+    ) : Object.values
+  );
+}
+
 // src/array/remove.ts
 function remove(array, predicate) {
   return array.filter((item) => !predicate(item));
@@ -1918,6 +1927,7 @@ exports.partial = partial;
 exports.partob = partob;
 exports.pascal = pascal;
 exports.pick = pick;
+exports.pluck = pluck;
 exports.proxied = proxied;
 exports.random = random;
 exports.range = range;

package/dist/radashi.d.cts

@@ -332,6 +332,47 @@ declare function merge<T>(prev: readonly T[], array: readonly T[], toKey: (item:
  */
 declare function objectify<T, Key extends string | number | symbol, Value = T>(array: readonly T[], getKey: (item: T) => Key, getValue?: (item: T) => Value): Record<Key, Value>;
 
+/**
+ * Extracts values from an array of objects based on specified
+ * mappings. Useful for extracting multiple properties from an array
+ * of objects (e.g. for tabular data). Also supports “computed
+ * properties” via mapping functions, which can combine and transform
+ * values on-the-fly.
+ *
+ * - If mappings are provided, returns an array of arrays where each
+ *   inner array contains the values extracted by applying each
+ *   mapping to the corresponding object.
+ * - If no mappings are provided, returns an array of arrays
+ *   containing all values of each object.
+ *
+ * @see https://radashi.js.org/reference/array/pluck
+ * @example
+ * ```ts
+ * interface God {
+ *   name: string;
+ *   power: number;
+ *   domain: string;
+ * }
+ *
+ * const gods: God[] = [
+ *   { name: 'Ra', power: 100, domain: 'Sun' },
+ *   { name: 'Zeus', power: 98, domain: 'Lightning' },
+ *   { name: 'Loki', power: 72, domain: 'Tricks' }
+ * ];
+ *
+ * // Extract a set of properties
+ * pluck(gods, ['power', 'domain']);
+ * // [[100, 'Sun'], [98, 'Lightning'], [72, 'Tricks']]
+ *
+ * // Extract all properties
+ * pluck(gods);
+ * // [['Ra', 100, 'Sun'], ['Zeus', 98, 'Lightning'], ['Loki', 72, 'Tricks']]
+ * ```
+ * @version 12.5.0
+ */
+declare function pluck<T extends object, TMapping extends Mapping<T>>(array: readonly T[], mappings: readonly TMapping[]): MappedOutput<TMapping, T>[];
+declare function pluck<T extends object>(array: readonly T[], mappings?: readonly Mapping<T>[]): unknown[];
+
 /**
  * Removes elements from an array based on the specified predicate
  * function.
@@ -1398,14 +1439,17 @@ type NoInfer<T> = [T][T extends any ? 0 : never];
 type StrictExtract<T, U> = SwitchNever<Extract<SwitchAny<T, unknown>, U>, unknown>;
 /**
  * Resolve a type union of property name literals within type `T`
- * whose property values are assignable to type `CompatibleValue`.
+ * whose property values are assignable to type `TConstraint`. If `T`
+ * is a primitive, it's first transformed into its boxed equivalent
+ * (e.g. `string` becomes `String`, `number` becomes `Number`, and so
+ * on).
  *
  * Use case: “I want to know which properties of `T` are compatible
- * with `CompatibleValue`.”
+ * with `TConstraint`.”
  */
-type CompatibleProperty<T, CompatibleValue> = [T] extends [Any] ? keyof any : T extends null | undefined ? never : {
-    [P in keyof BoxedPrimitive<T>]: BoxedPrimitive<T>[P] extends CompatibleValue ? P : never;
-}[keyof BoxedPrimitive<T>];
+type CompatibleProperty<T, TConstraint> = [T] extends [Any] ? keyof any : T extends null | undefined ? never : (T extends object ? T : BoxedPrimitive<T>) extends infer TObject ? {
+    [P in keyof TObject]: TObject[P] extends TConstraint ? P : never;
+}[keyof TObject] : never;
 /**
  * A value that can be reliably compared with JavaScript comparison
  * operators (e.g. `>`, `>=`, etc).
@@ -3717,4 +3761,4 @@ declare function isWeakMap<K extends WeakKey = WeakKey, V = unknown>(value: unkn
  */
 declare function isWeakSet<T extends WeakKey = WeakKey>(value: unknown): value is WeakSet<T>;
 
-export { AggregateErrorOrPolyfill as AggregateError, Any, type Assign, type BoxedPrimitive, type BuiltInType, type CastArray, type CastArrayIfExists, type Class, type CloningStrategy, type Comparable, type ComparableProperty, type Comparator, type ComparatorMapping, type CompatibleProperty, type Crush, type CustomClass, type CustomClassRegistry, type DebounceFunction, type DebounceOptions, DefaultCloningStrategy, type Err, type ExtractArray, type ExtractClass, type ExtractMap, type ExtractNotAny, type ExtractSet, type Falsy, FastCloningStrategy, type FilteredKeys, type Flip, type Intersect, type IsExactType, type KeyFilter, type KeyFilterFunction, type LowercaseKeys, type MappedInput, type MappedOutput, type Mapping, type MappingFunction, type MemoOptions, type NoInfer, type Ok, type OnceFunction, type OptionalKeys, type OptionalMapping, type ParallelOptions, type Primitive, type PromiseWithResolvers, type RequiredKeys, type Result, type ResultPromise, type RetryOptions, type Series, type Simplify, type StrictExtract, type SwitchAny, type SwitchNever, type ThrottledFunction, TimeoutError, type ToEmpty, type ToEmptyAble, type TraverseContext, type TraverseOptions, type TraverseVisitor, type TryitResult, type TypedArray, type UppercaseKeys, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };
+export { AggregateErrorOrPolyfill as AggregateError, Any, type Assign, type BoxedPrimitive, type BuiltInType, type CastArray, type CastArrayIfExists, type Class, type CloningStrategy, type Comparable, type ComparableProperty, type Comparator, type ComparatorMapping, type CompatibleProperty, type Crush, type CustomClass, type CustomClassRegistry, type DebounceFunction, type DebounceOptions, DefaultCloningStrategy, type Err, type ExtractArray, type ExtractClass, type ExtractMap, type ExtractNotAny, type ExtractSet, type Falsy, FastCloningStrategy, type FilteredKeys, type Flip, type Intersect, type IsExactType, type KeyFilter, type KeyFilterFunction, type LowercaseKeys, type MappedInput, type MappedOutput, type Mapping, type MappingFunction, type MemoOptions, type NoInfer, type Ok, type OnceFunction, type OptionalKeys, type OptionalMapping, type ParallelOptions, type Primitive, type PromiseWithResolvers, type RequiredKeys, type Result, type ResultPromise, type RetryOptions, type Series, type Simplify, type StrictExtract, type SwitchAny, type SwitchNever, type ThrottledFunction, TimeoutError, type ToEmpty, type ToEmptyAble, type TraverseContext, type TraverseOptions, type TraverseVisitor, type TryitResult, type TypedArray, type UppercaseKeys, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, pluck, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };

package/dist/radashi.d.ts

@@ -332,6 +332,47 @@ declare function merge<T>(prev: readonly T[], array: readonly T[], toKey: (item:
  */
 declare function objectify<T, Key extends string | number | symbol, Value = T>(array: readonly T[], getKey: (item: T) => Key, getValue?: (item: T) => Value): Record<Key, Value>;
 
+/**
+ * Extracts values from an array of objects based on specified
+ * mappings. Useful for extracting multiple properties from an array
+ * of objects (e.g. for tabular data). Also supports “computed
+ * properties” via mapping functions, which can combine and transform
+ * values on-the-fly.
+ *
+ * - If mappings are provided, returns an array of arrays where each
+ *   inner array contains the values extracted by applying each
+ *   mapping to the corresponding object.
+ * - If no mappings are provided, returns an array of arrays
+ *   containing all values of each object.
+ *
+ * @see https://radashi.js.org/reference/array/pluck
+ * @example
+ * ```ts
+ * interface God {
+ *   name: string;
+ *   power: number;
+ *   domain: string;
+ * }
+ *
+ * const gods: God[] = [
+ *   { name: 'Ra', power: 100, domain: 'Sun' },
+ *   { name: 'Zeus', power: 98, domain: 'Lightning' },
+ *   { name: 'Loki', power: 72, domain: 'Tricks' }
+ * ];
+ *
+ * // Extract a set of properties
+ * pluck(gods, ['power', 'domain']);
+ * // [[100, 'Sun'], [98, 'Lightning'], [72, 'Tricks']]
+ *
+ * // Extract all properties
+ * pluck(gods);
+ * // [['Ra', 100, 'Sun'], ['Zeus', 98, 'Lightning'], ['Loki', 72, 'Tricks']]
+ * ```
+ * @version 12.5.0
+ */
+declare function pluck<T extends object, TMapping extends Mapping<T>>(array: readonly T[], mappings: readonly TMapping[]): MappedOutput<TMapping, T>[];
+declare function pluck<T extends object>(array: readonly T[], mappings?: readonly Mapping<T>[]): unknown[];
+
 /**
  * Removes elements from an array based on the specified predicate
  * function.
@@ -1398,14 +1439,17 @@ type NoInfer<T> = [T][T extends any ? 0 : never];
 type StrictExtract<T, U> = SwitchNever<Extract<SwitchAny<T, unknown>, U>, unknown>;
 /**
  * Resolve a type union of property name literals within type `T`
- * whose property values are assignable to type `CompatibleValue`.
+ * whose property values are assignable to type `TConstraint`. If `T`
+ * is a primitive, it's first transformed into its boxed equivalent
+ * (e.g. `string` becomes `String`, `number` becomes `Number`, and so
+ * on).
  *
  * Use case: “I want to know which properties of `T` are compatible
- * with `CompatibleValue`.”
+ * with `TConstraint`.”
  */
-type CompatibleProperty<T, CompatibleValue> = [T] extends [Any] ? keyof any : T extends null | undefined ? never : {
-    [P in keyof BoxedPrimitive<T>]: BoxedPrimitive<T>[P] extends CompatibleValue ? P : never;
-}[keyof BoxedPrimitive<T>];
+type CompatibleProperty<T, TConstraint> = [T] extends [Any] ? keyof any : T extends null | undefined ? never : (T extends object ? T : BoxedPrimitive<T>) extends infer TObject ? {
+    [P in keyof TObject]: TObject[P] extends TConstraint ? P : never;
+}[keyof TObject] : never;
 /**
  * A value that can be reliably compared with JavaScript comparison
  * operators (e.g. `>`, `>=`, etc).
@@ -3717,4 +3761,4 @@ declare function isWeakMap<K extends WeakKey = WeakKey, V = unknown>(value: unkn
  */
 declare function isWeakSet<T extends WeakKey = WeakKey>(value: unknown): value is WeakSet<T>;
 
-export { AggregateErrorOrPolyfill as AggregateError, Any, type Assign, type BoxedPrimitive, type BuiltInType, type CastArray, type CastArrayIfExists, type Class, type CloningStrategy, type Comparable, type ComparableProperty, type Comparator, type ComparatorMapping, type CompatibleProperty, type Crush, type CustomClass, type CustomClassRegistry, type DebounceFunction, type DebounceOptions, DefaultCloningStrategy, type Err, type ExtractArray, type ExtractClass, type ExtractMap, type ExtractNotAny, type ExtractSet, type Falsy, FastCloningStrategy, type FilteredKeys, type Flip, type Intersect, type IsExactType, type KeyFilter, type KeyFilterFunction, type LowercaseKeys, type MappedInput, type MappedOutput, type Mapping, type MappingFunction, type MemoOptions, type NoInfer, type Ok, type OnceFunction, type OptionalKeys, type OptionalMapping, type ParallelOptions, type Primitive, type PromiseWithResolvers, type RequiredKeys, type Result, type ResultPromise, type RetryOptions, type Series, type Simplify, type StrictExtract, type SwitchAny, type SwitchNever, type ThrottledFunction, TimeoutError, type ToEmpty, type ToEmptyAble, type TraverseContext, type TraverseOptions, type TraverseVisitor, type TryitResult, type TypedArray, type UppercaseKeys, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };
+export { AggregateErrorOrPolyfill as AggregateError, Any, type Assign, type BoxedPrimitive, type BuiltInType, type CastArray, type CastArrayIfExists, type Class, type CloningStrategy, type Comparable, type ComparableProperty, type Comparator, type ComparatorMapping, type CompatibleProperty, type Crush, type CustomClass, type CustomClassRegistry, type DebounceFunction, type DebounceOptions, DefaultCloningStrategy, type Err, type ExtractArray, type ExtractClass, type ExtractMap, type ExtractNotAny, type ExtractSet, type Falsy, FastCloningStrategy, type FilteredKeys, type Flip, type Intersect, type IsExactType, type KeyFilter, type KeyFilterFunction, type LowercaseKeys, type MappedInput, type MappedOutput, type Mapping, type MappingFunction, type MemoOptions, type NoInfer, type Ok, type OnceFunction, type OptionalKeys, type OptionalMapping, type ParallelOptions, type Primitive, type PromiseWithResolvers, type RequiredKeys, type Result, type ResultPromise, type RetryOptions, type Series, type Simplify, type StrictExtract, type SwitchAny, type SwitchNever, type ThrottledFunction, TimeoutError, type ToEmpty, type ToEmptyAble, type TraverseContext, type TraverseOptions, type TraverseVisitor, type TryitResult, type TypedArray, type UppercaseKeys, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, pluck, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };

package/dist/radashi.js

@@ -202,6 +202,15 @@ function objectify(array, getKey, getValue = (item) => item) {
   );
 }
 
+// src/array/pluck.ts
+function pluck(array, mappings) {
+  return array.map(
+    mappings ? (item) => mappings.map(
+      (mapping) => isFunction(mapping) ? mapping(item) : item[mapping]
+    ) : Object.values
+  );
+}
+
 // src/array/remove.ts
 function remove(array, predicate) {
   return array.filter((item) => !predicate(item));
@@ -1815,4 +1824,4 @@ function isWeakSet(value) {
   return isTagged(value, "[object WeakSet]");
 }
 
-export { AggregateErrorOrPolyfill as AggregateError, DefaultCloningStrategy, FastCloningStrategy, TimeoutError, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };
+export { AggregateErrorOrPolyfill as AggregateError, DefaultCloningStrategy, FastCloningStrategy, TimeoutError, all, alphabetical, always, assign, boil, callable, camel, capitalize, cartesianProduct, castArray, castArrayIfExists, castComparator, castMapping, chain, clamp, clone, cloneDeep, cluster, compose, construct, counting, crush, dash, debounce, dedent, defer, diff, draw, filterKey, first, flat, flip, fork, get, group, guard, inRange, intersects, invert, isArray, isAsyncIterable, isBigInt, isBoolean, isClass, isDate, isEmpty, isEqual, isError, isFloat, isFunction, isInt, isIntString, isIterable, isMap, isNullish, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isRegExp, isResult, isResultErr, isResultOk, isSet, isString, isSymbol, isTagged, isUndefined, isWeakMap, isWeakSet, iterate, keys, last, lerp, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, mapify, max, memo, memoLastCall, merge, min, noop, objectify, omit, once, parallel, partial, partob, pascal, pick, pluck, proxied, random, range, reduce, remove, replace, replaceOrAppend, retry, round, select, selectFirst, series, set, shake, shift, shuffle, sift, similarity, sleep, snake, sort, sum, template, throttle, timeout, title, toFloat, toInt, toResult, toggle, traverse, trim, tryit as try, tryit, uid, unique, unzip, upperize, withResolvers, zip, zipToObject };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "radashi",
-  "version": "12.4.0",
+  "version": "12.5.0-beta.8a7266a",
   "type": "module",
   "description": "The modern, community-first TypeScript toolkit with all of the fast, readable, and minimal utility functions you need. Type-safe, dependency-free, tree-shakeable, fully tested.",
   "repository": {