counter.md

power-reducers

• counter
• toggle
• value
• set-simple
• task-simple
• list

---

counter

State structure

type CounterState = number;

// counter state example
5; // :-)

createReducer

USAGE (example with react-hooks)

import React, { useReducer } from "react";
import { createReducer } from "power-reducers/counter";

const [counterReducer, { getInitialState }] = createReducer({
  initial: 0,
  incrementOn: 'INCREMENT',
  incrementByOn: {
    type: 'INCREMENT_BY',
    payload: 'delta' // read data from action.delta
  },
  decrementOn: 'DECREMENT',
  _customHandlers: [{
    type: 'DOUBLE',
    handler: (state = 0) => state * 2
  }
});

export const Counter: React.SFC<{}> = () => {
  const [counterState, dispatch] = useReducer(
    counterReducer,
    getInitialState() // required for hook
  );

  function doIncrement() {
    dispatch({ type: "INCREMENT" });
  }

  function doDecrement() {
    dispatch({ type: "DECREMENT" });
  }

  function doIncrementBy10() {
    dispatch({ type: "INCREMENT_BY", payload: 10 });
  }

  function doDouble() {
    dispatch({ type: "DOUBLE" });
  }

  return (
    <>
      <p>Count: {state}</p>
      <button onClick={doIncrement}>+ 1</button>
      <button onClick={doDecrement}>- 1</button>
      <button onClick={doDouble}>x 2</button>
      <button onClick={doIncrementBy10}>+ 10</button>
    </>
  );
}

RETURNS

[
  reducerFunction, // (state, action) => newState
  {
    getInitialState, // () => initialCounterState
    generateState // (value: number) => counterState
  }
] = createReducer(/* ... */);

PARAMETERS

initial

Initial/default state value.

type: number

default: 0

incrementOn¹

What action(s) will +1

// action example:
{ type: "INCREMENT", ... }

decrementOn¹

What action(s) will -1

// action example:
{ type: "DECREMENT", ... }

incrementByOn¹

What action(s) will increment by provided value

// action example:
{ type: "INCREMENT_BY", payload: 5 }

decrementByOn¹

What action(s) will decrement by provided value

// action example:
{ type: "DECREMENT_BY", payload: 5 }

setOn¹

What action(s) will set value

// action example:
{ type: "SET_COUNTER", payload: 5 }

resetOn¹

What action(s) will set value that was set as initial

// action example:
{ type: "RESET_COUNTER", ... }

emptyOn¹

What action(s) will set value to 0 (zero)

// action example:
{ type: "SET_ZERO", ... }

_customHandlers

Create own reducers for different action(s) types (try to avoid this).

Example

createReducer({
  // ...
  _customHandlers: [
    {
      type: "DOUBLE_COUNT",
      handler: (state, action) => {
        // executed when action.type === "DOUBLE_COUNT"
        return state * 2;
      }
    }
  ]
});

---

¹ type HandlerOption - single item or Array containing the following types (can be mixed):

Parameter example	Valid action example
"SET_VALUE"	{ type: "SET_VALUE", payload: /* some data */ }
{ type: "SET_VALUE" }	{ type: "SET_VALUE", payload: /* some data */ }
{ type: "INCREMENT_BY", payload: "diff" }	{ type: "INCREMENT_BY", diff: /* some data */ }
{ type: "INCREMENT_BY", payload: (action) => someData	{ type: "INCREMENT_BY", /* data to be resolved */ }