A simple state management for JS applications without dependencies.
< 500 Bytes 🏋️ and Typescript friendly.
👀 Examples
🔧 Installation
With CDN
<script src="https://unpkg.com/simte@0.0.1/dist/index.iife.js"></script>
const { createState } = simte
With NPM
yarn add simte
npm i simte
import { createState } from 'simte'
💻 Usage
const state = createState({ counter: 0 })
state.subscribe(state => console.log(`The state has changed: ${state}`))
state.setState({ counter: 1 })
📕 API
createState(state)
Initialize the given state and return 4 methods:
- getState
- setState
- subscribe
- unsubscribe
.getState()
Return the current state
.setState(newState)
Update the current state with given parameter. This update will trigger listeners.
.subscribe(listener)
Setup a listener with given parameter. The listener should be a function who receive the new state. The subscribe method will return an id (used for unsubscribe).
.unsubscribe(id)
Unsubscribe a listener with his identifier.
Typescript
You can use your Type
with Typescript. The return of the getState function, the parameter of the setState function, and the parameter of each listener will use this type.
type MyState = {
counter: number
}
const state = createState<MyState>({ counter: 0 })
state.getState()
state.setState({ counter: 1, newProperty: 'hello' })