docs-v2/content/flux/v0/stdlib/dict/remove.md

title	description	menu	weight
dict.remove() function	`dict.remove()` removes a key value pair from a dictionary and returns an updated dictionary.	flux_v0_ref name parent identifier dict.remove dict dict/remove	101

dict.remove() removes a key value pair from a dictionary and returns an updated dictionary.

Function type signature

(dict: [A:B], key: A) => [A:B] where A: Comparable

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

dict

({{< req >}}) Dictionary to remove the key-value pair from.

key

({{< req >}}) Key to remove from the dictionary. Must be the same type as existing keys in the dictionary.

Examples

Remove a property from a dictionary

import "dict"

d = [1: "foo", 2: "bar"]

dict.remove(dict: d, key: 1)// Returns [2: "bar"]