feat(cdk): added provideRxRenderStrategies provider function

eneajaho · eneajaho · commit 5c78bbfea232 · 2025-01-09T22:12:28.000+01:00
Exposed `provideRxRenderStrategies` provider function in order to improve the DX of configuring render strategies
diff --git a/libs/cdk/render-strategies/src/index.ts b/libs/cdk/render-strategies/src/index.ts
@@ -3,6 +3,7 @@ export {
   RxConcurrentStrategies,
 } from './lib/concurrent-strategies';
 export {
+  provideRxRenderStrategies,
   RX_RENDER_STRATEGIES_CONFIG,
   RxRenderStrategiesConfig,
 } from './lib/config';
diff --git a/libs/cdk/render-strategies/src/lib/config.ts b/libs/cdk/render-strategies/src/lib/config.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@angular/core';
+import { InjectionToken, Provider } from '@angular/core';
 import { RX_CONCURRENT_STRATEGIES } from './concurrent-strategies';
 import {
   RxCustomStrategyCredentials,
@@ -38,9 +38,7 @@ export function mergeDefaultConfig<T extends string>(
 ): Required<RxRenderStrategiesConfig<T | RxDefaultStrategyNames>> {
   const custom: RxRenderStrategiesConfig<T> = cfg
     ? cfg
-    : ({
-        customStrategies: {},
-      } as any);
+    : ({ customStrategies: {} } as any);
   return {
     ...RX_RENDER_STRATEGIES_DEFAULTS,
     ...custom,
@@ -50,3 +48,49 @@ export function mergeDefaultConfig<T extends string>(
     },
   };
 }
+
+/**
+ * @description
+ * Can be used to set the default render strategy or create custom render strategies.
+ *
+ * With this function you can customize the behavior of:
+ * - `rxLet` directive
+ * - `rxFor` directive
+ * - `rxIf` directive
+ * - `rxVirtualFor` directive
+ * - `rxVirtualView` directive
+ * - `RxStrategyProvider` service.
+ *
+ * @example
+ * import { provideRxRenderStrategies } from '@rx-angular/cdk/render-strategies';
+ *
+ * const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideRxRenderStrategies({
+ *       primaryStrategy: 'sync',
+ *       customStrategies: {
+ *         sync: {
+ *           name: 'sync',
+ *           work: (cdRef) => { cdRef.detectChanges(); },
+ *           behavior: ({ work }) => (o$) => o$.pipe(tap(() => work()))
+ *          },
+ *         asap: {
+ *           name: 'asap',
+ *           work: (cdRef) => { cdRef.detectChanges(); },
+ *           behavior: ({ work }) => (o$) => o$.pipe(delay(0, asapScheduler), tap(() => work()))
+ *        },
+ *     }),
+ *   ],
+ * };
+ *
+ * @param config - The configuration object.
+ * @returns A provider that can be used to set the default render strategy or create custom render strategies.
+ */
+export function provideRxRenderStrategies(
+  config: RxRenderStrategiesConfig<string>,
+): Provider {
+  return {
+    provide: RX_RENDER_STRATEGIES_CONFIG,
+    useValue: mergeDefaultConfig(config),
+  } satisfies Provider;
+}
