{"route":"/en-US-v0.14.1/reference/foundations/version/","title":"Version","description":"Documentation for the Version type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-components","name":"components","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-index","name":"index","children":[]}]}]}],"body":{"kind":"type","content":{"name":"version","title":"Version","keywords":[],"oneliner":"A version with an arbitrary number of components.","details":"

A version with an arbitrary number of components.

\n

The first three components have names that can be used as fields: major,\nminor, patch. All following components do not have names.

\n

The list of components is semantically extended by an infinite list of\nzeros. This means that, for example, 0.8 is the same as 0.8.0. As a\nspecial case, the empty version (that has no components at all) is the same\nas 0, 0.0, 0.0.0, and so on.

\n

The current version of the Typst compiler is available as sys.version.

\n

You can convert a version to an array of explicitly given components using\nthe array constructor.

","constructor":{"path":[],"name":"version","title":"Construct","keywords":[],"oneliner":"Creates a new version.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Creates a new version.

\n

It can have any number of components (even zero).

"},{"kind":"example","content":{"body":"
#version() \\\n#version(1) \\\n#version(1, 2, 3, 4) \\\n#version((1, 2, 3, 4)) \\\n#version((1, 2), 3)\n
\"Preview\"
","title":"Constructing versions"}},{"kind":"html","content":"

As a practical use case, this allows comparing the current version\n(sys.version) to a specific one.

"},{"kind":"example","content":{"body":"
Current version: #sys.version \\\n#(sys.version >= version(0, 14, 0)) \\\n#(version(3, 2, 0) > version(4, 1, 0))\n
\"Preview\"
","title":"Comparing with the current version"}}],"self":false,"params":[{"name":"components","details":[{"kind":"html","content":"

The components of the version (array arguments are flattened)

"}],"types":["int","array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["version"],"scope":[]},"scope":[{"path":["version"],"name":"at","title":"At","keywords":[],"oneliner":"Retrieves a component of a version.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Retrieves a component of a version.

\n

The returned integer is always non-negative. Returns 0 if the version\nisn't specified to the necessary length.

"}],"self":true,"params":[{"name":"index","details":[{"kind":"html","content":"

The index at which to retrieve the component. If negative, indexes\nfrom the back of the explicitly given components.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]}]}}}