docs-v2/content/flux/v0.x/stdlib/dict/insert.md

2.2 KiB

title description menu weight
dict.insert() function `dict.insert()` inserts a key-value pair into a dictionary and returns a new, updated dictionary.
flux_0_x_ref
name parent identifier
dict.insert dict dict/insert
101

dict.insert() inserts a key-value pair into a dictionary and returns a new, updated dictionary.

If the key already exists in the dictionary, the function overwrites the existing value.

Function type signature
(dict: [A:B], key: A, value: B) => [A:B] where A: Comparable

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

Parameters

dict

({{< req >}}) Dictionary to update.

key

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

value

({{< req >}}) Value to insert into the dictionary. Must be the same type as the existing values in the dictionary.

Examples

Insert a new key-value pair into the a dictionary

import "dict"

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

dict.insert(dict: d, key: 3, value: "baz")// Returns [1: "foo", 2: "bar", 3: "baz"]


Overwrite an existing key-value pair in a dictionary

import "dict"

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

dict.insert(dict: d, key: 2, value: "baz")// Returns [1: "foo", 2: "baz"]