Commit4a2ba4a

authored

Merge branch 'master' into rz/updateReference

2 parents2abfd2c +7492972 commit4a2ba4aCopy full SHA for 4a2ba4a

File tree

+18232

-4999

lines changed

+18232

-4999

lines changed

Lines changed: 17 additions & 23 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,37 +17,31 @@ yarn add redux-dynamic-modules`
`17`	`17`	`- Create a module with the following format`
`18`	`18`
`19`	`19`	```typescript
`20`		`-exportfunction getUsersModule():IModule<IUserState> {`
`21`		`-return {`
`22`		`- id:"users",`
`23`		`- reducerMap: {`
`24`		`- users:usersReducer,`
`25`		`- },`
`26`		`-// Actions to fire when this module is added/removed`
`27`		`-// initialActions: [],`
`28`		`-// finalActions: []`
`29`		`- };`
`30`		`-}`
	`20`	`+exportconst UsersModule:IModule<IUserState>= {`
	`21`	`+ id:"users",`
	`22`	`+ reducerMap: {`
	`23`	`+ users:usersReducer,`
	`24`	`+ },`
	`25`	`+// Actions to fire when this module is added/removed`
	`26`	`+// initialActions: [],`
	`27`	`+// finalActions: []`
	`28`	`+};`
`31`	`29`	```
`32`	`30`
`33`	`31`	- Create a`ModuleStore`
`34`	`32`
`35`	`33`	```typescript
`36`	`34`	`import {createStore,IModuleStore }from"redux-dynamic-modules";`
`37`		`-import {getUsersModule }from"./usersModule";`
	`35`	`+import {UsersModule }from"./usersModule";`
`38`	`36`
`39`	`37`	`const store:IModuleStore<IState>=createStore(`
`40`		`-/* initial state*/`
`41`		`- {},`
`42`		`-`
`43`		`-/ enhancers /`
`44`		`- [],`
`45`		`-`
`46`		`-/* Extensions to load*/`
`47`		`-`
`48`		`- [],`
`49`		`-`
`50`		`-getUsersModule()`
	`38`	`+ {`
	`39`	`+ initialState: {},`
	`40`	`+//extensions: [],`
	`41`	`+//enhancers: [],`
	`42`	`+//advancedCombineReducers: null`
	`43`	`+ },`
	`44`	`+UsersModule`
`51`	`45`	`/* ...any additional modules*/`
`52`	`46`	`);`
`53`	`47`	```

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,14 @@`
	`1`	`+#Redux Devtools Extension`
	`2`	`+`
	`3`	+`redux-dynamic-modules` integrates with[Redux devtools](https://github.com/zalmoxisus/redux-devtools-extension) by default using its default options. If you want to use custom devtools options, you can use the`advancedComposeEnhancers` property when creating a store:
	`4`	`+`
	`5`	+```typescript
	`6`	`+import {createStore }from"redux-dynamic-modules";`
	`7`	`+import {composeWithDevTools }from"redux-devtools-extension/developmentOnly";`
	`8`	`+`
	`9`	`+const store=createStore({`
	`10`	`+ advancedComposeEnhancers:composeWithDevTools({`
	`11`	`+ maxAge:500,`
	`12`	`+ }),`
	`13`	`+});`
	`14`	+```

Lines changed: 16 additions & 11 deletions

Original file line number	Diff line number	Diff line change
@@ -12,19 +12,24 @@ To create a `ModuleStore`, use the `createStore` function from our package
`12`	`12`
`13`	`13`	```typescript
`14`	`14`	`import {createStore,IModuleStore }from"redux-dynamic-modules";`
`15`		`-import {getUsersModule }from"./usersModule";`
	`15`	`+import {UsersModule }from"./usersModule";`
`16`	`16`
`17`	`17`	`const store:IModuleStore<IState>=createStore(`
`18`		`-/* initial state*/`
`19`		`- {},`
`20`		`-`
`21`		`-/ enhancers /`
`22`		`- [],`
`23`		`-`
`24`		`-/* Extensions to load*/`
`25`		`- [],`
`26`		`-`
`27`		`-getUsersModule()`
	`18`	`+ {`
	`19`	`+ initialState: {},`
	`20`	`+//extensions: [],`
	`21`	`+//enhancers: [],`
	`22`	`+//advancedCombineReducers: null`
	`23`	`+ },`
	`24`	`+UsersModule`
`28`	`25`	`/* ...any additional modules*/`
`29`	`26`	`);`
`30`	`27`	```
	`28`	`+`
	`29`	`+##Advanced Usage`
	`30`	`+`
	`31`	+You can pass additional properties to`createStore` to further customize its usage
	`32`	`+`
	`33`	+-`extensions: IExtension[]`: Any extensions you want to run along with the store. See[Extensions](Extensions.md) for more info.
	`34`	+-`enhancers: Enhancer[]`: Any Redux enhancers you want to add. These will automatically be composed together.
	`35`	+-`advancedCombineReducers`: Provide a custom implementation of`combineReducers`, which can be helpful for working with libraries like ImmutableJS.[See Here](https://github.com/gajus/redux-immutable)

Lines changed: 1 addition & 1 deletion

Comments

(0)