Skip to content

Commit bb15425

Browse files
authored
Update README.md
1 parent 2a6b0d3 commit bb15425

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,23 @@
22

33
[![Greenkeeper badge](https://badges.greenkeeper.io/di-ng/redux-combine-reducers-immutable.svg)](https://greenkeeper.io/)
44

5-
A drop-in replacement for Redux's [combineReducers](https://redux.js.org/api-reference/combinereducers) helper function that returns [Immutable Records](https://facebook.github.io/immutable-js/docs/#/Record) instead of JS objects.
5+
A drop-in replacement for Redux's [combineReducers](https://redux.js.org/api/combinereducers) helper function that returns [Immutable Records](https://immutable-js.github.io/immutable-js/docs/#/Record) instead of JS objects.
6+
7+
```ts
8+
import combineReducers from 'redux-combine-reducers-immutable';
9+
10+
const rootReducer = combineReducers({
11+
users: usersReducer,
12+
});
13+
14+
// Now you can access your state with dot syntax, while still having Immutable data.
15+
// e.g. getState().users
16+
17+
export rootReducer;
18+
19+
// Note that the TypeScript types work well too!
20+
export type RootAppState = ReturnType<typeof rootReducer>;
21+
```
622

723
## Local Development
824

0 commit comments

Comments
 (0)