nedux v1.0.23

Nedux - The next redux

Why do you waste your time by creating actions/reducers/containers/sagas/... ? \ Just create a store and that's it !

📦 Installation

npm install nedux --save

🧲 Use Nedux with ...

😍 Examples

💻 Basic Example

Use it with Typescript ♥️

import { createStore } from 'nedux';

interface Todo {
  id: number;
  text: string;
  completed: boolean;
}

enum Filter {
  ShowAll = 'ShowAll',
  ShowCompleted = 'ShowCompleted',
  ShowActive = 'ShowActive',
}

// Create the store
const todoStore = createStore({
  todos: [] as Todo[],
  filter: Filter.ShowAll,
});

// You can subscribe to field update.
todoStore.subscribe('filter', newFilter => {
  console.log(`filter has changed with ${newFilter}`);
});

// You can get a value.
todoStore.get('filter');
// └> 'ShowAll'

// You can override a value.
todoStore.set('filter', Filter.ShowCompleted);

// Or extends value by the previous one.
todoStore.set('todos', todos => [
  ...todos,
  { id: 1, text: 'test', completed: false },
]);

// And that's it !

Or simply with Javascript

import { createStore } from 'nedux';

const todoStore = createStore({
  todos: [],
  filter: 'ShowAll',
});

todoStore.subscribe('filter', newFilter => {
  console.log(`filter has changed with ${newFilter}`);
});

todoStore.get('filter');

todoStore.set('filter', 'ShowCompleted');
todoStore.set('todos', todos => [
  ...todos,
  { id: 1, text: 'test', completed: false },
]);

📜 Documentation

Import

// ES6
import { createStore } from 'nedux';

// ES5
var createStore = require('nedux').createStore;

createStore(initialState, [middlewares])

Creates a Nedux store with the shape of the initialState.

store

The store object created by createStore it'll allow you to interact with your store.

⚓️ Middlewares

Middleware is the suggested way to extend Nedux with custom functionality. The created store is provided to each middleware. It's easy to subscribe/get/set value to the store inside your middleware. The key feature of middleware is that it is composable. Multiple middleware can be combined together, where each middleware requires no knowledge of what comes before or after it in the chain.

Basic Logger Middleware

import { createStore } from 'nedux';

const loggerMiddleware = store =>
  // we subscribe to all modifications
  store.subscribe('', value => console.log(value));

const store = createStore(
  {
    a: 0,
    b: 'b',
  },
  [loggerMiddleware],
);

store.set('b', 'a');
store.set('a', 1);
store.set('a', a => a * 2);
store.set('b', 'not b');

🏗 Advised Structure

It usually a good idea to keep the store as small as possible. You can manage your application by structure it as services. Each service will have its own store (if it's needed)

my-service
├── components # Your components.
│   ├── AddTodo.tsx
│   ├── App.tsx
│   ├── FilterLink.tsx
│   ├── Footer.tsx
│   ├── Link.tsx
│   ├── Todo.tsx
│   └── TodoList.tsx
├── controler.ts # Where you wrap your business logic (link between api/store/ui)
├── index.tsx # Where you export elements to other services.
├── store.ts # Where the store is created with the initial state.
└── types.ts # Where you put your service types.

🚀 Why choose Nedux over Redux ?

• No more actions
• No more dispatch
• No more reducers
• No more provider
• Fully functionnal usage
• Easiest to understand
• No "magical" effect (all is traceable)
• No need to use external tools to debug (again all is traceable)
• Easiest to learn
• Fully typed (if you're coding in typescript you will ♥️ it !)
• Less code to write
• Faster and lighter (no react context, no HOC)

You just write less to do the same.

🥊 Redux todos VS Nedux todos (same code)

Feel free to inspect the structure of both of them (Redux and Nedux) and how Nedux is implemented.

🥊 Redux Counter VS Nedux Counter (same code)

Again feel free to test it yourself here.

🏗 Structure

# Redux Todos
├── actions
│   └── index.js
├── components
│   ├── App.js
│   ├── Footer.js
│   ├── Link.js
│   ├── Todo.js
│   └── TodoList.js
├── containers
│   ├── AddTodo.js
│   ├── FilterLink.js
│   └── VisibleTodoList.js
├── index.js
└── reducers
    ├── index.js
    ├── todos.js
    └── visibilityFilter.js

# Nedux Todos
├── components
│   ├── AddTodo.tsx
│   ├── App.tsx
│   ├── FilterLink.tsx
│   ├── Footer.tsx
│   ├── Link.tsx
│   ├── Todo.tsx
│   └── TodoList.tsx
├── controler.ts
├── index.tsx
├── store.ts
└── types.ts

🧩 Scripts used

# Compute number of files
find $SRC_FOLDER -type f | wc -l

# Compute number of lines
find $SRC_FOLDER -type f -exec cat {} \; | grep -v -e '^$' | grep -v -e '^//' | wc -l

# Compute number of characters
find $SRC_FOLDER -type f -exec cat {} \; | grep -v -e '^$' | grep -v -e '^//' | tr -d '[:space:] ' | wc -c

🔎 Profiling method

Profiling is made with React Profiling following this configuration :

📋 Todos

• Add sandbox for each examples
• Add tests
• Be more accurate on performance comparison
• Add more examples
• Type cleaning
• Add CI
• Add VueJS connector
• Add Angular connector

🙋🏼 Contributions

All Pull Requests, Issues and Discussions are welcomed !