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

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/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.694+e9123bea",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {