radashi 12.2.0-beta.437b4fe → 12.2.0-beta.68f53c8

package/dist/index.cjs

@@ -40,6 +40,7 @@ __export(src_exports, {
   defer: () => defer,
   diff: () => diff,
   draw: () => draw,
+  filterKey: () => filterKey,
   first: () => first,
   flat: () => flat,
   fork: () => fork,
@@ -754,6 +755,11 @@ var crush = (value) => {
   );
 };
 
+// src/object/filterKey.ts
+var filterKey = (obj, key, keys2) => {
+  return isArray(keys2) ? Object.hasOwnProperty.call(obj, key) && keys2.includes(key) : keys2(obj[key], key, obj);
+};
+
 // src/object/get.ts
 var get = (value, path, defaultValue) => {
   const segments = path.split(/[\.\[\]]/g);
@@ -1180,6 +1186,7 @@ var isSymbol = (value) => {
   defer,
   diff,
   draw,
+  filterKey,
   first,
   flat,
   fork,

package/dist/index.d.cts

@@ -511,6 +511,22 @@ declare const construct: <TObject extends object>(obj: TObject) => object;
  */
 declare const crush: <TValue extends object>(value: TValue) => object;
 
+type KeyOf<T extends object> = object extends T ? keyof any : keyof T;
+type ValueOf<T extends object> = object extends T ? unknown : T[keyof T];
+type KeyFilterFunction<T extends object = object> = (value: ValueOf<T>, key: KeyOf<T>, obj: T) => boolean;
+/**
+ * Functions can use this type to accept either an array of keys or a
+ * filter callback. This provides type safety for such a parameter
+ * type, whose value can then be passed into `matchKeys` to receive a
+ * matching function.
+ */
+type KeyFilter<T extends object = object, Key extends keyof any = keyof any> = KeyFilterFunction<T> | readonly Key[];
+/**
+ * Returns true if the key is in the “keys array” or if the “filter
+ * function” returns true.
+ */
+declare const filterKey: (obj: object, key: string, keys: KeyFilter) => boolean;
+
 /**
  * Dynamically get a nested value from an array or object with a
  * string.
@@ -743,4 +759,4 @@ declare const isString: (value: any) => value is string;
 
 declare const isSymbol: (value: any) => value is symbol;
 
-export { AggregateError, type DebounceFunction, type RetryOptions, type ThrottledFunction, all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isIntString, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };
+export { AggregateError, type DebounceFunction, type KeyFilter, type KeyFilterFunction, type RetryOptions, type ThrottledFunction, all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, filterKey, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isIntString, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };

package/dist/index.d.ts

@@ -511,6 +511,22 @@ declare const construct: <TObject extends object>(obj: TObject) => object;
  */
 declare const crush: <TValue extends object>(value: TValue) => object;
 
+type KeyOf<T extends object> = object extends T ? keyof any : keyof T;
+type ValueOf<T extends object> = object extends T ? unknown : T[keyof T];
+type KeyFilterFunction<T extends object = object> = (value: ValueOf<T>, key: KeyOf<T>, obj: T) => boolean;
+/**
+ * Functions can use this type to accept either an array of keys or a
+ * filter callback. This provides type safety for such a parameter
+ * type, whose value can then be passed into `matchKeys` to receive a
+ * matching function.
+ */
+type KeyFilter<T extends object = object, Key extends keyof any = keyof any> = KeyFilterFunction<T> | readonly Key[];
+/**
+ * Returns true if the key is in the “keys array” or if the “filter
+ * function” returns true.
+ */
+declare const filterKey: (obj: object, key: string, keys: KeyFilter) => boolean;
+
 /**
  * Dynamically get a nested value from an array or object with a
  * string.
@@ -743,4 +759,4 @@ declare const isString: (value: any) => value is string;
 
 declare const isSymbol: (value: any) => value is symbol;
 
-export { AggregateError, type DebounceFunction, type RetryOptions, type ThrottledFunction, all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isIntString, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };
+export { AggregateError, type DebounceFunction, type KeyFilter, type KeyFilterFunction, type RetryOptions, type ThrottledFunction, all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, filterKey, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isIntString, isNumber, isObject, isPlainObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };

package/dist/index.js

@@ -632,6 +632,11 @@ var crush = (value) => {
   );
 };
 
+// src/object/filterKey.ts
+var filterKey = (obj, key, keys2) => {
+  return isArray(keys2) ? Object.hasOwnProperty.call(obj, key) && keys2.includes(key) : keys2(obj[key], key, obj);
+};
+
 // src/object/get.ts
 var get = (value, path, defaultValue) => {
   const segments = path.split(/[\.\[\]]/g);
@@ -1057,6 +1062,7 @@ export {
   defer,
   diff,
   draw,
+  filterKey,
   first,
   flat,
   fork,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "radashi",
-  "version": "12.2.0-beta.437b4fe",
+  "version": "12.2.0-beta.68f53c8",
   "description": "Functional utility library - modern, simple, typed, powerful",
   "sideEffects": false,
   "author": "Alec Larson",