Adding hooks API for matching SolidJS style

rodydavis · Feb 20, 2025 · def666f · def666f
1 parent b2dc280
commit def666f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/packages/signals_core/lib/src/extensions/signal.dart b/packages/signals_core/lib/src/extensions/signal.dart
@@ -4,7 +4,7 @@ import '../core/signals.dart';
 
 final Map<int, Stream<dynamic>> _streamCache = {};
 
-/// Signal extensions
+/// Readonly signal extensions
 extension ReadonlySignalUtils<T> on ReadonlySignal<T> {
   /// Convert a signal to a [Stream] to be consumed as
   /// a read only stream.
@@ -49,3 +49,15 @@ extension ReadonlySignalUtils<T> on ReadonlySignal<T> {
     );
   }
 }
+
+/// Writeable signal extensions
+extension WriteableSignalUtils<T> on Signal<T> {
+  /// Easy destructure to get and set the value
+  ///
+  /// ```dart
+  /// final counter = signal(0);
+  /// ...
+  /// final (getCount, setCount) = counter.hooks;
+  /// ```
+  (T Function(), void Function(T)) get hooks => (get, set);
+}
diff --git a/packages/signals_core/test/extensions/signal_test.dart b/packages/signals_core/test/extensions/signal_test.dart
@@ -10,5 +10,16 @@ void main() {
 
       expect(a.value.keys, b.value);
     });
+
+    test('hooks', () {
+      final counter = signal(0);
+      final (getCount, setCount) = counter.hooks;
+
+      expect(getCount(), 0);
+
+      setCount(1);
+
+      expect(getCount(), 1);
+    });
   });
 }