es-toolkit 1.51.0-dev.2076 → 1.51.0-dev.2077

package/dist/object/omitBy.d.mts

@@ -1,3 +1,5 @@
+import { ObjectKeys } from "../types/ObjectKeys.mjs";
+
 //#region src/object/omitBy.d.ts
 /**
  * Creates a new object composed of the properties that do not satisfy the predicate function.
@@ -9,7 +11,7 @@
  * @param obj - The object to omit properties from.
  * @param shouldOmit - A predicate function that determines
  * whether a property should be omitted. It takes the property's key and value as arguments and returns `true`
- * if the property should be omitted, and `false` otherwise.
+ * if the property should be omitted, and `false` otherwise. Numeric keys are passed as strings.
  * @returns A new object with the properties that do not satisfy the predicate function.
  *
  * @example
@@ -18,6 +20,6 @@
  * const result = omitBy(obj, shouldOmit);
  * // result will be { a: 1, c: 3 }
  */
-declare function omitBy<T extends Record<string, any>>(obj: T, shouldOmit: (value: T[keyof T], key: keyof T) => boolean): Partial<T>;
+declare function omitBy<T extends Record<string, any>>(obj: T, shouldOmit: (value: T[keyof T], key: ObjectKeys<T>) => boolean): Partial<T>;
 //#endregion
 export { omitBy };

package/dist/object/omitBy.d.ts

@@ -1,3 +1,5 @@
+import { ObjectKeys } from "../types/ObjectKeys.js";
+
 //#region src/object/omitBy.d.ts
 /**
  * Creates a new object composed of the properties that do not satisfy the predicate function.
@@ -9,7 +11,7 @@
  * @param obj - The object to omit properties from.
  * @param shouldOmit - A predicate function that determines
  * whether a property should be omitted. It takes the property's key and value as arguments and returns `true`
- * if the property should be omitted, and `false` otherwise.
+ * if the property should be omitted, and `false` otherwise. Numeric keys are passed as strings.
  * @returns A new object with the properties that do not satisfy the predicate function.
  *
  * @example
@@ -18,6 +20,6 @@
  * const result = omitBy(obj, shouldOmit);
  * // result will be { a: 1, c: 3 }
  */
-declare function omitBy<T extends Record<string, any>>(obj: T, shouldOmit: (value: T[keyof T], key: keyof T) => boolean): Partial<T>;
+declare function omitBy<T extends Record<string, any>>(obj: T, shouldOmit: (value: T[keyof T], key: ObjectKeys<T>) => boolean): Partial<T>;
 //#endregion
 export { omitBy };

package/dist/object/omitBy.js

@@ -9,7 +9,7 @@
 * @param obj - The object to omit properties from.
 * @param shouldOmit - A predicate function that determines
 * whether a property should be omitted. It takes the property's key and value as arguments and returns `true`
-* if the property should be omitted, and `false` otherwise.
+* if the property should be omitted, and `false` otherwise. Numeric keys are passed as strings.
 * @returns A new object with the properties that do not satisfy the predicate function.
 *
 * @example
@@ -23,8 +23,9 @@ function omitBy(obj, shouldOmit) {
 	const keys = Object.keys(obj);
 	for (let i = 0; i < keys.length; i++) {
 		const key = keys[i];
-		const value = obj[key];
-		if (!shouldOmit(value, key)) result[key] = value;
+		const objectKey = key;
+		const value = obj[objectKey];
+		if (!shouldOmit(value, key)) result[objectKey] = value;
 	}
 	return result;
 }

package/dist/object/omitBy.mjs

@@ -9,7 +9,7 @@
 * @param obj - The object to omit properties from.
 * @param shouldOmit - A predicate function that determines
 * whether a property should be omitted. It takes the property's key and value as arguments and returns `true`
-* if the property should be omitted, and `false` otherwise.
+* if the property should be omitted, and `false` otherwise. Numeric keys are passed as strings.
 * @returns A new object with the properties that do not satisfy the predicate function.
 *
 * @example
