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

1.7 KiB

title description menu weight
dict.get() function `dict.get()` returns the value of a specified key in a dictionary or a default value if the key does not exist.
flux_v0_ref
name parent identifier
dict.get dict dict/get
101

dict.get() returns the value of a specified key in a dictionary or a default value if the key does not exist.

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

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

Parameters

dict

({{< req >}}) Dictionary to return a value from.

key

({{< req >}}) Key to return from the dictionary.

default

({{< req >}}) Default value to return if the key does not exist in the dictionary. Must be the same type as values in the dictionary.

Examples

Return a property of a dictionary

import "dict"

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

dict.get(dict: d, key: 1, default: "")// Returns "foo"