Skip to main content
Asserts a natural-language condition about the current screen. Fails the test when the condition is not met. Use assert for fuzzy or visual conditions; for an exact-text check prefer checkScreenContains, which is deterministic and cheaper. The simplified form takes the condition as a single string.

Parameters

ParameterTypeRequiredDescription
thatstringYesThe condition to assert.
timeoutnumberNoMilliseconds to wait for the condition to become true.
saveAsstringNoVariable to store this step’s return value on env.<name>.
retriesnumberNoTimes to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.

Shorthand

Condition as a single string.
- assert: An order confirmation is visible

Examples

- assert:
    that: The dashboard chart is visible and not cut off
    timeout: 10000 # poll for up to 10s before failing