• Public
  • Public/Protected
  • All

Which Version to use?

Angular 5+

Use @angular-redux/store@^7 - this version supports Angular 5, and also changes to using lettable operators.

Any new major releases will released on the v7 branch and with the @latest tag for final publishes.

Angular 4 or lower

Use @angular-redux/store@^6 - This supports Angular 4 and earlier.

Support for @angular-redux/store@6?

Where possible, I will be maintaining and applying any fixes / enhancements for v7 into v6 where it does not introduce a breaking change.

I made a few mistakes trying to publish fixes / etc to two major versions, which caused some releases to get tagged incorrectly and caused some confusion. Sorry for any confusion this has caused, and will do better on avoiding this in the future, and being more transparent with the releases that are going out.


Angular bindings for Redux.

For Angular 1 see ng-redux

Join the chat at https://gitter.im/angular-redux/ng2-redux CircleCI npm version downloads per month

What is Redux?

Redux is a popular approach to managing state in applications. It emphasises:

  • A single, immutable data store.
  • One-way data flow.
  • An approach to change based on pure functions and a stream of actions.

You can find lots of excellent documentation here: Redux.

What is @angular-redux?

We provide a set of npm packages that help you integrate your redux store into your Angular 2+ applications. Our approach helps you by bridging the gap with some of Angular's advanced features, including:

  • Change processing with RxJS observables.
  • Compile time optimizations with NgModule and Ahead-of-Time compilation.
  • Integration with the Angular change detector.

Getting Started


Here are some examples of the angular-redux family of packages in action:

Companion Packages


In-Depth Usage

@angular-redux/store uses an approach to redux based on RxJS Observables to select and transform data on its way out of the store and into your UI or side-effect handlers. Observables are an efficient analogue to reselect for the RxJS-heavy Angular world.

Read more here: Select Pattern

We also have a number of 'cookbooks' for specific Angular topics:

Hacking on angular-redux/store

Want to hack on angular-redux/store or any of the related packages? Feel free to do so, but please test your changes before making any PRs.

Here's how to do that:

  1. Write unit tests. You can check that they work by running npm test.
  2. Run the linter. If your editor doesn't do it automatically, do it manually with npm run lint.
  3. Test your changes in a 'real world scenario'. We use the example-app for this, using some npm fakery to 'publish the package locally':

  4. clone the example app (git clone https://github.com/angular-redux/example-app.git)

  5. generate a 'local package' (cd to your angular-redux/store clone and run npm pack). This will create a .tgz file.
  6. hook your 'local package' up to your example-app (cd to your example-app clone and run npm install --save /path/to/the/tgz/file/from/above)
  7. run ng serve --aot

Please make sure your changes pass Angular's AoT compiler, because it's a bit finicky with TS syntax.


Type aliases


Comparator: function

Custom equality checker that can be used with .select and @select. `ts const customCompare: Comparator = (x: any, y: any) => { return x.id === y.id }

@select(selector, customCompare) `

Type declaration

    • (x: any, y: any): boolean
    • Parameters

      • x: any
      • y: any

      Returns boolean


FunctionSelector: function

Type declaration

    • (s: RootState): S
    • Parameters

      • s: RootState

      Returns S


PathSelector: (string | number)[]


PropertySelector: string | number | symbol


Selector: PropertySelector | PathSelector | FunctionSelector<RootState, S>


Transformer: function

Type declaration

    • (store$: Observable<RootState>, scope: any): Observable<V>
    • Parameters

      • store$: Observable<RootState>
      • scope: any

      Returns Observable<V>



  • WithSubStore(__namedParameters: object): ClassDecorator


  • dispatch(): PropertyDecorator
  • Auto-dispatches the return value of the decorated function.

    Decorate a function creator method with @dispatch and its return value will automatically be passed to ngRedux.dispatch() for you.

    Returns PropertyDecorator


  • enableFractalReducers(rootReducer: Reducer<any, AnyAction>): function
  • Parameters

    • rootReducer: Reducer<any, AnyAction>

      Call this on your root reducer to enable SubStore functionality for pre-configured stores (e.g. using NgRedux.provideStore()). NgRedux.configureStore does it for you under the hood.

    Returns function

      • (state: S | undefined, action: A): S
      • Parameters

        • state: S | undefined
        • action: A

        Returns S


  • Selects an observable from the store, and attaches it to the decorated property.

     import { select } from '@angular-redux/store';
     class SomeClass {
       @select(['foo','bar']) foo$: Observable<string>

    Type parameters

    • T


    • Optional selector: Selector<any, T>

      A selector function, property name string, or property name path (array of strings/array indices) that locates the store data to be selected

    • Optional comparator: Comparator

      Function used to determine if this selector has changed.

    Returns PropertyDecorator


  • Selects an observable using the given path selector, and runs it through the given transformer function. A transformer function takes the store observable as an input and returns a derived observable from it. That derived observable is run through distinctUntilChanges with the given optional comparator and attached to the store property.

    Think of a Transformer as a FunctionSelector that operates on observables instead of values.

    import { select$ } from 'angular-redux/store';
    export const debounceAndTriple = obs$ => obs$
     .map(x => 3 * x);
    class Foo {
     @select$(['foo', 'bar'], debounceAndTriple)
     readonly debouncedFooBar$: Observable<number>;

    Type parameters

    • T


    Returns PropertyDecorator


  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc