Skip to main content

State

State is a an object which stores data and emits event when it changes.

State visual diagram

Properties and methods​

  • config - resolved config
  • events - record of AwaiEvent events
  • get - method that returns current value
  • set - method that sets new value

Events​

  • changed - state value is modified

Examples​

State usage
const counter = state(0);

setTimeout(counter.set, 100, 'hello');
setTimeout(counter.set, 200, 'awai');

const value1 = await counter.events.changed;
const value2 = await counter.events.changed; 

console.log(`${value1} ${value2}`); // hello awai
Hint

It's quite remarkable that counter.events.changed has always the same reference. Notice how it was resolved with two different values in the snippet above.

Update state using callback
const counter = state(1);

counter.set((current) => current + 1);

console.log(counter.get()); // 2

Types​

Source

const state = <T>(initialValue: T, config?: Partial<Config>): State<T> => { /* ... */ };

interface Config {
  id: string;
  tags: string[];
}