A map from string keys to values.
You can construct a dictionary by enclosing comma-separated
key: value pairs
in parentheses. The values do not have to be of the same type. Since empty
parentheses already yield an empty array, you have to use the special
syntax to create an empty dictionary.
A dictionary is conceptually similar to an array, but it is indexed by strings
instead of integers. You can access and create dictionary entries with the
.at() method. If you know the key statically, you can alternatively use
field access notation (
.key) to access
the value. Dictionaries can be added with the
+ operator and
To check whether a key is present in the dictionary, use the
You can iterate over the pairs in a dictionary using a for loop. This will iterate in the order the pairs were inserted / declared.
#let dict = ( name: "Typst", born: 2019, ) #dict.name \ #(dict.launch = 20) #dict.len() \ #dict.keys() \ #dict.values() \ #dict.at("born") \ #dict.insert("city", "Berlin ") #("name" in dict)
MethodsMethods are functions that are available on values of a type. They can be called for a value using the
The number of pairs in the dictionary.
Returns the value associated with the specified key in the dictionary. May be used on the left-hand side of an assignment if the key is already present in the dictionary. Returns the default value if the key is not part of the dictionary or fails with an error if no default value was specified.
The key at which to retrieve the item.
A default value to return if the key is not part of the dictionary.
Insert a new pair into the dictionary and return the value. If the dictionary already contains this key, the value is updated.
The key of the pair that should be inserted.
valueanyRequiredPositionalPositional parameters are specified in order, without names.
The value of the pair that should be inserted.
Returns the keys of the dictionary as an array in insertion order.
Returns the values of the dictionary as an array in insertion order.
Returns the keys and values of the dictionary as an array of pairs. Each pair is represented as an array of length two.
Remove a pair from the dictionary by key and return the value.
The key of the pair that should be removed.