@@ -23,8 +23,9 @@ function omitBy(obj, shouldOmit) {
 	const keys = Object.keys(obj);
 	for (let i = 0; i < keys.length; i++) {
 		const key = keys[i];
-		const value = obj[key];
-		if (!shouldOmit(value, key)) result[key] = value;
+		const objectKey = key;
+		const value = obj[objectKey];
+		if (!shouldOmit(value, key)) result[objectKey] = value;
 	}
 	return result;
 }

package/dist/object/pickBy.d.mts

@@ -1,3 +1,5 @@
+import { ObjectKeys } from "../types/ObjectKeys.mjs";
+
 //#region src/object/pickBy.d.ts
 /**
  * Creates a new object composed of the properties that satisfy the predicate function.
@@ -9,7 +11,7 @@
  * @param obj - The object to pick properties from.
  * @param shouldPick - A predicate function that determines
  * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
- * if the property should be picked, and `false` otherwise.
+ * if the property should be picked, and `false` otherwise. Numeric keys are passed as strings.
  * @returns A new object with the properties that satisfy the predicate function.
  *
  * @example
@@ -18,6 +20,6 @@
  * const result = pickBy(obj, shouldPick);
  * // result will be { b: 'pick' }
  */
-declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: keyof T) => boolean): Partial<T>;
+declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: ObjectKeys<T>) => boolean): Partial<T>;
 //#endregion
 export { pickBy };

package/dist/object/pickBy.d.ts

@@ -1,3 +1,5 @@
+import { ObjectKeys } from "../types/ObjectKeys.js";
+
 //#region src/object/pickBy.d.ts
 /**
  * Creates a new object composed of the properties that satisfy the predicate function.
@@ -9,7 +11,7 @@
  * @param obj - The object to pick properties from.
  * @param shouldPick - A predicate function that determines
  * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
- * if the property should be picked, and `false` otherwise.
+ * if the property should be picked, and `false` otherwise. Numeric keys are passed as strings.
  * @returns A new object with the properties that satisfy the predicate function.
  *
  * @example
@@ -18,6 +20,6 @@
  * const result = pickBy(obj, shouldPick);
  * // result will be { b: 'pick' }
  */
-declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: keyof T) => boolean): Partial<T>;
+declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: ObjectKeys<T>) => boolean): Partial<T>;
 //#endregion
 export { pickBy };

package/dist/object/pickBy.js

@@ -9,7 +9,7 @@
 * @param obj - The object to pick properties from.
 * @param shouldPick - A predicate function that determines
 * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
-* if the property should be picked, and `false` otherwise.
+* if the property should be picked, and `false` otherwise. Numeric keys are passed as strings.
 * @returns A new object with the properties that satisfy the predicate function.
 *
 * @example
@@ -23,8 +23,9 @@ function pickBy(obj, shouldPick) {
 	const keys = Object.keys(obj);
 	for (let i = 0; i < keys.length; i++) {
 		const key = keys[i];
-		const value = obj[key];
-		if (shouldPick(value, key)) result[key] = value;
+		const objectKey = key;
+		const value = obj[objectKey];
+		if (shouldPick(value, key)) result[objectKey] = value;
 	}
 	return result;
 }

package/dist/object/pickBy.mjs

@@ -9,7 +9,7 @@
 * @param obj - The object to pick properties from.
 * @param shouldPick - A predicate function that determines
 * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
-* if the property should be picked, and `false` otherwise.
+* if the property should be picked, and `false` otherwise. Numeric keys are passed as strings.
 * @returns A new object with the properties that satisfy the predicate function.
 *
 * @example
@@ -23,8 +23,9 @@ function pickBy(obj, shouldPick) {
 	const keys = Object.keys(obj);
 	for (let i = 0; i < keys.length; i++) {
 		const key = keys[i];
-		const value = obj[key];
-		if (shouldPick(value, key)) result[key] = value;
+		const objectKey = key;
+		const value = obj[objectKey];
+		if (shouldPick(value, key)) result[objectKey] = value;
 	}
 	return result;
 }

package/dist/types/ObjectKeys.d.mts

