A tiny helper library for migrating data. https://www.npmjs.com/package/migration-helper
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Bauke 72ffa26796
Version 0.1.2
5 months ago
source Make the default skip use <= instead. 5 months ago
tests Initial 0.1.0 commit! 🎉 5 months ago
.gitignore Initial 0.1.0 commit! 🎉 5 months ago
LICENSE Initial 0.1.0 commit! 🎉 5 months ago
README.md Correctly await things. 5 months ago
package.json Version 0.1.2 5 months ago
pnpm-lock.yaml Initial 0.1.0 commit! 🎉 5 months ago
tsconfig.json Initial 0.1.0 commit! 🎉 5 months ago

README.md

migration-helper

A tiny helper library for migrating data.

  • Zero dependencies
  • 100% code coverage
  • TypeScript definitions included

Usage

npm install migration-helper
import {migrate, Migration} from 'migration-helper';

// Your data that needs migrating.
const data = 'data';

// Your data's current version.
const version = '1.0.0';

// Create some migrations to apply.
const migrations: Array<Migration<string>> = [
  {
    version: '1.0.1',
    migrate: async (data: string) => `${data} migrated`,
  },
  {
    version: '1.0.2',
    migrate: async (data: string) => `${data} (again!)`,
  },
];

// Migrate your data.
const migrated = await migrate(data, version, migrations);

// Congratulations, your data is now on version 1.0.2!
console.log(migrated);

See the tests directory for how to use number, Date or a custom way of versioning.