注意 当サイトは、Typst v0.11.1 公式ドキュメントを、日本語コミュニティが非公式に翻訳したものです。誤訳・未訳・古い情報が含まれている可能性があるため、公式ドキュメント との併用を推奨します。このサイトの内容に誤りを発見された方は、GitHubリポジトリまでご報告を頂けましたら幸いです。我々のコミュニティにご興味のある方は、ぜひ非公式Discordサーバー「くみはんクラブ」にご参加ください。
Warning: This site provides an unofficial translation of the Typst v0.11.1 documentation by the Japanese Community. Please note that there may be some inaccuracies, untranslated sections or outdated information. We highly recommend referring to the latest official documentation as well. If you find any errors in the content, please let us know through our GitHub repository. If you are interested in our community, feel free to join our unofficial Discord server, “Kumihan Club.”
Typst ドキュメント日本語版

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
Parameters are the inputs to a function. They are specified in parentheses after the function name.

assert()

condition
bool
RequiredPositional
Positional parameters are specified in order, without names.

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

message
str

The error message when the assertion fails.

Definitions
Functions and types and can have associated definitions. These are accessed by specifying the function or type, followed by a period, and then the definition's name.

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()
View example
#assert.eq(10, 10)

left
any
RequiredPositional
Positional parameters are specified in order, without names.

The first value to compare.

right
any
RequiredPositional
Positional parameters are specified in order, without names.

The second value to compare.

message
str

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()
View example
#assert.ne(3, 4)

left
any
RequiredPositional
Positional parameters are specified in order, without names.

The first value to compare.

right
any
RequiredPositional
Positional parameters are specified in order, without names.

The second value to compare.

message
str

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