dictionary
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
joined together.
To check whether a key is present in the dictionary, use the in keyword.
You can iterate over the pairs in a dictionary using a for loop. This will iterate in the order the pairs were inserted / declared.
Example
#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 . operator.
. operator.len method
The number of pairs in the dictionary.
at method
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.
key
The key at which to retrieve the item.
defaultany
A default value to return if the key is not part of the dictionary.
insert method
Insert a new pair into the dictionary and return the value. If the dictionary already contains this key, the value is updated.
key
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.
keys method
Returns the keys of the dictionary as an array in insertion order.
values method
Returns the values of the dictionary as an array in insertion order.
pairs method
Returns the keys and values of the dictionary as an array of pairs. Each pair is represented as an array of length two.
remove method
Remove a pair from the dictionary by key and return the value.
key
The key of the pair that should be removed.