feat(state): expose asReadOnly() when create state instance using functional approach

michaelbe812 · michaelbe812 · commit 60c4aa45ddbb · 2024-09-30T10:14:37.000+02:00
closes #1789
diff --git a/libs/state/spec/rx-state.spec.ts b/libs/state/spec/rx-state.spec.ts
@@ -379,6 +379,31 @@ describe(rxState, () => {
       expect(accumulator).toHaveBeenCalled();
     });
   });
+
+  describe('asReadOnly', () => {
+    it('should throw error when trying to call set from readOnlystate', () => {
+      const { component } = setupComponent<{ count: number }>();
+
+      const readOnlyState = component.state.asReadOnly();
+
+      expect((): void => {
+        readOnlyState['set'](
+          'count',
+          (state: { count: number }) => state.count + 1,
+        );
+      }).toThrowError('readOnlyState.set is not a function');
+    });
+
+    it('should throw error when trying to call connect from readOnlystate', () => {
+      const { component } = setupComponent<{ count: number }>();
+
+      const readOnlyState = component.state.asReadOnly();
+
+      expect((): void => {
+        readOnlyState['connect']('count', of(10));
+      }).toThrowError('readOnlyState.connect is not a function');
+    });
+  });
 });
 
 type ITestComponent<State extends object> = {
diff --git a/libs/state/src/lib/rx-state.ts b/libs/state/src/lib/rx-state.ts
@@ -12,13 +12,14 @@ export type RxState<T extends object> = Pick<
   | 'signal'
   | 'computed'
   | 'computedFrom'
+  | 'asReadOnly'
 >;
 
 export type RxStateSetupFn<State extends object> = (
   rxState: Pick<
     RxState<State>,
     'connect' | 'set' | 'get' | 'select' | 'setAccumulator'
-  >
+  >,
 ) => void;
 
 /**
@@ -46,7 +47,7 @@ export type RxStateSetupFn<State extends object> = (
  *
  */
 export function rxState<State extends object>(
-  setupFn?: RxStateSetupFn<State>
+  setupFn?: RxStateSetupFn<State>,
 ): RxState<State> {
   assertInInjectionContext(rxState);
 
@@ -65,6 +66,7 @@ export function rxState<State extends object>(
     computedFrom: legacyState.computedFrom.bind(legacyState),
     $: legacyState.$,
     setAccumulator: legacyState.setAccumulator.bind(legacyState),
+    asReadOnly: legacyState.asReadOnly.bind(legacyState),
   };
 
   setupFn?.(state);
