API

TypeScript Definition

export type State = object;
export type Fire = (actionName: string, payload?: any) => any;
export type Subscriber = (state: State, previous: State) => any;
export type Unsubscriber = () => void;

export interface UnifireConfig {
  state: State;
  // This needs to be an object of functions but it's currently just a function
  actions: ({ state: State, fire: Fire }, payload?: any) => any;
}

export interface Store {
  state: State;
  fire: Fire;
  subscribe: (subscriber: string[] | Subscriber, override: Subscriber) => Unsubscriber;
  register: (config: UnifireConfig) => void;
}

export default function (config: UnifireConfig): Store;