es-toolkit 1.22.0-dev.693 → 1.22.0-dev.695

package/dist/compat/array/dropWhile.d.mts

@@ -7,6 +7,11 @@
  * whether to continue dropping elements. The function is called with each element, index, and array, and dropping
  * continues as long as it returns true.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [1, 2, 3, 4, 5];
+ * const result = dropWhile(array, x => x < 3);
+ * result will be [3, 4, 5] since elements less than 3 are dropped.
  */
 declare function dropWhile<T>(arr: readonly T[], canContinueDropping: (item: T, index: number, arr: readonly T[]) => unknown): T[];
 /**
@@ -16,6 +21,11 @@ declare function dropWhile<T>(arr: readonly T[], canContinueDropping: (item: T,
  * @param {T[]} arr - The array from which to drop elements.
  * @param {Partial<T>} objectToDrop - An object specifying the properties to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ a: 1 }, { a: 2 }, { a: 3 }];
+ * const result = dropWhile(array, { a: 1 });
+ * result will be [{ a: 2 }, { a: 3 }] since the first object matches the properties of the provided object.
  */
 declare function dropWhile<T>(arr: readonly T[], objectToDrop: Partial<T>): T[];
 /**
@@ -25,6 +35,11 @@ declare function dropWhile<T>(arr: readonly T[], objectToDrop: Partial<T>): T[];
  * @param {T[]} arr - The array from which to drop elements.
  * @param {[keyof T, unknown]} propertyToDrop - A tuple containing the property key and the value to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const result = dropWhile(array, ['id', 1]);
+ * result will be [{ id: 2 }, { id: 3 }] since the first object has the id property matching the value 1.
  */
 declare function dropWhile<T>(arr: readonly T[], propertyToDrop: [keyof T, unknown]): T[];
 /**
@@ -34,6 +49,11 @@ declare function dropWhile<T>(arr: readonly T[], propertyToDrop: [keyof T, unkno
  * @param {T[]} arr - The array from which to drop elements.
  * @param {string} propertyToDrop - The name of the property to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ isActive: true }, { isActive: true }, { isActive: false }];
+ * const result = dropWhile(array, 'isActive');
+ * result will be [{ isActive: false }] since it drops elements until it finds one with a falsy isActive property.
  */
 declare function dropWhile<T>(arr: readonly T[], propertyToDrop: string): T[];
 

package/dist/compat/array/dropWhile.d.ts

@@ -7,6 +7,11 @@
  * whether to continue dropping elements. The function is called with each element, index, and array, and dropping
  * continues as long as it returns true.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [1, 2, 3, 4, 5];
+ * const result = dropWhile(array, x => x < 3);
+ * result will be [3, 4, 5] since elements less than 3 are dropped.
  */
 declare function dropWhile<T>(arr: readonly T[], canContinueDropping: (item: T, index: number, arr: readonly T[]) => unknown): T[];
 /**
@@ -16,6 +21,11 @@ declare function dropWhile<T>(arr: readonly T[], canContinueDropping: (item: T,
  * @param {T[]} arr - The array from which to drop elements.
  * @param {Partial<T>} objectToDrop - An object specifying the properties to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ a: 1 }, { a: 2 }, { a: 3 }];
+ * const result = dropWhile(array, { a: 1 });
+ * result will be [{ a: 2 }, { a: 3 }] since the first object matches the properties of the provided object.
  */
 declare function dropWhile<T>(arr: readonly T[], objectToDrop: Partial<T>): T[];
 /**
@@ -25,6 +35,11 @@ declare function dropWhile<T>(arr: readonly T[], objectToDrop: Partial<T>): T[];
  * @param {T[]} arr - The array from which to drop elements.
  * @param {[keyof T, unknown]} propertyToDrop - A tuple containing the property key and the value to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const result = dropWhile(array, ['id', 1]);
+ * result will be [{ id: 2 }, { id: 3 }] since the first object has the id property matching the value 1.
  */
 declare function dropWhile<T>(arr: readonly T[], propertyToDrop: [keyof T, unknown]): T[];
 /**
@@ -34,6 +49,11 @@ declare function dropWhile<T>(arr: readonly T[], propertyToDrop: [keyof T, unkno
  * @param {T[]} arr - The array from which to drop elements.
  * @param {string} propertyToDrop - The name of the property to match for dropping elements.
  * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ *
+ * @example
+ * const array = [{ isActive: true }, { isActive: true }, { isActive: false }];
+ * const result = dropWhile(array, 'isActive');
+ * result will be [{ isActive: false }] since it drops elements until it finds one with a falsy isActive property.
  */
 declare function dropWhile<T>(arr: readonly T[], propertyToDrop: string): T[];
 

