RtDependencyObserver

RtDependencyObserver is a class that provides a way to observe the lifecycle of dependencies in Reactter.

Syntax

  RtDependencyObserver({
    void onRegistered(DependencyRef dependency)?,
    void onCreated(DependencyRef dependency, Object? instance)?,
    void onMounted(DependencyRef dependency, Object? instance)?,
    void onUnmounted(DependencyRef dependency, Object? instance)?,
    void onDeleted(DependencyRef dependency, Object? instance)?,
    void onUnregistered(DependencyRef dependency)?,
    void onFailed(DependencyRef dependency, DependencyFail fail)?,
  });

The RtDependencyObserver class accepts these parameters:

• onRegistered : (optional) Called when a dependency is registered.
• onCreated : (optional) Called when a instance of a dependency is created.
• onMounted : (optional) Called when the instance of a dependency is mounted.
• onUnmounted : (optional) Called when the instance of a dependency is unmounted.
• onDeleted : (optional) Called when the instance of a dependency is deleted.
• onUnregistered : (optional) Called when a dependency is unregistered.
• onFailed : (optional) Called when a dependency fails, indicating one of the following failures:
  • DependencyFail.alreadyRegistered: The dependency is already registered.
  • DependencyFail.alreadyCreated: An instance of dependency is already created.
  • DependencyFail.alreadyDeleted: The instance of dependency is already deleted.
  • DependencyFail.alreadyUnregistered: The dependency is already unregistered.
  • DependencyFail.missingInstanceBuilder: The dependency was not registered previously.
  • DependencyFail.builderRetained: The builder is retained because is in factory mode.
  • DependencyFail.dependencyRetained: The builder and instance is retained because is in singleton mode.
  • DependencyFail.cannotUnregisterActiveInstance: Cannot unregister the dependency because it has an active instance.

Usage

To use RtDependencyObserver , you need to instantiate it, pass the callbacks you want to use, and then add it using the Rt.addObserver method, e.g.:

import 'package:reactter/reactter.dart';

void main() {
  // Create a dependency observer with lifecycle callbacks
  final dependencyObserver = RtDependencyObserver(
    onRegistered: (dependency) {
      print('Dependency($dependency) registered');
    },
    onCreated: (dependency, instance) {
      print('Dependency($dependency) created with instance($instance)');
    },
    onMounted: (dependency, instance) {
      print('Dependency($dependency) mounted with instance($instance)');
    },
    onUnmounted: (dependency, instance) {
      print('Dependency($dependency) unmounted with instance($instance)');
    },
    onDeleted: (dependency, instance) {
      print('Dependency($dependency) deleted with instance($instance)');
    },
    onUnregistered: (dependency) {
      print('Dependency($dependency) unregistered');
    },
    onFailed: (dependency, fail) {
      print('Dependency($dependency) failed with $fail');
    },
  );

  // Add the dependency observer to Reactter's observer system
  Rt.addObserver(dependencyObserver);
}