🌻 rebloom (WIP)

rebloom exports the getUse function that turns any object into a use-able object whose properties are listened to by the use property hook inside React components.

// appState.ts
import { getUse } from 'rebloom';

class AppState {
  // define "use"
  readonly use = getUse<AppState>();

  // define other properties
  count = 0;
  ids: number[] = [];

  // define methods
  readonly increment = () => this.count++;
  readonly decrement = () => this.count--;
}

// instantiate the class and export the instance
const appState = new AppState();

export default appState;

// MyComponent.ts
import appState from './appState';

const MyComponent = () => {
  // the component is re-rendered when 'count' or 'ids' are reassigned
  const count = appState.use('count');
  const ids = appState.use('ids');

  return (
    <div onClick={() => appState.count++}>Clicks: {count}</div>
  )
}

export default MyComponent;

A use-able object is a regular object, and all its properties and methods are used in the traditional way. Properties need to maintain immutability to invoke the property accessor. The readonly prefix protects properties from being reassigned.

appState.count++;
appState.ids = [...state.users.ids, 4];
appState.increment();
appState.increment = () => {}; // error because of the "readonly" prefix

Other ways to invoke

Plain object

// appState.ts
import { type WithUse, getUse } from 'rebloom';

type AppState = WithUse<{
  count: number;
  ids: number[];
}>;

const appState: AppState = {
  use: getUse(),
  count: 0,
  ids: [],
}

Static class

Use the same principle as with an instantiable class, but all class members are defined with the static prefix, and the class isn't instantiated but used directly as an object.

// appState.ts
import { getUse } from 'rebloom';

export default class AppState {
  // define "use"
  static readonly use = getUse<typeof AppState>();

  // define other properties
  static count = 0;
  static ids: number[] = [];
  
  // define methods
  static readonly increment = () => this.count++;
  static readonly decrement = () => this.count--;
}

// MyComponent.ts
import AppState from './appState';

const MyComponent = () => {
  const count = AppState.use('count');
  const ids = AppState.use('ids');

  return (
    <div onClick={() => AppState.count++}>Clicks: {count}</div>
  )
}

export default MyComponent;

State Structure

It's recommended to split the application state into files and then collect them into a centralized application state object. In the example below, we create two classes that are instantiated in the AppState class. They also implement a constructor that accepts the appState as an argument and defines the #appState property, which can be used by other methods. This is just one of the many ways to build the app state; feel free to adapt it.

// PostState.ts
import { getUse } from 'rebloom';
import type { AppState } from './appState';

class PostState {
  readonly use = getUse<PostState>();
  
  ids: number[] = [];
  
  readonly loadPosts = async () => await fetch(/* ... */);

  readonly #appState: AppState;

  constructor(appState: AppState) {
    this.#appState = appState;
  }
}

// CommentState.ts
import { getUse } from 'rebloom';
import type { AppState } from './appState';

class CommentState {
  readonly use = getUse<CommentState>();
  
  ids: number[] = [];
  
  readonly loadComments = async () => await fetch(/* ... */);

  readonly #appState: AppState;

  constructor(appState: AppState) {
    this.#appState = appState;
  }
}

// appState.ts
import { getUse } from 'rebloom';
import PostState from './PostState';
import CommentState from './CommentState';

class AppState {
  readonly use = getUse<AppState>();

  readonly post: PostState;
  readonly comment: CommentState;

  constructor() {
    this.post = new PostState(this);
    this.comment = new CommentState(this);
  }
}

// instantiate the class and export the instance
const appState = new AppState();

export type { AppState };

export default appState;

Components can import appState and access other use-able objects as members of AppState.

// MyComponent.ts
// ...
useEffect(() => {
  void appState.post.loadPosts().then((ids) => {
    appState.post.ids = ids;
  });
})
// ...

I hope you'll find it useful in your next project!