overrideWithProvider method Null safety

ProviderOverride overrideWithProvider(
  1. AutoDisposeProviderBase<Object?, T> provider
)
inherited

Overrides the behavior of this provider with another provider.

Some common use-cases are:

  • testing, by replacing a service with a fake implementation, or to reach a very specific state easily.
  • multiple environments, by changing the implementation of a class based on the platform or other parameters.

This function should be used in combination with ProviderScope.overrides or ProviderContainer.overrides:

final myService = Provider((ref) => MyService());

runApp(
  ProviderScope(
    overrides: [
      myService.overrideWithProvider(
        // Replace the implementation of MyService with a fake implementation
        Provider((ref) => MyFakeService())
      ),
    ],
    child: MyApp(),
  ),
);

Implementation

ProviderOverride overrideWithProvider(
  AutoDisposeProviderBase<Object?, Listened> provider,
) {
  return ProviderOverride(provider, this);
}