Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
defineRemigrateConfig
✓ import { defineRemigrateConfig } from 'redux-remigrate'
✗ const { defineRemigrateConfig } = require('redux-remigrate')
ESM-only since v6; CommonJS require will not work.
_remigrateVersion
✓ import { _remigrateVersion } from 'redux-remigrate'
✗ import { remigrateVersion } from 'redux-remigrate'
Underscore prefix is intentional and acts as a private symbol.
migrate
✓ import { migrate } from './remigrate/index.ts'
✗ import { migrate } from 'redux-remigrate'
The migrate function is generated by the CLI, not exported from the package itself.
Shows the complete setup flow: install deps, create config, init migrations, integrate with Redux Remember, and generate migrations.
// 1. Install dependencies
// npm install redux redux-remember redux-remigrate
// 2. Create remigrate.config.ts
export default defineRemigrateConfig({
storagePath: './src/remigrate',
stateFilePath: './src/store.ts',
stateTypeExpression: 'PersistedState',
});
// 3. Initialize migrations directory
// npx remigrate init
// 4. Integrate with Redux Remember
import { configureStore } from '@reduxjs/toolkit';
import { rememberReducer, rememberEnhancer } from 'redux-remember';
import { _remigrateVersion } from 'redux-remigrate';
import { migrate } from './remigrate/index.ts';
const rememberedKeys = ['_remigrateVersion', 'myStateIsRemembered'] as const;
const rootReducer = rememberReducer({
_remigrateVersion,
myStateIsRemembered: (state = 'initial', action) => state,
});
const store = configureStore({
reducer: rootReducer,
enhancers: (getDefaultEnhancers) => getDefaultEnhancers().concat(
rememberEnhancer(window.localStorage, rememberedKeys, { migrate })
),
});
export type RootState = ReturnType<typeof store.getState>;
export type PersistedState = Pick<RootState, typeof rememberedKeys[number]>;
// 5. When your persisted state changes, run: npx remigrate create
Errors
Common errors & fixes
Cannot find module 'redux-remigrate' or its corresponding type declarations.
Missing or outdated TypeScript types for the package.
fixInstall types: npm install --save-dev @types/redux-remigrate; if not available, ensure tsconfig includes 'node_modules/@types'.
Error: Package 'redux-remigrate' is not ESM (it's CJS).
Using require() with ESM-only package.
fixChange to import syntax: import { ... } from 'redux-remigrate'. Module not found: Can't resolve './remigrate/index.ts'
Migrations directory not initialized or path incorrect.
fixRun npx remigrate init to generate the directory, then verify the path in your config.
TypeError: redux-remigrate requires redux >=5.0.0. Found version 4.x
Peer dependency version mismatch.
fixUpgrade redux to version 5 or later: npm install redux@5.
Audit
Dependencies
reduxrequiredpeer dependency: Redux store integration
redux-rememberrequiredpeer dependency: persistence layer for Redux
typescriptrequiredpeer dependency: required for type generation and migration logic