LendAndRegret/node_modules/es-toolkit/dist/map/hasValue.d.ts
2026-05-02 17:27:43 +08:00

29 lines
887 B
TypeScript

/**
* Checks if a Map contains a specific value.
*
* This function iterates through all values in the Map and checks if any value
* is equal to the search element using SameValueZero comparison (similar to
* Array.prototype.includes). This means that NaN is considered equal to NaN.
*
* @template K - The type of keys in the Map.
* @template V - The type of values in the Map.
* @param {Map<K, V>} map - The Map to search.
* @param {V} searchElement - The value to search for.
* @returns {boolean} true if the Map contains the value, false otherwise.
*
* @example
* const map = new Map([
* ['a', 1],
* ['b', 2],
* ['c', 3]
* ]);
* const result = hasValue(map, 2);
* // result will be: true
*
* const result2 = hasValue(map, 5);
* // result2 will be: false
*/
declare function hasValue<K, V>(map: Map<K, V>, searchElement: V): boolean;
export { hasValue };