@@ -0,0 +1,19 @@
+//#region src/types/ObjectKeys.d.ts
+/**
+ * Creates a union of the keys of `T` as they are returned by `Object.keys`:
+ * numeric keys are converted to strings and symbol keys are excluded. The key-side
+ * counterpart to `ValueOf`.
+ *
+ * @template T - The object type to read keys from.
+ *
+ * @example
+ * type Keys = ObjectKeys<{ a: number; 1: string }>;
+ * // => 'a' | '1'
+ *
+ * const obj = { a: 1, b: 2 };
+ * const keys = Object.keys(obj) as Array<ObjectKeys<typeof obj>>;
+ * // => Array<'a' | 'b'>
+ */
+type ObjectKeys<T> = `${Exclude<keyof T, symbol>}`;
+//#endregion
+export { ObjectKeys };

package/dist/types/ObjectKeys.d.ts

@@ -0,0 +1,19 @@
+//#region src/types/ObjectKeys.d.ts
+/**
+ * Creates a union of the keys of `T` as they are returned by `Object.keys`:
+ * numeric keys are converted to strings and symbol keys are excluded. The key-side
+ * counterpart to `ValueOf`.
+ *
+ * @template T - The object type to read keys from.
+ *
+ * @example
+ * type Keys = ObjectKeys<{ a: number; 1: string }>;
+ * // => 'a' | '1'
+ *
+ * const obj = { a: 1, b: 2 };
+ * const keys = Object.keys(obj) as Array<ObjectKeys<typeof obj>>;
+ * // => Array<'a' | 'b'>
+ */
+type ObjectKeys<T> = `${Exclude<keyof T, symbol>}`;
+//#endregion
+export { ObjectKeys };

package/dist/types/index.d.mts

@@ -1,3 +1,4 @@
+import { ObjectKeys } from "./ObjectKeys.mjs";
 import { ToCamelCaseKeys } from "./ToCamelCaseKeys.mjs";
 import { ToConstantCaseKeys } from "./ToConstantCaseKeys.mjs";
 import { ToKebabCaseKeys } from "./ToKebabCaseKeys.mjs";
@@ -9,4 +10,4 @@ import { NonEmptyArray } from "./NonEmptyArray.mjs";
 import { Simplify } from "./Simplify.mjs";
 import { ValueOf } from "./ValueOf.mjs";
 import { Writable } from "./Writable.mjs";
-export { type DeepPartial, type DeepReadonly, type NonEmptyArray, type Simplify, type ToCamelCaseKeys, type ToConstantCaseKeys, type ToKebabCaseKeys, type ToPascalCaseKeys, type ToSnakeCaseKeys, type ValueOf, type Writable };
+export { type DeepPartial, type DeepReadonly, type NonEmptyArray, type ObjectKeys, type Simplify, type ToCamelCaseKeys, type ToConstantCaseKeys, type ToKebabCaseKeys, type ToPascalCaseKeys, type ToSnakeCaseKeys, type ValueOf, type Writable };

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import { ObjectKeys } from "./ObjectKeys.js";
 import { ToCamelCaseKeys } from "./ToCamelCaseKeys.js";
 import { ToConstantCaseKeys } from "./ToConstantCaseKeys.js";
 import { ToKebabCaseKeys } from "./ToKebabCaseKeys.js";
@@ -9,4 +10,4 @@ import { NonEmptyArray } from "./NonEmptyArray.js";
 import { Simplify } from "./Simplify.js";
 import { ValueOf } from "./ValueOf.js";
 import { Writable } from "./Writable.js";
-export { type DeepPartial, type DeepReadonly, type NonEmptyArray, type Simplify, type ToCamelCaseKeys, type ToConstantCaseKeys, type ToKebabCaseKeys, type ToPascalCaseKeys, type ToSnakeCaseKeys, type ValueOf, type Writable };
+export { type DeepPartial, type DeepReadonly, type NonEmptyArray, type ObjectKeys, type Simplify, type ToCamelCaseKeys, type ToConstantCaseKeys, type ToKebabCaseKeys, type ToPascalCaseKeys, type ToSnakeCaseKeys, type ValueOf, type Writable };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-toolkit",
-  "version": "1.51.0-dev.2076+893f52aa",
+  "version": "1.51.0-dev.2077+61705608",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
   "homepage": "https://es-toolkit.dev",
   "bugs": "https://github.com/toss/es-toolkit/issues",