@ngrx/effects - npm Package Versions

15.0.0-beta.1 (2022-11-18)

Features

• data: add initial standalone APIs (#3647) (aa7ed66), closes #3553
• data: add withEffects feature for provideEntityData (#3656) (a6959e8)
• effects: forRoot and forFeature accept spreaded array (#3638) (0eaa536)
• router-store: return resolved title via selectTitle (#3648) (cc04e2f), closes #3622
• schematics: add display block flag (e0d368d)
• schematics: add standalone flag (b0bd2ff)
• schematics: replace environments usage with isDevMode (#3645) (4f61b63), closes #3618

BREAKING CHANGES

• router-store: Property title: string | undefined is added to the MinimalActivatedRouteSnapshot interface.

BEFORE:

The MinimalActivatedRouteSnapshot interface doesn't contain the title property.

AFTER:

The MinimalActivatedRouteSnapshot interface contains the required title property.

<a name="15.0.0-beta.0"></a>

15.0.0-beta.0 (2022-11-03)

Features

• component: add migration for replacing ReactiveComponentModule (#3506) (49c6cf3), closes #3491
• component: handle observable dictionaries (#3602) (42efccb), closes #3545
• component: remove ReactiveComponentModule (#3643) (4bdf345), closes #3623
• component-store: Add SelectorObject to select (#3629) (f8d0241), closes #3632 #3631
• effects: change the signature of provideEffect (#3587) (899afe7)
• effects: migration for provideEffects argument (#3601) (f7dfeab)
• effects: remove @Effect decorator (#3634) (96c5bdd), closes #3617
• eslint-plugin: remove rules using @Effect (#3635) (5f74e61)
• schematics: drop support for TypeScript <4.8 (#3631) (b9c1ab6)
• store: make reducers arg of StoreModule.forRoot optional (#3632) (e5177aa)
• store: strict projector for selectors with props (#3640) (351459f), closes #3571
• store: strict projectors (#3581) (43198a2), closes #3571

BREAKING CHANGES

• component: ReactiveComponentModule is removed in favor of LetModule and PushModule.

BEFORE:

import { ReactiveComponentModule } from '@ngrx/component';

@NgModule({
  imports: [
    // ... other imports
    ReactiveComponentModule,
  ],
})
export class MyFeatureModule {}

AFTER:

import { LetModule, PushModule } from '@ngrx/component';

@NgModule({
  imports: [
    // ... other imports
    LetModule,
    PushModule,
  ],
})
export class MyFeatureModule {}

• store: The projector method has become strict

BEFORE:

You could pass any arguments to the projector method

const selector = createSelector( selectString, // returning a string selectNumber, // returning a number (s, n, prefix: string) => { return prefix + s.repeat(n); } )

// you could pass any argument selector.projector(1, 'a', true);

AFTER:

const selector = createSelector( selectString, // returning a string selectNumber, // returning a number (s, n, prefix: string) => { return prefix + s.repeat(n); } )

// this throws selector.projector(1, 'a', true); // this does not throw because the arguments have the correct type selector.projector(1, 'a', 'prefix');

• store: The projector function on the selector is type-safe by default.

BEFORE:

The projector is not type-safe by default, allowing for potential mismatch types in the projector function.

const mySelector = createSelector(
  () => 'one',
  () => 2,
  (one, two) => 3
);

mySelector.projector(); // <- type is projector(...args: any[]): number

AFTER:

The projector is strict by default, but can be bypassed with an any generic parameter.

const mySelector = createSelector(
  () => 'one',
  () => 2,
  (one, two) => 3
);

mySelector.projector(); // <- Results in type error. Type is projector(s1: string, s2: number): number

To retain previous behavior

const mySelector = createSelector(
  () => 'one',
  () => 2,
  (one, two) => 3
)(mySelector.projector as any)();

• effects: The @Effect decorator is removed

BEFORE:

Defining an effect is done with @Effect

@Effect() data$ = this.actions$.pipe();

AFTER:

Defining an effect is done with createEffect

data$ = createEffect(() => this.actions$.pipe());

• effects: The signature of provideEffects is changed to expect a spreaded array of effects.

BEFORE:

provideEffects expecteded the effects to be passed as an array.

// single effect
provideEffects([MyEffect]);

// multiple effects
provideEffects([MyEffect, MySecondEffect]);

AFTER:

provideEffects expects the effects as a spreaded array as argument.

// single effect
provideEffects(MyEffect);

// multiple effects
provideEffects(MyEffect, MySecondEffect);

<a name="14.3.2"></a>

14.3.2 (2022-10-04)

Bug Fixes

• component: replace animationFrameScheduler with requestAnimationFrame (#3592) (0a4d2dd), closes #3591
• component-store: use asapScheduler to schedule lifecycle hooks check (#3580) (02431b4), closes #3573
• eslint-plugin: avoid-combining-selectors with arrays should warn (#3566) (4b0c6de)
• router-store: set undefined for unserializable route title (#3593) (8eb4001), closes #3495
• store: fix typing of on fn (#3577) (d054aa9), closes #3576

<a name="14.3.1"></a>

14.3.1 (2022-09-08)

Bug Fixes

• add support for TypeScript 4.8 (#3548) (d558ce1), closes #3547
• eslint-plugin: avoid-mapping-selectors don't report on ThisExpression (#3546) (a28175c), closes #3511

<a name="14.3.0"></a>

14.3.0 (2022-08-25)

Features

• effects: add provideEffects function (#3524) (db35bfe), closes #3522
• router-store: add provideRouterStore function (#3532) (511b7cf), closes #3528
• store: add provideStore and provideState functions for standalone APIs (#3539) (5639c1e), closes #3526
• store-devtools: add provideStoreDevtools function (#3537) (6b0db4e), closes #3527

<a name="14.2.0"></a>

14.2.0 (2022-08-18)

Bug Fixes

• component-store: make synchronous updater errors catchable (#3490) (1a906fd)
• component-store: move isInitialized check to queueScheduler context on state update (#3492) (53636e4), closes #2991

Features

• component-store: handle errors in next callback (#3533) (551c8eb)

<a name="14.1.0"></a>

14.1.0 (2022-08-09)

Bug Fixes

• eslint-plugin: allow sequential dispatches in a different block context (#3515) (faf446f), closes #3513
• eslint-plugin: Remove the md suffix from the docsUrl path (#3518) (71d4d4b)
• store: improve error for forbidden characters in createActionGroup (#3496) (398fbed)

Features

• component: add RenderScheduler to the public API (#3516) (4642919)
• component: replace markDirty with custom TickScheduler (#3488) (3fcd8af)

Performance Improvements

• component: do not schedule render for synchronous events (#3487) (bb9071c)

<a name="14.0.2"></a>

14.0.2 (2022-07-12)

Bug Fixes

• component: import operators from rxjs/operators (#3479) (20ef7a4)
• component-store: effect handles generics that extend upon a type (#3485) (9d2bda7), closes #3482
• data: add TSDoc annotations (#3483) (cbbc49f)
• eslint-plugin: fix configuration guide link (#3480) (8219b1d)

<a name="14.0.1"></a>

14.0.1 (2022-06-29)

Bug Fixes

• component-store: allow void callbacks in effect (#3466) (e6dedd6), closes #3462
• component-store: import operators from rxjs/operators (#3465) (f9ba513)
• schematics: add workingDirectory to schemas (#3473) (50ea6b3), closes #3469
• schematics: create schematicCollections if not exists (#3470) (011cbcc)

<a name="14.0.0"></a>

14.0.0 (2022-06-20)

Bug Fixes

• component: do not exclude falsy types from LetDirective's input type (#3460) (7028adb)

<a name="14.0.0-rc.0"></a>