CompletableFuture<T> class final

Implemented types
Available extensions
Annotations
  • @Deprecated("CompletableFuture will be removed in 2.0.0. " "Use ResultFuture instead.\n" "See package:my_utility/async/result_future.dart")

Constructors

CompletableFuture.new(FutureOrResultCallback<T> computation)
factory
CompletableFuture.delayed(Duration duration, [FutureOrResultCallback<T>? computation])
Same as Future.delayed.
factory
CompletableFuture.fromFuture(Future<T> _future)
CompletableFuture.value([FutureOr<T>? value])
Same as Future.value.
factory

Properties

hasCompletedWithError bool
True if this CompletableFuture has completed with an error and not a value.
no setter
hasCompletedWithValue bool
True if this CompletableFuture has completed with a value and not an error.
no setter
hashCode int
The hash code for this object.
no setterinherited
isCompleted bool
Whether this CompletableFuture has completed with either a value or an error.
no setter
result CompletableFutureResult<T>
The result of this CompletableFuture.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toJS JSPromise<T>

Available on Future<T>, provided by the FutureOfJSAnyToJSPromise extension

A JSPromise that either resolves with the result of the completed Future or rejects with an object that contains its error.
no setter
toJS JSPromise<JSAny?>

Available on Future<void>, provided by the FutureOfVoidToJSPromise extension

A JSPromise that either resolves once this Future completes or rejects with an object that contains its error.
no setter
value → T
The value result of this CompletableFuture.
no setter

Methods

asCompletableFuture() CompletableFuture<T>

Available on Future<T>, provided by the CompletableFutureExtension extension

asStream() Stream<T>
Creates a Stream containing the result of this future.
override
catchError(Function onError, {bool test(Object error)?}) Future<T>
Handles errors emitted by this Future.
override
ignore() → void

Available on Future<T>, provided by the FutureExtensions extension

Completely ignores this future and its result.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onError<E extends Object>(FutureOr<T> handleError(E error, StackTrace stackTrace), {bool test(E error)?}) Future<T>

Available on Future<T>, provided by the FutureExtensions extension

Handles errors on this future.
then<R>(FutureOr<R> onValue(T value), {Function? onError}) Future<R>
Register callbacks to be called when this future completes.
override
timeout(Duration timeLimit, {FutureOr<T> onTimeout()?}) Future<T>
Stop waiting for this future after timeLimit has passed.
override
toString() String
A string representation of this object.
inherited
whenComplete(FutureOr<void> action()) Future<T>
Registers a function to be called when this future completes.
override
withDelay(Duration minOperationTime, {Duration threshold = const Duration(milliseconds: 50), int thresholdInMillis = 50}) Future<T>

Available on Future<T>, provided by the MyUtilityExtensionFutureWithDelay extension

If the time it takes for this to complete is less than minOperationTime, then a Future.delayed is awaited for the remaining time. The delay also affects any errors of this Future.

Operators

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