iFlow is a concise & powerful state management framework.

It's dynamic and extensible, you can directly use it to add, delete and reassign the state/action. It completely supports plain class and function based on mutable data structures, and be easy to OOP. If you use React, you need use react-iflow for the connector.

• 🎯Plain class and function - Concise, Freestyle of the store structure for personal preference.
• 🏬Store tree compose - Store tree be easy to store share the operating.
• ⚡️Dynamic and hot-swapping - Both the temporary state and action can be directly and freely changed.
• 💥Async function and others type functions - Any actions will be composed or invoked internal.
• 🚀Powerful middleware - Middleware can handle the store any change event.

Documents / 中文文档

• Features
• Installation
• Getting started
  • State
  • Action
  • Data flow
• Gist
• Examples
• API Reference
• How it works
• Documentation
• Benefits
• Limitations and pitfalls
• Support and compatibility
• Change Log

• State

support all ECMAScript2015 data types except function, and state can be defined or assigned later.

import iFlow from 'iflow'

const pipe = iFlow({
  counter: 0,
})

• Action

support all type functions, and dynamic insert action or remove it.If you use function, its function's this is the current self pipe store. If you ues arrow function, the last argument is the current self pipe store.

import iFlow from 'iflow'

const pipe = iFlow({
  calculate: function(number) {
    this.counter += number
  },
  counter: 0,
})

• Data flow

View trigger function from store action, and run state's setter paths/value, then its setter paths was matched to the components's getter paths, finally decide whether to update

import iFlow from 'iflow'

const pipe = iFlow({
  calculate: function(number) {
    this.counter += number
  },
  counter: 0,
})

const store = pipe.create()

store.calculate(1)
console.log(store.counter) // console.log: 1

yarn add iflow
//or
npm install --save iflow

If you want to use it completely, you may also need a connector for your Web view framework. For example, you used React and iFlow, and you should use react-iflow for the connector.

import iFlow from 'iflow'

const pipe = iFlow({
  calculate: function(number) {
    this.counter += number
  },
  counter: 0,
})

pipe.addObserver((store) => {
  console.log(`log '[ store counter ]': `, store.counter)
})

const store = pipe.create({counter: 1})
store.calculate(1)

• Counter(Online)
• TODO(Online)

• iFlow

It can handle data structures other than function.

import iFlow from 'iflow'

const pipe = iFlow({
  counter: 0,
  calculate (number) {
    this.counter += number
  }
})

import iFlow from 'iflow'

class Count {
  constructor () {
    this.counter = 0
  }

  calculate (number) {
    this.counter += number
  }
}

const pipe = iFlow(new Count())

import iFlow from 'iflow'
const pipe = iFlow([])

• middleware()

The Middleware API will Listen to the store any change, and modify it.

pipe.middleware({
  init: (...args) => {},
  start: (...args) => {},
  before: (...args) => {},
  after: (...args) => {},
  end: (...args) => {},
})

• The middleware tables are as follows:

• create()

Every pipe will be created with initial value or without.

const store = pipe.create({
  counter: 100,
})

• batch(action,...paths) / @batch(...paths)

It will batch to update the states

No pass the paths arguments, then it will update the pipe store.

const pipe = iFlow({
  action: batch(function(){
    //state changes
    this.foo.push(1)
    this.foobar.bar.push(2)
  })
})

const pipe = iFlow({
  action: function(){
    batch(()=>{
      //state changes
      this.foo.push(1)
      this.foobar.bar.push(2)
    }, 'foo', ['foobar','bar']).call(this)
  }
})

class Pipe {
  @batch('foo', ['foobar','bar'])
  action(){
    //state changes
    this.foo.push(1)
    this.foobar.bar.push(2)
  }
}
const pipe = iFlow(new Pipe())

Online Documents

• Introduction
• Basics
• Advanced
• API
• Tips
• React
• FAQ

• Keep the data structure primitive

iFlow because of the proxy mechanism, it retains the primitive nature of the data structure while supporting asynchronous functions as well as other types of functions, including, of course, ordinary classes and functions.

• No boilerplate code

iFlow can give you more freedom to use it to implement a state data structure that is in line with the actual development needs, and not to have too many boilerplate code because of the limitations of various libraries.

• Be easy to OOP

Sometimes when we need decoupled business code, we may need some object-oriented programming when design, so the State Library is better if it can support it.

• As few selectors as possible

When using a web framework such as react, the corresponding connection library react-iflow allows you to write and manipulate as few selectors as possible.

• Powerful middleware

If necessary, in fact iflow is powerful and useful, and you can use it to implement a variety of coupled business codes.

• Composable and scalable store

iFlow advocates the store group to synthesize the store tree without worrying about the performance impact of the unrelated store, because it is dynamically matched and you can be assured of free combination and expansion of the store.

• Unable to automate batch update within dispatcher

For the action of a normal synchronization process, the merge problem with the same state being changed multiple times is ignored and we will fix it.

• Computed not implemented

We consider implementing standard observable to complete computed, or implementing non-standard immutable patterns to cache derivative computations.

• Proxy/Reflect polyfill not supported

Since IE11 does not support ES6 Proxy/Reflect, we will consider adding Proxy/Reflect polyfill to support IE11.

• Immutable not supported

A sub-component that is connected to the state component is iFlow, and the shouldComponentUpdate API within its sub-component will not be able to be judged for update control if it is used in the iFlow of the parent component.

• A prototype chain function injection of a primitive type that does not support native proxy cannot trigger notification of these types of change behavior automatically

Currently known unsupported types are: Set / WeakSet / Map / WeakMap, and soon we will support it.

• Completed alpha version

MIT