SleepStep class

Simple test step that will sleep for a given period of time.

Inheritance

Constructors

SleepStep.new({required Duration timeout})

Properties

defaultStepTimeout → Duration
Returns the default timeout for the step. Steps that should respond quickly should use a relatively low value and steps that may take a long time should return an appropriately longer time.
no setterinherited
driver → OverrideWidgetTester
Returns the test driver that can be used to interact with widgets.
no setterinherited
find → CommonFinders
Returns the finder that can be used to locate widgets.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stepId → String
no setteroverride
timeout → Duration
The maximum amount of time to sleep for.
final

Methods

execute({CancelToken? cancelToken, TestReport? report, required TestController tester}) → Future<void>
Simply sleeps for the time specified by timeout.
override
getBehaviorDrivenDescription(TestController tester) → String
Gets the most appropriate BDD string based on the values set on the step.
override
log(String message, {required TestController tester}) → void
Logs a message and posts it as a status update to the TestRunner.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postStepSleep(Duration duration) → Future<void>
Overidden to ignore the delay
override
preStepSleep(Duration duration) → Future<void>
Overidden to ignore the delay
override
sleep(Duration duration, {required Stream<void>? cancelStream, bool error = false, String? message, required TestController tester}) → Future<void>
Sleeps for the defined Duration. This accept an optional cancelStream which can be used to cancel the sleep. The error flag informs the sleeper about whether the duration is a standard duration or an error based timeout.
inherited
toJson() → Map<String, dynamic>
Converts this to a JSON compatible map. For a description of the format, see fromDynamic.
toString() → String
Returns the string encoded JSON representation for this class. This will remove all null values and empty collections from the returned string.
inherited
waitFor(dynamic testableId, {required CancelToken cancelToken, required TestController tester, Duration? timeout}) → Future<Finder>
Waits for a widget with a key that has testableId as the value.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

behaviorDrivenDescriptions → List<String>
no setter

Static Methods

fromDynamic(dynamic map) → SleepStep?
Creates an instance from a JSON-like map structure. This expects the following format:

Constants

id → const String