Registry / database / migrate-mongoose-typescript

migrate-mongoose-typescript

library3.3.4jsnpmunverified

A Mongoose-based migration framework for Node.js with TypeScript support, version 3.3.4. Stores migration state in MongoDB, avoiding file-system dependency issues common in PaaS environments. Supports promises/callbacks, custom config files, removal of stale migrations, and writing migrations in TypeScript. Differentiates from alternatives like migrate-mongoose by providing first-class TypeScript support and global migration state tracking.

database

npm install migrate-mongoose-typescript

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MIGRATE-MONGOOSE-T

migrate-mongoose-typescript

databasejavascriptv3.3.4

harness data pending

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.

migrate

✓ import migrate from 'migrate-mongoose-typescript'

✗ const migrate = require('migrate-mongoose-typescript')

ESM only. The package exports a default export, not named exports. Do not use require().

default export (programmatic API)

✓ import migrate from 'migrate-mongoose-typescript'; migrate('list', options)

✗ import { migrate } from 'migrate-mongoose-typescript'

The function is the default export. Named import will fail with undefined.

CLI usage

✓ npx migrate list -d <uri>

✗ npx migrate-mongoose-typescript list -d <uri>

The CLI command is 'migrate', not the package name. After install, 'migrate' is available in node_modules/.bin.

Shows how to install, create a migration, and run up/down commands via CLI. Includes basic migration file structure.

// First, install the package: // npm install migrate-mongoose-typescript // Create a migration file (run in terminal): // npx migrate create add_users -d mongodb://localhost:27017/mydb // This creates ./migrations/20231001120000-add_users.js // Edit the migration file: // up: async (db, next) => { // await db.collection('users').insertOne({ name: 'Alice' }); // next(); // } // down: async (db, next) => { // await db.collection('users').deleteOne({ name: 'Alice' }); // next(); // } // Run all pending migrations: // npx migrate up -d mongodb://localhost:27017/mydb // Run down to a specific migration: // npx migrate down add_users -d mongodb://localhost:27017/mydb // List all migrations: // npx migrate list -d mongodb://localhost:27017/mydb

Debug

Known issues

gotchaCLI command is 'migrate' not 'migrate-mongoose-typescript'

fix

Use `npx migrate` or `./node_modules/.bin/migrate` instead of the package name.

affects: >=0.0.0

gotchaThe package is ESM-only; require() will fail or return an empty object

fix

Use `import migrate from 'migrate-mongoose-typescript'` in an ESM project, or use dynamic import() in CommonJS.

affects: >=3.0.0

gotcha--dbConnectionUri (or -d) is required for every command; omitting it throws a help message

fix

Always provide `-d <mongodb-uri>` or `--config <configFile>` with dbConnectionUri defined.

affects: >=0.0.0

gotchaMigrations must have both `up` and `down` functions; missing down will cause errors on rollback

fix

Always define a `down` function in migration files, even if it is a no-op.

affects: >=0.0.0

gotchaDefault collection name is 'migrations'; conflicts may occur with other tools using the same collection

fix

Use `--collection` option to specify a unique collection name.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'migrate-mongoose-typescript'

Package not installed or not in node_modules

fix

Run `npm install migrate-mongoose-typescript` in your project directory.

TypeError: migrate is not a function

Using named import instead of default import

fix

Change `import { migrate } from 'migrate-mongoose-typescript'` to `import migrate from 'migrate-mongoose-typescript'`.

Error: 'dbConnectionUri' is required

Missing required --dbConnectionUri argument

fix

Add `-d mongodb://...` or `--config <config-file>` with dbConnectionUri defined.

Upgrade

Version history

3.3.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/whyline/migrate-mongoose ↗

packagemigrate-mongoose-typescript ↗

homepagehttps://github.com/whyline/migrate-mongoose#readme ↗