es-toolkit 1.21.0-dev.685 → 1.21.0-dev.687

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

@@ -0,0 +1,62 @@
+/**
+ * Checks if an item is included in an array.
+ *
+ * @param {T[]} arr - The array to search in.
+ * @param {T} item - The item to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the array.
+ * @returns {boolean} `true` if the item is found in the array, `false` otherwise.
+ *
+ * @example
+ * includes([1, 2, 3], 2); // true
+ * includes([1, 2, 3], 4); // false
+ * includes([1, 2, 3], 3, -1); // true
+ */
+declare function includes<T>(arr: readonly T[], item: T, fromIndex?: number): boolean;
+/**
+ * Checks if a value is included in an object.
+ *
+ * @param {T} obj - The object to search in.
+ * @param {T[keyof T]} value - The value to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the array.
+ * @returns {boolean} `true` if the value is found in the object, `false` otherwise.
+ *
+ * @example
+ * includes({ a: 1, b: 'a', c: NaN }, 1); // true
+ * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
+ * includes({ a: 1, b: 'a', c: NaN }, NaN); // true
+ * includes({ [Symbol('sym1')]: 1 }, 1); // false
+ */
+declare function includes<T extends Record<string, any>>(obj: T, value: T[keyof T], fromIndex?: number): boolean;
+/**
+ * Checks if a substring is included in a string.
+ *
+ * @param {string} str - The string to search in.
+ * @param {string} substr - The substring to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the string.
+ * @returns {boolean} `true` if the substring is found in the string, `false` otherwise.
+ *
+ * @example
+ * includes('hello world', 'world'); // true
+ * includes('hello world', 'test'); // false
+ * includes('hello world', 'o', 5); // true
+ */
+declare function includes(str: string, substr: string, fromIndex?: number): boolean;
+/**
+ * Checks if a specified value exists within a given source, which can be an array, an object, or a string.
+ *
+ * The comparison uses SameValueZero to check for inclusion.
+ *
+ * @param {T[] | Record<string, any> | string} source - The source to search in. It can be an array, an object, or a string.
+ * @param {T} [target] - The value to search for in the source.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
+ * @returns {boolean} `true` if the value is found in the source, `false` otherwise.
+ *
+ * @example
+ * includes([1, 2, 3], 2); // true
+ * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
+ * includes('hello world', 'world'); // true
+ * includes('hello world', 'test'); // false
+ */
+declare function includes<T>(source: readonly T[] | Record<string, any> | string, target?: T, fromIndex?: number): boolean;
+
+export { includes };

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

@@ -0,0 +1,62 @@
+/**
+ * Checks if an item is included in an array.
+ *
+ * @param {T[]} arr - The array to search in.
+ * @param {T} item - The item to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the array.
+ * @returns {boolean} `true` if the item is found in the array, `false` otherwise.
+ *
+ * @example
+ * includes([1, 2, 3], 2); // true
+ * includes([1, 2, 3], 4); // false
+ * includes([1, 2, 3], 3, -1); // true
+ */
+declare function includes<T>(arr: readonly T[], item: T, fromIndex?: number): boolean;
+/**
+ * Checks if a value is included in an object.
+ *
+ * @param {T} obj - The object to search in.
+ * @param {T[keyof T]} value - The value to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the array.
+ * @returns {boolean} `true` if the value is found in the object, `false` otherwise.
+ *
+ * @example
+ * includes({ a: 1, b: 'a', c: NaN }, 1); // true
+ * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
+ * includes({ a: 1, b: 'a', c: NaN }, NaN); // true
+ * includes({ [Symbol('sym1')]: 1 }, 1); // false
+ */
+declare function includes<T extends Record<string, any>>(obj: T, value: T[keyof T], fromIndex?: number): boolean;
+/**
+ * Checks if a substring is included in a string.
+ *
+ * @param {string} str - The string to search in.
+ * @param {string} substr - The substring to search for.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the string.
+ * @returns {boolean} `true` if the substring is found in the string, `false` otherwise.
+ *
+ * @example
+ * includes('hello world', 'world'); // true
+ * includes('hello world', 'test'); // false
+ * includes('hello world', 'o', 5); // true
+ */
+declare function includes(str: string, substr: string, fromIndex?: number): boolean;
+/**
+ * Checks if a specified value exists within a given source, which can be an array, an object, or a string.
+ *
+ * The comparison uses SameValueZero to check for inclusion.
+ *
+ * @param {T[] | Record<string, any> | string} source - The source to search in. It can be an array, an object, or a string.
+ * @param {T} [target] - The value to search for in the source.
+ * @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
+ * @returns {boolean} `true` if the value is found in the source, `false` otherwise.
+ *
+ * @example
+ * includes([1, 2, 3], 2); // true
+ * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
+ * includes('hello world', 'world'); // true
+ * includes('hello world', 'test'); // false
+ */
+declare function includes<T>(source: readonly T[] | Record<string, any> | string, target?: T, fromIndex?: number): boolean;
+
+export { includes };

