Foundations

Foundational types and functions.

Here, you’ll find documentation for basic data types like integers and strings as well as details about core computational functions.

Definitions

argumentsCaptured arguments to a function.
arrayA sequence of values.
assertEnsures that a condition is fulfilled.
autoA value that indicates a smart default.
boolA type with two states.
bytesA sequence of bytes.
calcModule for calculations and processing of numeric values.
contentA piece of document content.
datetimeRepresents a date, a time, or a combination of both.
decimalA fixed-point decimal number type.
dictionaryA map from string keys to values.
durationRepresents a positive or negative span of time.
evalEvaluates a string as Typst code.
floatA floating-point number.
functionA mapping from argument values to a return value.
intAn integer: a positive whole number, a negative whole number, or zero.
labelA label for an element.
moduleA collection of variables and functions that are commonly related to a single theme.
noneA value that indicates the absence of any other value.
panicFails with an error.
pathA file system path.
pluginLoads a WebAssembly module.
regexA regular expression.
reprReturns the string representation of a value.
selectorA filter for selecting elements within the document.
stdA module that contains all globally accessible items.
strA sequence of Unicode codepoints.
symbolA Unicode symbol.
sysModule for system interactions.
targetReturns the current export target.
typeDescribes a kind of value.
versionA version with an arbitrary number of components.