onDispose method

@override void onDispose(void listener())

Adds a listener to perform an operation right before the provider is destroyed.

This typically happen when a provider marked with .autoDispose is no-longer used, or when ProviderContainer.dispose is called.

See also:

• Provider.autoDispose, a modifier which tell a provider that it should destroy its state when no-longer listened.
• ProviderContainer.dispose, to destroy all providers associated with a ProviderContainer at once.

Implementation

@override
void onDispose(void Function() listener) {
  _assertNotOutdated();
  if (!_mounted) {
    throw StateError('Cannot call onDispose after a provider was dispose');
  }
  _onDisposeListeners ??= DoubleLinkedQueue();
  _onDisposeListeners!.add(listener);
}