@web3r/flowerkit/dist/obj/getMapFromObj/index.d.mts

Tree-shakable JavaScript and TypeScript utility library for frontend/browser apps: DOM, events, arrays, objects, strings, date, JSON, and network helpers (ESM/CJS, SSR-friendly).

export type TGetMapFromObjArgs = Parameters<typeof getMapFromObj>;
export type TGetMapFromObjReturn = ReturnType<typeof getMapFromObj>;
/**
 * Gets a Map from object
 * @template K,V
 * @param {Record<string, V>} [obj={}] Source object
 * @param {(key: string, value: V, index: number) => boolean} [getFiltered] Filter function for each entry
 * @returns {Map<K, V>} Resulting map
 * @throws {TypeError} getMapFromObj: obj must be a plain object
 * @throws {TypeError} getMapFromObj: getFiltered must be a function
 * @example
 * // How to convert an object to ES6 Map and pass only number values?
 * const sourceObj = { hello: "world", goodbye: 1 };
 * const targetMap = getMapFromObj<string, number>(sourceObj as any, (_k, v) => typeof v === "number");
 * console.log(targetMap); // => Map { "goodbye" => 1 }
 */
export declare const getMapFromObj: <K extends string = string, V = unknown>(obj?: Record<string, V>, getFiltered?: (key: string, value: V, index: number) => boolean) => Map<K, V>;