feat(effects): change the signature of provideEffect (#3587)

BREAKING CHANGE: The signature of `provideEffects` is changed to expect a spreaded array of effects. BEFORE: `provideEffects` expecteded the effects to be passed as an array. ```ts // single effect provideEffects([MyEffect]) // multiple effects provideEffects([MyEffect, MySecondEffect]) ```ts AFTER: `provideEffects` expects the effects as a spreaded array as argument. ```ts // single effect provideEffects(MyEffect) // multiple effects provideEffects(MyEffect, MySecondEffect) ```ts
ngrx · Oct 17, 2022 · 899afe7 · 899afe7
1 parent 8636734
commit 899afe7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 12 deletions.
diff --git a/modules/effects/spec/provide_effects.spec.ts b/modules/effects/spec/provide_effects.spec.ts
@@ -31,8 +31,8 @@ describe('provideEffects', () => {
         },
         provideStore({}).ɵproviders,
         // provide effects twice
-        provideEffects([]).ɵproviders,
-        provideEffects([]).ɵproviders,
+        provideEffects().ɵproviders,
+        provideEffects().ɵproviders,
       ],
     });
 
@@ -50,8 +50,8 @@ describe('provideEffects', () => {
         },
         provideStore().ɵproviders,
         // provide effects twice
-        provideEffects([]).ɵproviders,
-        provideEffects([]).ɵproviders,
+        provideEffects().ɵproviders,
+        provideEffects().ɵproviders,
       ],
     });
 
@@ -63,7 +63,7 @@ describe('provideEffects', () => {
   it('throws an error when store is not provided', () => {
     TestBed.configureTestingModule({
       // provide only effects
-      providers: [provideEffects([TestEffects]).ɵproviders],
+      providers: [provideEffects(TestEffects).ɵproviders],
     });
 
     expect(() => TestBed.inject(TestEffects)).toThrowError();
@@ -73,7 +73,7 @@ describe('provideEffects', () => {
     TestBed.configureTestingModule({
       providers: [
         provideStore().ɵproviders,
-        provideEffects([TestEffects]).ɵproviders,
+        provideEffects(TestEffects).ɵproviders,
       ],
     });
 
@@ -91,7 +91,7 @@ describe('provideEffects', () => {
   it('runs provided effects after root state registration', (done) => {
     TestBed.configureTestingModule({
       providers: [
-        provideEffects([TestEffects]).ɵproviders,
+        provideEffects(TestEffects).ɵproviders,
         // provide store after effects
         provideStore({ [rootSliceKey]: createReducer('ngrx') }).ɵproviders,
       ],
@@ -114,7 +114,7 @@ describe('provideEffects', () => {
     TestBed.configureTestingModule({
       providers: [
         provideStore().ɵproviders,
-        provideEffects([TestEffects]).ɵproviders,
+        provideEffects(TestEffects).ɵproviders,
         // provide feature state after effects
         provideState(featureSliceKey, createReducer('effects')).ɵproviders,
       ],

diff --git a/modules/effects/src/provide_effects.ts b/modules/effects/src/provide_effects.ts
@@ -24,7 +24,7 @@ import { rootEffectsInit as effectsInit } from './effects_actions';
  *
  * ```ts
  * bootstrapApplication(AppComponent, {
- *   providers: [provideEffects([RouterEffects])],
+ *   providers: [provideEffects(RouterEffects]],
  * });
  * ```
  *
@@ -34,7 +34,7 @@ import { rootEffectsInit as effectsInit } from './effects_actions';
  * const booksRoutes: Route[] = [
  *   {
  *     path: '',
- *     providers: [provideEffects([BooksApiEffects])],
+ *     providers: [provideEffects(BooksApiEffects)],
  *     children: [
  *       { path: '', component: BookListComponent },
  *       { path: ':id', component: BookDetailsComponent },
@@ -43,7 +43,9 @@ import { rootEffectsInit as effectsInit } from './effects_actions';
  * ];
  * ```
  */
-export function provideEffects(effects: Type<unknown>[]): EnvironmentProviders {
+export function provideEffects(
+  ...effects: Type<unknown>[]
+): EnvironmentProviders {
   return {
     ɵproviders: [
       effects,

diff --git a/projects/standalone-app/src/main.ts b/projects/standalone-app/src/main.ts
@@ -37,6 +37,6 @@ bootstrapApplication(AppComponent, {
       name: 'NgRx Standalone App',
     }),
     provideRouterStore(),
-    provideEffects([AppEffects]),
+    provideEffects(AppEffects),
   ],
 });