> For the complete documentation index, see [llms.txt](https://docs.angular-package.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.angular-package.dev/sass/map/overview.md).

# Overview

Extension for sass:map module

##

## Pattern

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>pattern.is()</code></strong></td><td>Checks whether the <a href="/sass/map/pattern/pattern.is.md#usdvalue"><code>$value</code></a> is a map pattern.</td><td></td><td><a href="/sass/map/pattern/pattern.is.md">pattern.is()</a></td></tr><tr><td><strong>Variables</strong></td><td></td><td></td><td><a href="/sass/map/pattern/variables.md">Variables</a></td></tr></tbody></table>

## Pick

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>pick.key-substring()</code></strong></td><td>Returns a copy of <a href="/sass/map/pick/pick.key-substring.md#usdmap"><code>$map</code></a> with keys of <a href="/pages/jvEwqTiSGJCyJ9EQ05NG#usdsubstrings..."><code>$substrings</code></a>.</td><td></td><td><a href="/sass/map/pick/pick.key-substring.md">pick.key-substring()</a></td></tr><tr><td><strong><code>pick.key-type()</code></strong></td><td>Returns a map with values of <a href="/pages/YLZeplJSpRPqjuj9nlx0#usdtypes..."><code>$types</code></a>.</td><td></td><td><a href="/sass/map/pick/pick.key-type.md">pick.key-type()</a></td></tr><tr><td><strong><code>pick.pattern()</code></strong></td><td>Returns a copy of <a href="/sass/map/pick/pick.pattern.md#usdmap"><code>$map</code></a> filtered by using pattern.</td><td></td><td><a href="/sass/map/pick/pick.pattern.md">pick.pattern()</a></td></tr><tr><td><strong><code>pick.type()</code></strong></td><td>Picks the properties with values and/or keys of the specified type.</td><td></td><td><a href="/sass/map/pick/pick.type.md">pick.type()</a></td></tr><tr><td><strong><code>pick.value-type()</code></strong></td><td>Picks the properties with values of the specified <a href="/pages/kgqkgfI3goWFjpOChpDd#usdtypes..."><code>$types</code></a>.</td><td></td><td><a href="/sass/map/pick/pick.value-type.md">pick.value-type()</a></td></tr></tbody></table>

## Map

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>map.deep-merge-key()</code></strong></td><td>Merges <a href="/sass/map/map.deep-merge-key.md#usdmap"><code>$map</code></a> with retrieved values from <a href="/pages/yDXcMKSYwR1MMCeR6Wfn#usdkeys..."><code>$keys</code></a> of this <a href="/sass/map/map.deep-merge-key.md#usdmap"><code>$map</code></a>.</td><td></td><td><a href="/sass/map/map.deep-merge-key.md">map.deep-merge-key()</a></td></tr><tr><td><strong><code>map.deep-merge()</code></strong></td><td>Merges multiple maps by using sass original <code>deep-merge()</code>.</td><td><a data-footnote-ref href="#user-content-fn-1">modified</a></td><td><a href="/sass/map/map.deep-merge.md">map.deep-merge()</a></td></tr><tr><td><strong><code>map.get()</code></strong></td><td>Returns the value associated with <a href="/sass/map/map.get.md#usdkey"><code>$key</code></a> in <a href="/sass/map/map.get.md#usdkey"><code>$map</code></a>, and returns <a href="/sass/map/map.get.md#usdfallback-null"><code>$fallback</code></a> if returned is <code>null</code>.</td><td><a data-footnote-ref href="#user-content-fn-2">modified</a></td><td><a href="/sass/map/map.get.md">map.get()</a></td></tr><tr><td><strong><code>map.has-keys()</code></strong></td><td>Checks whether <a href="/sass/map/map.has-keys.md#usdmap"><code>$map</code></a> contains <a href="/pages/jyRdYR6zAvxKSma7a3S4#usdkeys..."><code>$keys</code></a>.</td><td></td><td><a href="/sass/map/map.has-keys.md">map.has-keys()</a></td></tr><tr><td><strong><code>map.key-replace()</code></strong></td><td>Returns the map with key <a href="/sass/map/map.key-replace.md#usdreplace"><code>$replace</code></a> replaced by <a href="/sass/map/map.key-replace.md#usdreplacement"><code>$replacement</code></a>.</td><td></td><td><a href="/sass/map/map.key-replace.md">map.key-replace()</a></td></tr><tr><td><strong><code>map.pick()</code></strong></td><td>Returns a copy of <a href="/sass/map/map.pick.md#usdmap"><code>$map</code></a> of <a href="/pages/jK5hQVng0wvezLIUJzMc#usdkeys..."><code>$keys</code></a>.</td><td></td><td><a href="/sass/map/map.pick.md">map.pick()</a></td></tr><tr><td><strong><code>map.remove-type()</code></strong></td><td>Removes the properties from <a href="/sass/map/map.remove-type.md#usdmap"><code>$map</code></a> where values are of <a href="/pages/BTKaaxyr81lzcirkSHwx#usdtypes..."><code>$types</code></a>.</td><td></td><td><a href="/sass/map/map.remove-type.md">map.remove-type()</a></td></tr><tr><td><strong><code>map.remove()</code></strong></td><td>The <code>map.remove()</code> function with unified <code>map.remove()</code> and <code>deep-remove()</code> returns a copy <a href="/sass/map/map.remove.md#usdmap"><code>$map</code></a> without <a href="/pages/YevWWgD8zzXHpyCOjgCA#usdkeys..."><code>$keys</code></a>.</td><td><a data-footnote-ref href="#user-content-fn-3">modified</a></td><td><a href="/sass/map/map.remove.md">map.remove()</a></td></tr><tr><td><strong><code>map.retrieve()</code></strong></td><td>Retrieves a value from <a href="/sass/map/map.retrieve.md#usdmap"><code>$map</code></a> by a <a href="/sass/map/map.retrieve.md#usdmethod"><code>$method</code></a> get or pick with a <a href="/sass/map/map.retrieve.md#usdkey"><code>$key</code></a>.</td><td></td><td><a href="/sass/map/map.retrieve.md">map.retrieve()</a></td></tr><tr><td><strong><code>map.set()</code></strong></td><td>Sets the <a href="/pages/eA1D2RSFMwcOSbBuLIN8#usdallowed..."><code>$allowed</code></a> <a href="/sass/map/map.set.md#usdvalue"><code>$value</code></a> under <a href="/sass/map/map.set.md#usdkey"><code>$key</code></a> in <a href="/sass/map/map.set.md#usdmap"><code>$map</code></a>.</td><td><a data-footnote-ref href="#user-content-fn-4">modified</a></td><td><a href="/sass/map/map.set.md">map.set()</a></td></tr><tr><td><strong><code>map.update()</code></strong></td><td>Allows to set multiple key-value sets in a <a href="/sass/map/map.update.md#usdmap"><code>$map</code></a>.</td><td></td><td><a href="/sass/map/map.update.md">map.update()</a></td></tr><tr><td><strong><code>map.values()</code></strong></td><td><p>Returns all values or values of <a href="/pages/OqdQOm2cXFfqhJEFHZCh#usdkeys..."><code>$keys</code></a> from <a href="/sass/map/map.values.md#usdmap"><code>$map</code></a>.</p><p></p></td><td><a data-footnote-ref href="#user-content-fn-5">modified</a></td><td><a href="/sass/map/map.values.md">map.values()</a></td></tr></tbody></table>

[^1]: The function modify original `map.deep-merge()` by adding arbitrary [`$maps...`](https://docs.angular-package.dev/sass/map/pages/XT4Z8Hwf4PghXmbVs2nV#usdmaps...) argument, to deep merge multiple maps.

[^2]: Modified by removing arbitrary argument `$keys...` and instead, adding [`$fallback`](/sass/map/map.get.md#usdfallback-null) value. To get the nested value use key as comma-separated list. This way of providing key as comma-separated list is consistent with [`map.remove()`](/sass/map/map.remove.md) and [`map.set()`](/sass/map/map.set.md) functions.

[^3]: Modified by adding deep remove on key as comma-separated list. This way of providing key is consistent with a [`map.set()`](/sass/map/map.set.md) and [`map.get()`](/sass/map/map.get.md) functions.

[^4]: Original sass `map.set()` function modified, by adding [`$allowed...`](https://docs.angular-package.dev/sass/map/pages/eA1D2RSFMwcOSbBuLIN8#usdallowed...) arbitrary argument to check if `$value` is allowed to be set.

[^5]: The modified `map.values()` function, by adding arbitrary parameter [`$keys...`](https://docs.angular-package.dev/sass/map/pages/OqdQOm2cXFfqhJEFHZCh#usdkeys...) to return values of the specified keys.
