destroyKey property

String? destroyKey
final

A key to forcibly destroy the associated state.

The use-case for this option is to simplify database migration when a provider changes its state in a breaking way.

Instead of a complex database migration, an alternative is to change the destroyKey of the provider before deploying the application. When doing so, the old state will be destroyed, and a new fresh state will be created.

This key should be stable across application restarts. It is highly recommended to use a constant value for this key.

Implementation

final String? destroyKey;