refresh<State> method

State refresh<State>(Refreshable<State> provider)

Forces a provider to re-evaluate its state immediately, and return the created value.

Writing:

final newValue = ref.refresh(provider);

is strictly identical to doing:

ref.invalidate(provider);
final newValue = ref.read(provider);

If you do not care about the return value of refresh, use invalidate instead. Doing so has the benefit of:

• making the invalidation logic more resilient by avoiding multiple refreshes at once.
• possibly avoids recomputing a provider if it isn't needed immediately.

This method is useful for features like "pull to refresh" or "retry on error", to restart a specific provider.

Implementation

State refresh<State>(Refreshable<State> provider) {
  invalidate(provider._origin);
  return read(provider);
}