Code Monkey home page Code Monkey logo

transys's Introduction

TranSys - simple transition system middleware + enhancer for redux

Usage:

import { createStore } from 'redux'
import transys from 'transys'

/**
 *  States
 */
const INVALIDATED = 'INVALIDATED'
const FETCHING = 'FETCHING'
const OK = 'OK'
const states = [INVALIDATED, FETCHING, OK]

const initialState = {
    systemState: INVALIDATED,
    data: null
}

const transitionMatrix = [
    {
        from: INVALIDATED,
        to: FETCHING
    },
    {
        from: FETCHING,
        to: OK,
        do: (state = {}, { data }) => ({
            ...state,
            data
        })
    },
    {
        from: OK,
        to: INVALIDATED
    }
]

const store = createStore(
    transys.buildReducer({
        initialState,
        states,
        transitionMatrix
    })
)

console.log(store.getState().systemState)
// => 'INVALIDATED'

// When dispatching a FETCHING action while in INVALIDATED, the transition is
// applied:
store.dispatch({ type: FETCHING })
console.log(store.getState().systemState)
// => 'FETCHING'

// There is no transition from FETCHING to INVALIDATED:
store.dispatch({ type: INVALIDATED })
console.log(store.getState().systemState)
// => 'FETCHING'

store.dispatch({ type: OK })
console.log(store.getState().systemState)
// => 'OK'

You can combine the constructed reducer with your own reducer by using [[reduce-reducers][https://github.com/redux-utilities/reduce-reducers]]:

import reduceReducers from 'reduce-reducers'

const store = createStore(
    reduceReducers(
        anotherReducer,
        yourReducer,
        transys.buildReducer({ ... }),
        initialState
    )
)

Why use this?

TranSys abstracts the inner workings of a transition system away. It allows you to specify a number of possible states and transitions between them, but takes over the responsibility to manage which state is currently active.

Currently this is in no shape to be actually used.

Goals

Implement already foreshadowed utility methods and action generators.

The action generators will provide (optionally async) basics for dispatching state changes to the store using [[redux-thunk][https://github.com/reduxjs/redux-thunk]].

The utility methods will allow to subscribe to state changes based on some criteria.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.