@coaction/persist

English documentation · 中文文档

A persist middleware for Coaction.

Installation

Install it with pnpm:

pnpm add coaction @coaction/persist

Usage

import { create } from 'coaction';
import { persist } from '@coaction/persist';

const store = create(
  (set) => ({
    count: 0,
    increment() {
      set((draft) => {
        draft.count += 1;
      });
    }
  }),
  {
    middlewares: [
      persist({
        name: 'counter'
      })
    ]
  }
);

Documentation

When a persisted payload has an explicit version that does not match the configured version, provide migrate to hydrate it. Without migrate, hydration is skipped and onRehydrateStorage receives the current state plus an error.

Custom merge functions can return an exact replacement. The replacement still follows Coaction's fixed schema rules: unknown root keys are rejected, while known single-store root keys may be absent and then read as undefined from the public state object.

You can find the documentation here.