Holllo
/
migration-helper
1
Fork 0
Code Packages Releases 5 Activity
Tiny helper library for migrating data.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
15 Commits
1 Branch
5 Tags
175 KiB
TypeScript 100%
 
main
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
Bauke 43c3a5c132
Version 0.1.4! 		5 months ago
source Add A and B types to Migration. 5 months ago
tests Add A and B types to Migration. 5 months ago
.gitignore Initial 0.1.0 commit! 🎉 2 years ago
LICENSE Relicense to AGPL-3.0-or-later. 1 year ago
README.md Remove custom registry instructions. 5 months ago
package.json Version 0.1.4! 5 months ago
pnpm-lock.yaml Update dependencies. 1 year ago
tsconfig.json Initial 0.1.0 commit! 🎉 2 years ago

README.md

Migration 🧳 Helper

Tiny helper library for migrating data.

Features

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

Usage

import {migrate, Migration} from '@holllo/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.

License

Distributed under the AGPL-3.0-or-later license, see LICENSE for more information.