package/dist/compat/array/filter.d.mts

@@ -5,7 +5,6 @@
  * @param {T[]} arr - The array to iterate over.
  * @param {(item: T, index: number, arr: T[]) => unknown} doesMatch - The function invoked per iteration.
  * @returns {T[]} - Returns a new array of elements that satisfy the given doesMatch function.
-
  *
  * @example
  * filter([1, 2, 3], n => n % 2 === 0)
@@ -30,7 +29,7 @@ declare function filter<T>(arr: readonly T[], doesMatch: Partial<T>): T[];
  * Filters elements in a arr that match the given key-value pair.
  *
  * @template T
- * @param {readonly T[]} arr - The array to iterate over.
+ * @param {T[]} arr - The array to iterate over.
  * @param {[keyof T, unknown]} doesMatchProperty - The key-value pair to match.
  * @returns {T[]} - Returns a new array of elements that match the given key-value pair.
  *
@@ -44,7 +43,7 @@ declare function filter<T>(arr: readonly T[], doesMatchProperty: [keyof T, unkno
  * Filters the arr, returning elements that contain the given property name.
  *
  * @template T
- * @param {readonly T[]} arr - The array to iterate over.
+ * @param {T[]} arr - The array to iterate over.
  * @param {string} propertyToCheck - The property name to check.
  * @returns {T[]} - Returns a new array of elements that match the given property name.
  *
@@ -58,25 +57,25 @@ declare function filter<T>(arr: readonly T[], propertyToCheck: string): T[];
  * Filters items from a object and returns an array of elements that match the given predicate function.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
- * @param {(item: T[keyof T], index: number, arr: T) => unknown} doesMatch - The function invoked per iteration.
+ * @param {T} object - The object to iterate over.
+ * @param {(value: T[keyof T], key: keyof T, object: T) => unknown} doesMatch - The function invoked per iteration.
  * @returns {T[]} - Returns a new array of elements that satisfy the given predicate function.
  *
  * @example
  * const obj = { item1: { a: 0 }, item2: { a: 1 }, item3: { a: 0 } }
- * filter(obj, items => items.a)
+ * filter(obj, value => value.a)
  * // => [{ a: 1 }]
  *
  * const obj = { a: 1, b: 2, c: 3 };
- * filter(obj, item => item > 2)
+ * filter(obj, value => value > 2)
  * // => [3]
  */
-declare function filter<T extends Record<string, unknown>>(object: T, doesMatch: (item: T[keyof T], index: number, object: T) => unknown): T[];
+declare function filter<T extends Record<string, unknown>>(object: T, doesMatch: (value: T[keyof T], key: keyof T, object: T) => unknown): T[];
 /**
  * Filters elements in a object that match the properties of the given partial object.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {Partial<T[keyof T]>} doesMatch - The partial object to match
  * @returns {T[]} - Returns a new array of elements that match the given properties.pair.
  *
@@ -90,7 +89,7 @@ declare function filter<T extends Record<string, unknown>>(object: T, doesMatch:
  * Filters elements in a arr that match the given key-value pair.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {[keyof T, unknown]} doesMatchProperty - The key-value pair to match.
  * @returns {T[]} - Returns a new array of elements that match the given key-value pair.
  *
@@ -104,7 +103,7 @@ declare function filter<T extends Record<string, unknown>>(object: T, doesMatchP
  * Filters the object, returning elements that contain the given property name.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {string} propertyToCheck - The property name to check.
  * @returns {T[]} - Returns a new array of elements that match the given property name.
  *

package/dist/compat/array/filter.d.ts

@@ -5,7 +5,6 @@
  * @param {T[]} arr - The array to iterate over.
  * @param {(item: T, index: number, arr: T[]) => unknown} doesMatch - The function invoked per iteration.
  * @returns {T[]} - Returns a new array of elements that satisfy the given doesMatch function.
-
  *
  * @example
  * filter([1, 2, 3], n => n % 2 === 0)
@@ -30,7 +29,7 @@ declare function filter<T>(arr: readonly T[], doesMatch: Partial<T>): T[];
  * Filters elements in a arr that match the given key-value pair.
  *
  * @template T
- * @param {readonly T[]} arr - The array to iterate over.
+ * @param {T[]} arr - The array to iterate over.
  * @param {[keyof T, unknown]} doesMatchProperty - The key-value pair to match.
  * @returns {T[]} - Returns a new array of elements that match the given key-value pair.
  *
@@ -44,7 +43,7 @@ declare function filter<T>(arr: readonly T[], doesMatchProperty: [keyof T, unkno
  * Filters the arr, returning elements that contain the given property name.
  *
  * @template T
- * @param {readonly T[]} arr - The array to iterate over.
+ * @param {T[]} arr - The array to iterate over.
  * @param {string} propertyToCheck - The property name to check.
  * @returns {T[]} - Returns a new array of elements that match the given property name.
  *
@@ -58,25 +57,25 @@ declare function filter<T>(arr: readonly T[], propertyToCheck: string): T[];
  * Filters items from a object and returns an array of elements that match the given predicate function.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
- * @param {(item: T[keyof T], index: number, arr: T) => unknown} doesMatch - The function invoked per iteration.
+ * @param {T} object - The object to iterate over.
+ * @param {(value: T[keyof T], key: keyof T, object: T) => unknown} doesMatch - The function invoked per iteration.
  * @returns {T[]} - Returns a new array of elements that satisfy the given predicate function.
  *
  * @example
  * const obj = { item1: { a: 0 }, item2: { a: 1 }, item3: { a: 0 } }
- * filter(obj, items => items.a)
+ * filter(obj, value => value.a)
  * // => [{ a: 1 }]
  *
  * const obj = { a: 1, b: 2, c: 3 };
- * filter(obj, item => item > 2)
+ * filter(obj, value => value > 2)
  * // => [3]
  */
-declare function filter<T extends Record<string, unknown>>(object: T, doesMatch: (item: T[keyof T], index: number, object: T) => unknown): T[];
+declare function filter<T extends Record<string, unknown>>(object: T, doesMatch: (value: T[keyof T], key: keyof T, object: T) => unknown): T[];
 /**
  * Filters elements in a object that match the properties of the given partial object.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {Partial<T[keyof T]>} doesMatch - The partial object to match
  * @returns {T[]} - Returns a new array of elements that match the given properties.pair.
  *
@@ -90,7 +89,7 @@ declare function filter<T extends Record<string, unknown>>(object: T, doesMatch:
  * Filters elements in a arr that match the given key-value pair.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {[keyof T, unknown]} doesMatchProperty - The key-value pair to match.
  * @returns {T[]} - Returns a new array of elements that match the given key-value pair.
  *
@@ -104,7 +103,7 @@ declare function filter<T extends Record<string, unknown>>(object: T, doesMatchP
  * Filters the object, returning elements that contain the given property name.
  *
  * @template T
- * @param {T extends Record<string, unknown> ? T : never} object - The object to iterate over.
+ * @param {T} object - The object to iterate over.
  * @param {string} propertyToCheck - The property name to check.
  * @returns {T[]} - Returns a new array of elements that match the given property name.
  *

package/dist/compat/array/filter.mjs

@@ -11,6 +11,19 @@ function filter(source, predicate) {
     const collection = isArray(source) ? source : Object.values(source);
     switch (typeof predicate) {
         case 'function': {
+            if (!Array.isArray(source)) {
+                const result = [];
+                const entries = Object.entries(source);
+                for (let i = 0; i < entries.length; i++) {
+                    const entry = entries[i];
+                    const key = entry[0];
+                    const value = entry[1];
+                    if (predicate(value, key, source)) {
+                        result.push(value);
+                    }
+                }
+                return result;
+            }
             return collection.filter(predicate);
         }
         case 'object': {

package/dist/compat/index.js

@@ -872,6 +872,19 @@ function filter(source, predicate) {
     const collection = isArray(source) ? source : Object.values(source);
     switch (typeof predicate) {
         case 'function': {
+            if (!Array.isArray(source)) {
+                const result = [];
+                const entries = Object.entries(source);
+                for (let i = 0; i < entries.length; i++) {
+                    const entry = entries[i];
+                    const key = entry[0];
+                    const value = entry[1];
+                    if (predicate(value, key, source)) {
+                        result.push(value);
+                    }
+                }
+                return result;
+            }
             return collection.filter(predicate);
         }
         case 'object': {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.22.0-dev.693+ac1e79e0",
+  "version": "1.22.0-dev.695+a093c732",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {