server-json/node_modules/ramda/es/pathEq.js
2024-11-01 08:00:42 +00:00

33 lines
No EOL
1.2 KiB
JavaScript

import _curry3 from "./internal/_curry3.js";
import _path from "./internal/_path.js";
import equals from "./equals.js";
/**
* Determines whether a nested path on an object has a specific value, in
* [`R.equals`](#equals) terms. Most likely used to filter a list.
*
* @func
* @memberOf R
* @since v0.7.0
* @category Relation
* @typedefn Idx = String | Int | Symbol
* @sig a -> [Idx] -> {a} -> Boolean
* @param {*} val The value to compare the nested property with
* @param {Array} path The path of the nested property to use
* @param {Object} obj The object to check the nested property in
* @return {Boolean} `true` if the value equals the nested object property,
* `false` otherwise.
* @see R.whereEq, R.propEq, R.pathSatisfies, R.equals
* @example
*
* const user1 = { address: { zipCode: 90210 } };
* const user2 = { address: { zipCode: 55555 } };
* const user3 = { name: 'Bob' };
* const users = [ user1, user2, user3 ];
* const isFamous = R.pathEq(90210, ['address', 'zipCode']);
* R.filter(isFamous, users); //=> [ user1 ]
*/
var pathEq = /*#__PURE__*/_curry3(function pathEq(val, pathAr, obj) {
return equals(_path(pathAr, obj), val);
});
export default pathEq;