Giter Club home page Giter Club logo

choo-model's Introduction

choo-model stability

npm version build status test coverage downloads js-standard-style

State management lib for choo โœŒ๏ธ. Experiment for now. Might become part of choo at some point, who knows.

Usage

const Model = require('choo-model')
const mount = require('choo/mount')
const html = require('choo/html')
const choo = require('choo')

const app = choo()

app.model(todosModel())
app.router(['/', mainView ])
mount('body', app.start())

function todosModel () {
  const model = Model('todos')
  model.state({ todos: [] })
  model.reducer('add', (state, data) => state.push({ text: data }))
  return model.start()
}

function mainView (state, prev, send) {
  return html`
    <body>
      <main><p>Todos: ${state.todos}</p></main>
    </body>
  `
}

API

model = Model(namespace?)

Create a new model instance

model.start()

Return the model object, ready for the app.model() call.

model.reducer(name, reducer)

Create a new reducer

model.state(state)

Save new state. The resulting state is combined into a single state object under the hood.

model.subscription(name, subscription)

Create a new subscription

model.effect(name, effect)

Create a new effect

model.effect(name, effect)

Create a new effect

Installation

$ npm install choo-model

FAQ

Why?

Because experimenting outside of core is the right way to do things.

What can we expect to land in here?

Probably the ability to set constraints on send() calls so they can't access everything. Also the ability to create graph data based on those constraints. Perhaps selectors too. Y'know, basic stuff.

Why aren't you doing X first?

Having a solid story for state management is quite important. Some abstractions start to break down once apps grow; we're hitting that point. Everything else is irrelevant if we can't scale and use it ourselves on real projects.

How can I contribute?

Try it out. Build things on top of it. Build out alternatives.

Is this optimizable?

Yeah, definitely - if this ever makes the cut we can statically analyze the code and precompile the result so it'll have no overhead at runtime. Yay!

License

MIT

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.