Welcome to Taihou!

A simple state manager written in Typescript

How to Install

Copy, paste and run, like most packages.

npm i @atsu/taihou

Usage

First of all, you just need to know one simple concept

1. value, watch and unwatch: These words are the core of Taihou.

   Use a value to read and write new data.

   You watch for changes and do something about it, and you unwatch when you want to stop watching a value.

Then you are good to go, this is a basic example on how to use it.

import { useState } from "@atsu/taihou";


const [taihou, watchTaihou, unwatchTaihou] = useState({
    list: [],
    flag: false,
});

const onTaihouUpdate = ({ list, flag }) => {
    console.log("I will receive this updated ", list);
    console.log("I will receive this updated flag as", flag);
};

watchTaihou(onTaihouUpdate);            // I want to watch for updates

taihou.list = ["I want to add this"];   // This will trigger an update
taihou.flag = true;                     // This will trigger an update again

unwatchTaihou(onTaihouUpdate);          // I am responisble and clean my listeners

Typescript

After you define your state, it should be possible to have type inference.

taihou; // Should be of type { list: any[], flag: boolean }

This is nice, and enforces a type safe development, but it can be a bit hard to read if you have a big section.

Plus, we have an any[] in the list type, TS took the initial values to type it.

We can do it better, so we simply define an TaihouState interface to feed the useState generic:

interface TaihouState {
    list: string[]
    flag: boolean
}

And include it in the useState as useState<TaihouState>.

Or you can always make your code organized, I prefer it this way:

const initialTaihouState: TaihouState = {
    list: [],
    flag: false,
}
const [taihou, watchTaihou, unwatchTaihou] = useState(initialTaihouState);

And that's it, really simple!

You can organize multiple states as sections of a store, if you want to separate concerns and also to separate the watchers' event handlers.

export const MyAppStore = {
    taihou: useState(initialTaihouState);
    azuma: useState(initialAzumaState);
    atago: useState(initialAtagoState);
}

/* In another file */
const [azuma, watchAzuma, unwatchAzuma] = MyAppStore.azuma;

Configuration

If you wanna see what's going on every update, just enable debug mode:

const [taihou, watchTaihou, unwatchTaihou] = useState(initialTaihouState, { debug: true });

This way Taihou will log any change update into the console.

Common questions and answers

Q: This basically describes the Publish-subscribe pattern, why not simply use a message system?

A: I do not want to define messages and map them in an Enum. Taihou 0.2.x used this method of doing things.

Q: Why I would use this instead of Redux or Pinia or any other store management?

A: The main point of Taihou is simplicity, it resolves the problem of needing a State and Event management and only that. This gives you also the benefit of integrating on almost any project (that uses npm).

Author

👤 Tsukugi

• Github: @Tsukugi

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!