{"route":"/en-US-v0.13.1/reference/foundations/assert/","title":"Assert","description":"Documentation for the `assert` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-condition","name":"condition","children":[]},{"id":"parameters-message","name":"message","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-eq","name":"Assert Equal","children":[{"id":"definitions-eq-left","name":"left","children":[]},{"id":"definitions-eq-right","name":"right","children":[]},{"id":"definitions-eq-message","name":"message","children":[]}]},{"id":"definitions-ne","name":"Assert Not Equal","children":[{"id":"definitions-ne-left","name":"left","children":[]},{"id":"definitions-ne-right","name":"right","children":[]},{"id":"definitions-ne-message","name":"message","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"assert","title":"Assert","keywords":[],"oneliner":"Ensures that a condition is fulfilled.","element":false,"contextual":false,"deprecation":null,"details":"

Ensures that a condition is fulfilled.

\n

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

\n

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

\n

Example

\n
#assert(1 < 2, message: "math broke")\n
","example":null,"self":false,"params":[{"name":"condition","details":"

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

","example":null,"types":["bool"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"message","details":"

The error message when the assertion fails.

","example":null,"types":["str"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":[],"scope":[{"path":["assert"],"name":"eq","title":"Assert Equal","keywords":[],"oneliner":"Ensures that two values are equal.","element":false,"contextual":false,"deprecation":null,"details":"

Ensures that two values are equal.

\n

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

","example":"
#assert.eq(10, 10)\n
","self":false,"params":[{"name":"left","details":"

The first value to compare.

","example":null,"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"right","details":"

The second value to compare.

","example":null,"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"message","details":"

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

","example":null,"types":["str"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":[],"scope":[]},{"path":["assert"],"name":"ne","title":"Assert Not Equal","keywords":[],"oneliner":"Ensures that two values are not equal.","element":false,"contextual":false,"deprecation":null,"details":"

Ensures that two values are not equal.

\n

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

","example":"
#assert.ne(3, 4)\n
","self":false,"params":[{"name":"left","details":"

The first value to compare.

","example":null,"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"right","details":"

The second value to compare.

","example":null,"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"message","details":"

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

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