API 参考

createStore

function createStore<T extends object>(creator: StateCreator<T>): UseStore<T>

创建一个 MobX-backed store，返回一个 store hook。

参数

参数	类型	说明
creator	StateCreator<T>	初始化函数，接收 set 和 get，返回初始状态对象

返回值

UseStore<T> — 一个可调用的函数，同时挂载了 getState、setState、subscribe 静态方法：

const useStore = createStore(...);

// 1. 调用 hook → 返回响应式 state 对象
const state = useStore();

// 2. 静态方法
useStore.getState()          // 返回当前 state
useStore.setState(partial)   // 更新 state
useStore.subscribe(listener) // 订阅状态变更，返回 unsub 函数

示例

interface BearState {
  bears: number;
  increase: () => void;
}

const useBearStore = createStore<BearState>((set) => ({
  bears: 0,
  increase: () => set((s) => ({ bears: s.bears + 1 })),
}));

---

StateCreator<T>

type StateCreator<T extends object> = (
  set: SetState<T>,
  get: GetState<T>,
  api: StoreApi<T>,
) => T;

传给 createStore 的初始化函数类型。Middleware 可以在 creator 返回前替换 api.setState，从而拦截所有状态更新。

---

SetState<T>

type SetState<T> = (partial: Partial<T> | ((state: T) => Partial<T>)) => void;

更新 store 状态的函数。支持两种调用形式：

对象形式（浅合并）

set({ count: 1 });

更新函数形式（基于当前状态计算）

set((s) => ({ count: s.count + 1 }));

set 内部使用 Object.assign 进行浅合并。对于嵌套对象，需手动展开旧值。

---

GetState<T>

type GetState<T> = () => T;

返回当前 store 状态的函数。通常在 action 内部用于读取最新状态：

const useStore = createStore((set, get) => ({
  count: 0,
  doubled: () => get().count * 2,
}));

---

UseStore<T>

type UseStore<T extends object> = (() => T) & StoreApi<T>;

createStore 的返回类型。

---

StoreApi<T>

interface StoreApi<T> {
  getState: GetState<T>;
  setState: SetState<T>;
  subscribe: Subscribe<T>;
}

getState()

返回当前 store 状态（MobX observable 对象）。

const current = useStore.getState();

setState(partial)

在组件外更新 store 状态，使用方式与 set 相同。

useStore.setState({ count: 99 });
useStore.setState((s) => ({ count: s.count + 1 }));

subscribe(listener) / subscribe(selector, listener, options?)

两种调用形式：

全状态订阅（对 store 任意属性变化均触发）：

const unsub = useStore.subscribe((state, prevState) => {
  console.log('changed:', prevState, '→', state);
});

选择器订阅（只跟踪 selector 返回的切片，避免整棵状态树的深度克隆开销）：

// 只在 count 变化时触发
const unsub = useStore.subscribe(
  (s) => s.count,
  (count, prevCount) => console.log(count, prevCount),
);

// 自定义相等性判断
const unsub2 = useStore.subscribe(
  (s) => s.value,
  (v, prev) => console.log(v, prev),
  { equals: (a, b) => Math.abs(a - b) < 10 },
);

两种形式均基于 MobX reaction + comparer.structural 实现：仅当状态结构性变化时才触发 listener。

// 取消订阅
unsub();

---

Subscribe<T>

interface Subscribe<T> {
  // 全状态订阅
  (listener: (state: T, prevState: T) => void): () => void;
  // 选择器订阅（只跟踪选中切片）
  <U>(
    selector: (state: T) => U,
    listener: (selectedState: U, prevSelectedState: U) => void,
    options?: { equals?: (a: U, b: U) => boolean },
  ): () => void;
}

---

## 类型导出一览

```ts
import type {
  GetState,
  SetState,
  StateCreator,
  StoreApi,
  Subscribe,
  UseStore,
} from '@piant/store';