listen<State> method

  1. @override
ProviderSubscription<State> listen<State>(
  1. ProviderListenable<State> provider,
  2. void listener(
    1. State? previous,
    2. State next
  3. {bool fireImmediately = false,
  4. void onError(
    1. Object error,
    2. StackTrace stackTrace

Listen to a provider and call listener whenever its value changes.

Listeners will automatically be removed when the provider rebuilds (such as when a provider listened with watch changes).

Returns an object that allows cancelling the subscription early.

fireImmediately (false by default) can be optionally passed to tell Riverpod to immediately call the listener with the current value.

onError can be specified to listen to uncaught errors in the provider.
onError will not be triggered if the provider catches the exception and emit a valid value out of it. As such, if a FutureProvider/StreamProvider fail, onError will not be called. Instead the listener will receive an AsyncError.


ProviderSubscription<State> listen<State>(
  ProviderListenable<State> provider,
  void Function(State? previous, State next) listener, {
  bool fireImmediately = false,
  void Function(Object error, StackTrace stackTrace)? onError,
}) {
  // TODO test always flushed provider
  return provider.addListener(
    fireImmediately: fireImmediately,
    onError: onError,
    onDependencyMayHaveChanged: null,