TypstDocumentation

assert

Ensures that a condition is fulfilled.

Fails with an error if the condition is not fulfilled. Does not produce any output in the document.

If you wish to test equality between two values, see assert.eq and assert.ne.

Example

#assert(1 < 2, message: "math broke")

Parameters
Question mark

assert()

condition
bool
RequiredPositional
Question mark

The condition that must be true for the assertion to pass.

message

The error message when the assertion fails.

Definitions
Question mark

eq

Ensures that two values are equal.

Fails with an error if the first value is not equal to the second. Does not produce any output in the document.

assert.eq(
any,any,message: str,
)
View example
#assert.eq(10, 10)

left
any
RequiredPositional
Question mark

The first value to compare.

right
any
RequiredPositional
Question mark

The second value to compare.

message

An optional message to display on error instead of the representations of the compared values.

ne

Ensures that two values are not equal.

Fails with an error if the first value is equal to the second. Does not produce any output in the document.

assert.ne(
any,any,message: str,
)
View example
#assert.ne(3, 4)

left
any
RequiredPositional
Question mark

The first value to compare.

right
any
RequiredPositional
Question mark

The second value to compare.

message

An optional message to display on error instead of the representations of the compared values.