ngrx-store-freeze - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #golang #android #machine-learning #deep-learning #docker #windows #kubernetes #awesome-list #security #pytorch #ios

ngrx-store-freeze

(★ 197)

@ngrx/store meta reducer that prevents state from being mutated.

File Explorer

Download Latest Version (.zip)

- docs.md
- index.ts
.gitignore
.npmignore
circle.yml
index.ts
LICENSE
package-lock.json
package.json
README.md
rollup.config.js
tsconfig.es6.json
tsconfig.json
tslint.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/brandonroberts/ngrx-store-freeze

Downloads the entire project code from GitHub to your computer.

cd ngrx-store-freeze

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i --save-dev ngrx-store-freeze

Type this command into your terminal and run it.

yarn add ngrx-store-freeze --dev

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## ngrx-store-freeze

[![npm version](https://badge.fury.io/js/ngrx-store-freeze.svg)](https://badge.fury.io/js/ngrx-store-freeze)
[![CircleCI](https://circleci.com/gh/brandonroberts/ngrx-store-freeze/tree/master.svg?style=svg&circle-token=6ba0f6b74d2186f7896a58377b8607346c07cee6)](https://circleci.com/gh/brandonroberts/ngrx-store-freeze/tree/master)

ngrx-store-freeze is a meta-reducer that prevents state from being mutated

* Recursively freezes the **current state**, the dispatched **action payload** if provided and the **new state**.
* When mutation occurs, an exception will be thrown.
* Should be used **only in development** to ensure that the state remains immutable.

### Installation

```sh
npm i --save-dev ngrx-store-freeze
```

OR

```sh
yarn add ngrx-store-freeze --dev
```

### Setup

```ts
import { StoreModule, MetaReducer, ActionReducerMap } from '@ngrx/store';
import { storeFreeze } from 'ngrx-store-freeze';
import { environment } from '../environments/environment'; // Angular CLI environment

export interface State {
  // reducer interfaces
}

export const reducers: ActionReducerMap<State> = {
  // reducers
}

export const metaReducers: MetaReducer<State>[] = !environment.production ? [storeFreeze]: [];

@NgModule({
  imports: [
    StoreModule.forRoot(reducers, { metaReducers }),
  ]
})
export class AppModule {}
```

## Additional Documentation

* [Usage with `@ngrx/router-store`](./docs/docs.md#router-store-compatibility)

## Credits

[redux-freeze](https://github.com/buunguyen/redux-freeze) - Redux middleware that prevents state from being mutated  
[Attila Egyed](https://github.com/tsm91) - The original maintainer of this project