package/dist/compat/{object → array}/includes.mjs

@@ -5,27 +5,32 @@ function includes(source, target, fromIndex, guard) {
     if (source == null) {
         return false;
     }
-    let safeIndex = fromIndex && !guard ? toInteger(fromIndex) : 0;
+    if (guard || !fromIndex) {
+        fromIndex = 0;
+    }
+    else {
+        fromIndex = toInteger(fromIndex);
+    }
     if (isString(source)) {
-        if (safeIndex > source.length || target instanceof RegExp) {
+        if (fromIndex > source.length || target instanceof RegExp) {
             return false;
         }
-        if (safeIndex < 0) {
-            safeIndex = Math.max(0, source.length + safeIndex);
+        if (fromIndex < 0) {
+            fromIndex = Math.max(0, source.length + fromIndex);
         }
-        return source.includes(target, safeIndex);
+        return source.includes(target, fromIndex);
     }
     if (Array.isArray(source)) {
-        return source.includes(target, safeIndex);
+        return source.includes(target, fromIndex);
     }
     const keys = [];
     for (const key in source) {
         keys.push(key);
     }
-    if (safeIndex < 0) {
-        safeIndex = Math.max(0, keys.length + safeIndex);
+    if (fromIndex < 0) {
+        fromIndex = Math.max(0, keys.length + fromIndex);
     }
-    for (let i = safeIndex; i < keys.length; i++) {
+    for (let i = fromIndex; i < keys.length; i++) {
         const value = Reflect.get(source, keys[i]);
         if (value === target || (Number.isNaN(value) && Number.isNaN(target))) {
             return true;

package/dist/compat/index.d.mts

@@ -106,6 +106,7 @@ export { findLastIndex } from './array/findLastIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
+export { includes } from './array/includes.mjs';
 export { indexOf } from './array/indexOf.mjs';
 export { join } from './array/join.mjs';
 export { orderBy } from './array/orderBy.mjs';
@@ -139,7 +140,6 @@ export { mergeWith } from './object/mergeWith.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
 export { unset } from './object/unset.mjs';
 export { cloneDeep } from './object/cloneDeep.mjs';
-export { includes } from './object/includes.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
 export { isArray } from './predicate/isArray.mjs';
 export { isArguments } from './predicate/isArguments.mjs';

package/dist/compat/index.d.ts

@@ -106,6 +106,7 @@ export { findLastIndex } from './array/findLastIndex.js';
 export { flatten } from './array/flatten.js';
 export { flattenDeep } from './array/flattenDeep.js';
 export { flattenDepth } from './array/flattenDepth.js';
+export { includes } from './array/includes.js';
 export { indexOf } from './array/indexOf.js';
 export { join } from './array/join.js';
 export { orderBy } from './array/orderBy.js';
@@ -139,7 +140,6 @@ export { mergeWith } from './object/mergeWith.js';
 export { fromPairs } from './object/fromPairs.js';
 export { unset } from './object/unset.js';
 export { cloneDeep } from './object/cloneDeep.js';
-export { includes } from './object/includes.js';
 export { isPlainObject } from './predicate/isPlainObject.js';
 export { isArray } from './predicate/isArray.js';
 export { isArguments } from './predicate/isArguments.js';

package/dist/compat/index.js

@@ -571,6 +571,77 @@ function flattenDepth(value, depth = 1) {
     return flatten(value, depth);
 }
 
+function isString(value) {
+    return typeof value === 'string' || value instanceof String;
+}
+
+function isSymbol(value) {
+    return typeof value === 'symbol' || value instanceof Symbol;
+}
+
+function toNumber(value) {
+    if (isSymbol(value)) {
+        return NaN;
+    }
+    return Number(value);
+}
+
+function toFinite(value) {
+    if (!value) {
+        return value === 0 ? value : 0;
+    }
+    value = toNumber(value);
+    if (value === Infinity || value === -Infinity) {
+        const sign = value < 0 ? -1 : 1;
+        return sign * Number.MAX_VALUE;
+    }
+    return value === value ? value : 0;
+}
+
+function toInteger(value) {
+    const finite = toFinite(value);
+    const remainder = finite % 1;
+    return remainder ? finite - remainder : finite;
+}
+
+function includes(source, target, fromIndex, guard) {
+    if (source == null) {
+        return false;
+    }
+    if (guard || !fromIndex) {
+        fromIndex = 0;
+    }
+    else {
+        fromIndex = toInteger(fromIndex);
+    }
+    if (isString(source)) {
+        if (fromIndex > source.length || target instanceof RegExp) {
+            return false;
+        }
+        if (fromIndex < 0) {
+            fromIndex = Math.max(0, source.length + fromIndex);
+        }
+        return source.includes(target, fromIndex);
+    }
+    if (Array.isArray(source)) {
+        return source.includes(target, fromIndex);
+    }
+    const keys = [];
+    for (const key in source) {
+        keys.push(key);
+    }
+    if (fromIndex < 0) {
+        fromIndex = Math.max(0, keys.length + fromIndex);
+    }
+    for (let i = fromIndex; i < keys.length; i++) {
+        const value = Reflect.get(source, keys[i]);
+        if (value === target || (Number.isNaN(value) && Number.isNaN(target))) {
+            return true;
+        }
+    }
+    return false;
+}
+
 function indexOf(array, searchElement, fromIndex) {
     if (array == null) {
         return -1;
@@ -629,10 +700,6 @@ const compareValues = (a, b, order) => {
     return 0;
 };
 
-function isSymbol(value) {
-    return typeof value === 'symbol' || value instanceof Symbol;
-}
-
 const regexIsDeepProp = /\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/;
 const regexIsPlainProp = /^\w*$/;
 function isKey(value, object) {
@@ -1323,68 +1390,6 @@ function fromPairs(pairs) {
     return result;
 }
 
-function isString(value) {
-    return typeof value === 'string' || value instanceof String;
-}
-
-function toNumber(value) {
-    if (isSymbol(value)) {
-        return NaN;
-    }
-    return Number(value);
-}
-
-function toFinite(value) {
-    if (!value) {
-        return value === 0 ? value : 0;
-    }
-    value = toNumber(value);
-    if (value === Infinity || value === -Infinity) {
-        const sign = value < 0 ? -1 : 1;
-        return sign * Number.MAX_VALUE;
-    }
-    return value === value ? value : 0;
-}
-
-function toInteger(value) {
-    const finite = toFinite(value);
-    const remainder = finite % 1;
-    return remainder ? finite - remainder : finite;
-}
-
-function includes(source, target, fromIndex, guard) {
-    if (source == null) {
-        return false;
-    }
-    let safeIndex = fromIndex && !guard ? toInteger(fromIndex) : 0;
-    if (isString(source)) {
-        if (safeIndex > source.length || target instanceof RegExp) {
-            return false;
-        }
-        if (safeIndex < 0) {
-            safeIndex = Math.max(0, source.length + safeIndex);
-        }
-        return source.includes(target, safeIndex);
-    }
-    if (Array.isArray(source)) {
-        return source.includes(target, safeIndex);
-    }
-    const keys = [];
-    for (const key in source) {
-        keys.push(key);
-    }
-    if (safeIndex < 0) {
-        safeIndex = Math.max(0, keys.length + safeIndex);
-    }
-    for (let i = safeIndex; i < keys.length; i++) {
-        const value = Reflect.get(source, keys[i]);
-        if (value === target || (Number.isNaN(value) && Number.isNaN(target))) {
-            return true;
-        }
-    }
-    return false;
-}
-
 function isObject(value) {
     return value !== null && (typeof value === 'object' || typeof value === 'function');
 }

package/dist/compat/index.mjs

@@ -107,6 +107,7 @@ export { findLastIndex } from './array/findLastIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
+export { includes } from './array/includes.mjs';
 export { indexOf } from './array/indexOf.mjs';
 export { join } from './array/join.mjs';
 export { orderBy } from './array/orderBy.mjs';
@@ -140,7 +141,6 @@ export { mergeWith } from './object/mergeWith.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
 export { unset } from './object/unset.mjs';
 export { cloneDeep } from './object/cloneDeep.mjs';
-export { includes } from './object/includes.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
 export { isArray } from './predicate/isArray.mjs';
 export { isArguments } from './predicate/isArguments.mjs';

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.21.0-dev.685+4068e43b",
+  "version": "1.21.0-dev.687+5c39817c",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {

package/dist/compat/object/includes.d.mts

@@ -1,20 +0,0 @@
-/**
- * Checks if value is in source.
- * If source is a string, it's checked for a substring of value, otherwise SameValueZero is used for equality comparisons.
- * If fromIndex is negative, it's used as the offset from the end of source.
- *
- * @param {unknown[] | object | string | null | undefined} source - The source to search in.
- * @param {unknown} [target] - The value to search for.
- * @param {unknown} [fromIndex] - The index to search from.
- * @param {unknown} [guard] - Enables use as an iteratee for methods like `_.every`.
- * @returns {boolean} `true` if the object includes the target value, `false` otherwise.
- *
- * @example
- * includes({ a: 1, b: 'a', c: NaN }, 1); // true
- * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
- * includes({ a: 1, b: 'a', c: NaN }, NaN); // true
- * includes({ [Symbol('sym1')]: 1 }, 1); // false
- */
-declare function includes(source: readonly unknown[] | object | string | null | undefined, target?: unknown, fromIndex?: unknown, guard?: unknown): boolean;
-
-export { includes };

package/dist/compat/object/includes.d.ts

@@ -1,20 +0,0 @@
-/**
- * Checks if value is in source.
- * If source is a string, it's checked for a substring of value, otherwise SameValueZero is used for equality comparisons.
- * If fromIndex is negative, it's used as the offset from the end of source.
- *
- * @param {unknown[] | object | string | null | undefined} source - The source to search in.
- * @param {unknown} [target] - The value to search for.
- * @param {unknown} [fromIndex] - The index to search from.
- * @param {unknown} [guard] - Enables use as an iteratee for methods like `_.every`.
- * @returns {boolean} `true` if the object includes the target value, `false` otherwise.
- *
- * @example
- * includes({ a: 1, b: 'a', c: NaN }, 1); // true
- * includes({ a: 1, b: 'a', c: NaN }, 'a'); // true
- * includes({ a: 1, b: 'a', c: NaN }, NaN); // true
- * includes({ [Symbol('sym1')]: 1 }, 1); // false
- */
-declare function includes(source: readonly unknown[] | object | string | null | undefined, target?: unknown, fromIndex?: unknown, guard?: unknown): boolean;
-
-export { includes };