53 lines
2.0 KiB
JavaScript
53 lines
2.0 KiB
JavaScript
|
const require_isDeepKey = require("../_internal/isDeepKey.js");
|
||
|
|
const require_toPath = require("../util/toPath.js");
|
||
|
|
const require_isIndex = require("../_internal/isIndex.js");
|
||
|
|
const require_isArguments = require("../predicate/isArguments.js");
|
||
|
|
//#region src/compat/object/has.ts
|
||
|
|
/**
|
||
|
|
* Checks if a given path exists within an object.
|
||
|
|
*
|
||
|
|
* You can provide the path as a single property key, an array of property keys,
|
||
|
|
* or a string representing a deep path.
|
||
|
|
*
|
||
|
|
* If the path is an index and the object is an array or an arguments object, the function will verify
|
||
|
|
* if the index is valid and within the bounds of the array or arguments object, even if the array or
|
||
|
|
* arguments object is sparse (i.e., not all indexes are defined).
|
||
|
|
*
|
||
|
|
* @param {any} object - The object to query.
|
||
|
|
* @param {PropertyKey | readonly PropertyKey[]} path - The path to check. This can be a single property key,
|
||
|
|
* an array of property keys, or a string representing a deep path.
|
||
|
|
* @returns {boolean} Returns `true` if the path exists in the object, `false` otherwise.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
*
|
||
|
|
* const obj = { a: { b: { c: 3 } } };
|
||
|
|
*
|
||
|
|
* has(obj, 'a'); // true
|
||
|
|
* has(obj, ['a', 'b']); // true
|
||
|
|
* has(obj, ['a', 'b', 'c']); // true
|
||
|
|
* has(obj, 'a.b.c'); // true
|
||
|
|
* has(obj, 'a.b.d'); // false
|
||
|
|
* has(obj, ['a', 'b', 'c', 'd']); // false
|
||
|
|
* has([], 0); // false
|
||
|
|
* has([1, 2, 3], 2); // true
|
||
|
|
* has([1, 2, 3], 5); // false
|
||
|
|
*/
|
||
|
|
function has(object, path) {
|
||
|
|
let resolvedPath;
|
||
|
|
if (Array.isArray(path)) resolvedPath = path;
|
||
|
|
else if (typeof path === "string" && require_isDeepKey.isDeepKey(path) && object?.[path] == null) resolvedPath = require_toPath.toPath(path);
|
||
|
|
else resolvedPath = [path];
|
||
|
|
if (resolvedPath.length === 0) return false;
|
||
|
|
let current = object;
|
||
|
|
for (let i = 0; i < resolvedPath.length; i++) {
|
||
|
|
const key = resolvedPath[i];
|
||
|
|
if (current == null || !Object.hasOwn(current, key)) {
|
||
|
|
if (!((Array.isArray(current) || require_isArguments.isArguments(current)) && require_isIndex.isIndex(key) && key < current.length)) return false;
|
||
|
|
}
|
||
|
|
current = current[key];
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
//#endregion
|
||
|
|
exports.has = has;
|