feat(state): introduce rxEffects creation function

hoebbelsB · hoebbelsB · commit 226047bd9396 · 2023-09-25T13:07:58.000+02:00
diff --git a/libs/state/effects/src/index.ts b/libs/state/effects/src/index.ts
@@ -1 +1,2 @@
 export { RxEffects } from './lib/effects.service';
+export { rxEffects } from './lib/effects';
diff --git a/libs/state/effects/src/lib/effects.ts b/libs/state/effects/src/lib/effects.ts
@@ -0,0 +1,63 @@
+import {
+  DestroyRef,
+  assertInInjectionContext,
+  inject,
+  ErrorHandler,
+} from '@angular/core';
+import { RxEffects } from './effects.service';
+
+export type RxEffectsSetupFn = (
+  rxEffect: Pick<RxEffects, 'register' | 'registerOnDestroy'>
+) => void;
+
+/**
+ * @description
+ * Functional way to setup observable based side effects with RxEffects.
+ * It's a creation function for RxEffects that destroys itself when the provided
+ * `DestroyRef` is destroyed.
+ *
+ * @example
+ * ```ts
+ * import { rxEffects } from '@rx-angular/state/effects';
+ *
+ * \@Component({})
+ * export class FooComponent {
+ *  private readonly util = inject(Util);
+ *  readonly effects = rxEffects(({ register }) => {
+ *    register(this.util.windowResize$, () => {
+ *      console.log('window was resized');
+ *    })
+ *  });
+ *
+ *  ngOnInit() {
+ *    this.effects.register(this.util.rotationChanged$, () => {
+ *      console.log('viewport rotation changed');
+ *    });
+ *  }
+ * }
+ * ```
+ *
+ * @param {RxEffectsSetupFn} setupFn
+ * @returns RxEffects
+ *
+ *
+ *
+ * @docsCategory RxEffects
+ * @docsPage RxEffects
+ *
+ */
+export function rxEffects(setupFn?: RxEffectsSetupFn): RxEffects {
+  assertInInjectionContext(rxEffects);
+  const errorHandler = inject(ErrorHandler, { optional: true });
+  const effects = new RxEffects(errorHandler);
+  const destroyRef = inject(DestroyRef);
+
+  destroyRef.onDestroy(() => effects.ngOnDestroy());
+
+  setupFn?.({
+    register: effects.register.bind(effects),
+    registerOnDestroy: effects.registerOnDestroy.bind(effects),
+  });
+
+  return effects;
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export { RxEffects } from './lib/effects.service';`
	`2`	`+export { rxEffects } from './lib/effects';`