Skip to main content
Version: 1.2.0

resolveMap

Using

Function that retrieves or resolves only Map values. This function should handle various input types, resolving functions if encountered, and ultimately return an Map if possible.

If the final resolved value is not an Map or if a function remains unresolved within the specified depth, the function return undefined.

Arguments

ArgumentTypeDescriptionExample
valueMap
function
Value for resolve.new Map()
() => () => new Map([["key1", "value1"]])
depthnumberDepth of maximum resolve.2

Returns

Map | undefined — Returns the resolved Map otherwise undefined.

Examples

resolveMap(
new Map([
['key1', 'value1'],
['key2', 'value2'],
]),
);
// Map { "key1" => "value1", "key2" => "value2" }

resolveMap(() => () => new Map([['name', 'Alina']]));
// Map { "name" => "Alina" }

resolveMap('text');
// undefined

resolveMap(
() =>
new Map([
['name', 'Alina'],
['age', '23'],
]),
1,
);
// Map { "name" => "Alina", "age" => 23 }

resolveMap(
() =>
new Map([
['name', 'Alina'],
['age', '23'],
]),
2,
);
// Map { "name" => "Alina", "age" => 23 }

resolveMap(
() =>
new Map([
['name', 'Alina'],
['age', '23'],
]),
0,
);
// undefined

Resources

📦 Since:1.1.0
📦 Last updated:1.1.0
📦 Available in:1.3.0