useFuture<T> function

AsyncSnapshot<T> useFuture<T>(
  1. Future<T>? future, {
  2. required T initialData,
  3. bool preserveState = true,
})

Subscribes to a Future and return its current state in an AsyncSnapshot.

  • preserveState defines if the current value should be preserved when changing the Future instance.

See also:

Implementation

AsyncSnapshot<T> useFuture<T>(
  Future<T>? future, {
  required T initialData,
  bool preserveState = true,
}) {
  return use(
    _FutureHook(
      future,
      initialData: initialData,
      preserveState: preserveState,
    ),
  );
}