Numbers Produce Meaning

    migration-helper
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.2 • Public • Published

    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.

    Keywords

    none

    Install

    npm i migration-helper

    DownloadsWeekly Downloads

    0

    Version

    0.1.2

    License

    GPL-3.0-or-later

    Unpacked Size

    40.6 kB

    Total Files

    6

    Last publish

    Collaborators

    • bauke