watchChanges method

Stream<void> watchChanges({ Duration? debounce = const Duration(milliseconds: 200), bool fireImmediately = false, List<StoreDirectory> recursive = const [], bool watchRecovery = false, List<StoreParts> storeParts = const [StoreParts.metadata, StoreParts.tiles, StoreParts.stats], })

Watch for changes in the current root

Useful to update UI only when required, for example, in a StreamBuilder. Whenever this has an event, it is likely the other statistics will have changed.

Recursively watch specific stores (using StoreStats.watchChanges) by providing them as a list of StoreDirectorys to recursive. To watch all stores, use the storesAvailable/storesAvailableAsync getter as the argument. By default, no sub-stores are watched (empty list), meaning only events that affect the actual store database (eg. store creations) will be caught. Control where changes are caught from using storeParts. See documentation on those parts for their scope.

Enable debouncing to prevent unnecessary events for small changes in detail using debounce. Defaults to 200ms, or set to null to disable debouncing.

Debouncing example (dash roughly represents debounce):

input:  1-2-3---4---5-6-|
output: ------3---4-----6|

Implementation

Stream<void> watchChanges({
  Duration? debounce = const Duration(milliseconds: 200),
  bool fireImmediately = false,
  List<StoreDirectory> recursive = const [],
  bool watchRecovery = false,
  List<StoreParts> storeParts = const [
    StoreParts.metadata,
    StoreParts.tiles,
    StoreParts.stats,
  ],
}) =>
    StreamGroup.merge([
      DirectoryWatcher(FMTC.instance.rootDirectory.directory.absolute.path)
          .events
          .where((e) => !path.dirname(e.path).endsWith('import')),
      if (watchRecovery)
        _registry.recoveryDatabase.recovery
            .watchLazy(fireImmediately: fireImmediately),
      ...recursive.map(
        (s) => s.stats.watchChanges(
          fireImmediately: fireImmediately,
          storeParts: storeParts,
        ),
      ),
    ]).debounce(debounce ?? Duration.zero);