refactor(core): add consumerOnSignalRead hook to ReactiveNode

This hook allows a consumer to create `ReactiveNode`s with custom behavior when signals are read.
angular · Oct 4, 2023 · e7f262d · e7f262d
1 parent 5e1987f
commit e7f262d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/goldens/public-api/core/primitives/signals/index.md b/goldens/public-api/core/primitives/signals/index.md
@@ -59,6 +59,7 @@ export interface ReactiveNode {
     readonly consumerIsAlwaysLive: boolean;
     // (undocumented)
     consumerMarkedDirty(node: unknown): void;
+    consumerOnSignalRead(node: unknown): void;
     dirty: boolean;
     liveConsumerIndexOfThis: number[] | undefined;
     liveConsumerNode: ReactiveNode[] | undefined;

diff --git a/packages/core/primitives/signals/src/graph.ts b/packages/core/primitives/signals/src/graph.ts
@@ -60,6 +60,7 @@ export const REACTIVE_NODE: ReactiveNode = {
   producerMustRecompute: () => false,
   producerRecomputeValue: () => {},
   consumerMarkedDirty: () => {},
+  consumerOnSignalRead: () => {},
 };
 
 /**
@@ -156,6 +157,11 @@ export interface ReactiveNode {
   producerMustRecompute(node: unknown): boolean;
   producerRecomputeValue(node: unknown): void;
   consumerMarkedDirty(node: unknown): void;
+
+  /**
+   * Called when a signal is read within this consumer.
+   */
+  consumerOnSignalRead(node: unknown): void;
 }
 
 interface ConsumerNode extends ReactiveNode {
@@ -185,6 +191,8 @@ export function producerAccessed(node: ReactiveNode): void {
     return;
   }
 
+  activeConsumer.consumerOnSignalRead(node);
+
   // This producer is the `idx`th dependency of `activeConsumer`.
   const idx = activeConsumer.nextProducerIndex++;