🔨 Fix doc ci

This commit is contained in:
s 2021-04-09 23:36:13 +05:30
parent 31f8b4c438
commit 1f315ff29b
2 changed files with 10 additions and 26 deletions

View File

@ -1,12 +1,17 @@
# NodeRedux Module # NodeRedux Module
| Since | Origin / Contributor | Maintainer | Source |
| :----- | :-------------------- | :---------- | :------ |
| 2021-04-09 | [Shubham Srivastava](https://github.com/shubham-sri) | [Shubham Srivastava](https://github.com/shubham-sri) | [node_redux.lua](../../lua_modules/node_redux/node_redux.lua) |
<br>
Redux is a predictable state container for lua apps and NodeMCU. Redux is a predictable state container for lua apps and NodeMCU.
## Influences ### Influences
NodeRedux evolves the ideas of [Redux](https://redux.js.org/), NodeRedux evolves the ideas of [Redux](https://redux.js.org/),
which help to maintain state lua base app basically NodeMCU devices. which help to maintain state lua base app basically NodeMCU devices.
## Basic Example ### Basic Example
The whole global state of your app is stored in an object tree inside a single _store_. The whole global state of your app is stored in an object tree inside a single _store_.
The only way to change the state tree is to create an _action_, The only way to change the state tree is to create an _action_,
@ -16,18 +21,7 @@ functions that calculate a new state based on the old state and the action.
```lua ```lua
local redux = require('redux') -- optional line for nodemcu, only need for lua app local redux = require('redux')
-- This is a reducer - a function that takes a current state value and an
-- action object describing "what happened", and returns a new state value.
-- A reducer's function signature is: (state, action) => newState
--
-- The NodeRedux state should contain only plain Lua table.
-- The root state value is usually an table. It's important that you should
-- not mutate the state table, but return a new table if the state changes.
--
-- You can use any conditional logic you want in a reducer. In this example,
-- we use a if statement, but it's not required.
local function counterReducer(state, action) local function counterReducer(state, action)
state = state or { value = 0 } state = state or { value = 0 }
@ -111,18 +105,7 @@ redux.combineReducers({
#### Example #### Example
```lua ```lua
local redux = require('redux') -- optional line for nodemcu, only need for lua app local redux = require('redux')
-- This is a reducer - a function that takes a current state value and an
-- action object describing "what happened", and returns a new state value.
-- A reducer's function signature is: (state, action) => newState
--
-- The NodeRedux state should contain only plain Lua table.
-- The root state value is usually an table. It's important that you should
-- not mutate the state table, but return a new table if the state changes.
--
-- You can use any conditional logic you want in a reducer. In this example,
-- we use a if statement, but it's not required.
local function counterReducer(state, action) local function counterReducer(state, action)
state = state or { value = 0 } state = state or { value = 0 }

View File

@ -63,6 +63,7 @@ pages:
- 'lm92': 'lua-modules/lm92.md' - 'lm92': 'lua-modules/lm92.md'
- 'mcp23008': 'lua-modules/mcp23008.md' - 'mcp23008': 'lua-modules/mcp23008.md'
- 'mcp23017': 'lua-modules/mcp23017.md' - 'mcp23017': 'lua-modules/mcp23017.md'
- 'node_redux': 'lua-modules/node_redux.md'
- 'redis': 'lua-modules/redis.md' - 'redis': 'lua-modules/redis.md'
- 'telnet': 'lua-modules/telnet.md' - 'telnet': 'lua-modules/telnet.md'
- 'yeelink': 'lua-modules/yeelink.md' - 'yeelink': 'lua-modules/yeelink.md'