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

29 lines
1.0 KiB
TypeScript

/**
* Tests whether at least one entry in a Map satisfies the provided predicate function.
*
* This function iterates through the entries of the Map and checks if the predicate function
* returns true for at least one entry. It returns true if any entry satisfies the predicate,
* and false otherwise.
*
* @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 test.
* @param {(value: V, key: K, map: Map<K, V>) => boolean} doesMatch - A predicate function that tests each entry.
* @returns {boolean} true if at least one entry satisfies the predicate, false otherwise.
*
* @example
* const map = new Map([
* ['a', 1],
* ['b', 2],
* ['c', 3]
* ]);
* const result = some(map, (value) => value > 2);
* // result will be: true
*
* const result2 = some(map, (value) => value > 5);
* // result2 will be: false
*/
declare function some<K, V>(map: Map<K, V>, doesMatch: (value: V, key: K, map: Map<K, V>) => boolean): boolean;
export { some };