CountdownTimer class

A simple countdown timer that fires events in regular increments until a duration has passed.

CountdownTimer implements Stream and sends itself as the event. From the timer you can get the remaining and elapsed time, or cancel the timer.

Inheritance

Constructors

CountdownTimer(Duration duration, Duration increment, {Stopwatch? stopwatch})
Creates a new CountdownTimer that fires events in increments of increment, until the duration has passed.

Properties

elapsed → Duration
no setter
first → Future<CountdownTimer>
The first element of this stream.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
increment → Duration
The duration between timer events.
final
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
isRunning → bool
no setter
last → Future<CountdownTimer>
The last element of this stream.
no setterinherited
length → Future<int>
The number of elements in this stream.
no setterinherited
remaining → Duration
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<CountdownTimer>
The single element of this stream.
no setterinherited

Methods

any(bool test(CountdownTimer element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<CountdownTimer> subscription)?, void onCancel(StreamSubscription<CountdownTimer> subscription)?}) → Stream<CountdownTimer>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(CountdownTimer event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(CountdownTimer event)) → Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cancel() → void
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
distinct([bool equals(CountdownTimer previous, CountdownTimer next)?]) → Stream<CountdownTimer>
Skips data events if they are equal to the previous data event.
inherited
drain<E>([E? futureValue]) → Future<E>
Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<CountdownTimer>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(CountdownTimer element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(CountdownTimer element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(CountdownTimer element), {CountdownTimer orElse()?}) → Future<CountdownTimer>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, CountdownTimer element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(CountdownTimer element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<CountdownTimer>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(CountdownTimer element), {CountdownTimer orElse()?}) → Future<CountdownTimer>
Finds the last element in this stream matching test.
inherited
listen(void onData(CountdownTimer event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<CountdownTimer>
Adds a subscription to this stream.
override
map<S>(S convert(CountdownTimer event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe(StreamConsumer<CountdownTimer> streamConsumer) → Future
Pipes the events of this stream into streamConsumer.
inherited
reduce(CountdownTimer combine(CountdownTimer previous, CountdownTimer element)) → Future<CountdownTimer>
Combines a sequence of values by repeatedly applying combine.
inherited
singleWhere(bool test(CountdownTimer element), {CountdownTimer orElse()?}) → Future<CountdownTimer>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<CountdownTimer>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(CountdownTimer element)) → Stream<CountdownTimer>
Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<CountdownTimer>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(CountdownTimer element)) → Stream<CountdownTimer>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<CountdownTimer> sink)?}) → Stream<CountdownTimer>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<CountdownTimer>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<CountdownTimer>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<CountdownTimer, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(CountdownTimer event)) → Stream<CountdownTimer>
Creates a new stream from this stream that discards some elements.
inherited

Operators

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