test(state): fix register return type + add unRegister spec

edbzn · edbzn · commit 210dea125724 · 2023-10-17T13:06:11.000+02:00
diff --git a/libs/state/effects/src/lib/rx-effects.spec.ts b/libs/state/effects/src/lib/rx-effects.spec.ts
@@ -1,7 +1,9 @@
 import { Component } from '@angular/core';
 import { TestBed } from '@angular/core/testing';
-import { Observable, of, Subject, tap } from 'rxjs';
+import { Observable, of, Subject, tap, timer } from 'rxjs';
 import { rxEffects, RxEffectsSetupFn } from './rx-effects';
+import { TestScheduler } from 'rxjs/testing';
+import { jestMatcher } from '@test-helpers/rx-angular';
 
 describe(rxEffects, () => {
   it('should register an observable', () => {
@@ -10,6 +12,19 @@ describe(rxEffects, () => {
     expect(spy).toHaveBeenCalledWith('src');
   });
 
+  it('should unregister a subscription', () => {
+    expect.assertions(1);
+    const spy = jest.fn();
+    const scheduler = new TestScheduler(jestMatcher);
+
+    setupComponent(({ register }) => {
+      const unRegister = register(timer(10, scheduler), spy);
+      unRegister();
+      scheduler.flush();
+      expect(spy).not.toHaveBeenCalled();
+    });
+  });
+
   it('should register an observable and sideEffect fn', () => {
     const spy = jest.fn();
     setupComponent(({ register }) => register(of('src'), spy));
diff --git a/libs/state/effects/src/lib/rx-effects.ts b/libs/state/effects/src/lib/rx-effects.ts
@@ -7,13 +7,13 @@ import {
 import { from, Subscription } from 'rxjs';
 import { SideEffectFnOrObserver, SideEffectObservable } from './types';
 
-type RxEffects = {
+interface RxEffects {
   register<T>(
     observable: SideEffectObservable<T>,
     sideEffectOrObserver?: SideEffectFnOrObserver<T>
-  ): void;
+  ): Fn;
   onDestroy: (fn: Fn) => Fn;
-};
+}
 
 type Fn = () => void;
 
