npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@geprog/node-migrate-ts

v3.4.1

Published

Abstract migration framework using TypeScript

Downloads

19

Readme

Node Migrate TS

Abstract migration framework using TypeScript.

Creating a migration

A migration is a simple Migration object containing a unique id and implementations for up and down.
If necessary up and down can be async.

// exampleMigration.ts
import { Migration } from '@geprog/node-migrate-ts';

export const exampleMigration: Migration = {
  id: 'exampleMigration', // unique migration identifier
  up() {
    console.log('Do some migrations in here');
  },
  down() {
    console.log('Revert your migration in here');
  },
};

State Storage

The state of migrations can be stored anywhere by passing a MigrationStore implementation to up

Currently implemented MigrationStores are:

Contributions are very welcome! :wink:

Applying Migrations

This example uses MongoMigrationStore as MigrationStore.

import { Migration, MongoMigrationStore, up } from '@geprog/node-migrate-ts';
import { MongoClient } from 'mongodb';
import { exampleMigration } from './exampleMigration';

// migrations are applied in the order defined here
const migrations: Migration[] = [exampleMigration];

const client = await MongoClient.connect('mongodb://user:password@localhost:27017/database?authSource=admin', {
  useUnifiedTopology: true,
});
const db = client.db();

const migrationStore = new MongoMigrationStore();
migrationStore.init({
  db,
  migrationsCollection: 'migrations',
});

await up({ migrations, migrationStore });

await client.close();

Passing a migration context

To avoid a lot of boilerplate in the migrations, a context can be passed to up. This context will then be available in the migrations up and down functions.

To clarify, here is a modification of the above example to pass the database connection to all migrations:

import { Migration, MongoMigrationStore, up } from '@geprog/node-migrate-ts';
-import { MongoClient } from 'mongodb';
+import { Db, MongoClient } from 'mongodb';
import { exampleMigration } from './exampleMigration';

+declare module '@geprog/node-migrate-ts' {
+  interface MigrationContext {
+    db: Db;
+  }
+}
+
// migrations are applied in the order defined here
const migrations: Migration[] = [exampleMigration];

const client = await MongoClient.connect('mongodb://user:password@localhost:27017/database?authSource=admin', {
  useUnifiedTopology: true,
});
const db = client.db();

const migrationStore = new MongoMigrationStore();
migrationStore.init({
  db,
  migrationsCollection: 'migrations',
});

-await up({ migrations, migrationStore });
+await up({ migrations, migrationStore, context: { db } });

await client.close();

The migrations can now use the database connection from the context.

import { Migration } from '@geprog/node-migrate-ts';
import { ObjectId } from 'mongodb';

export const exampleMigration: Migration = {
  id: 'exampleMigration',
  async up(context) {
    if (!context || !context.db) {
      throw new Error('Please pass a context with a db object');
    }
    const { db } = context;

    console.log('Migrate some mongodb here');
  },
  async down(context) {
    if (!context || !context.db) {
      throw new Error('Please pass a context with a db object');
    }
    const { db } = context;

    console.log('Migrate some mongodb here');
  },
};

Attribution

This project is based on: