Registry /
devops / sequelize-typescript-migration-ht
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.
SequelizeTypescriptMigration
✓ import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration-ht'
✗ const { SequelizeTypescriptMigration } = require('sequelize-typescript-migration-ht')
ESM imports are standard; CommonJS require may work but is not the primary pattern. Package ships TypeScript types.
makeMigration
✓ SequelizeTypescriptMigration.makeMigration(...)
✗ makeMigration(...) as a standalone function
makeMigration is a static method on the class; it is not exported directly.
default import
✓ import SequelizeTypescriptMigration from 'sequelize-typescript-migration-ht'
✗ const sequelizeTypescriptMigration = require('sequelize-typescript-migration-ht').default
The package has a named export only; default import will fail at runtime if not properly transpiled. Use the named import shown above.
Shows how to initialize Sequelize with sequelize-typescript and generate a migration from decorated models, outputting to a directory.
import { join } from 'path';
import { Sequelize } from 'sequelize-typescript';
import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration-ht';
const sequelize = new Sequelize({
dialect: 'sqlite',
storage: ':memory:',
models: [__dirname + '/models'],
});
await SequelizeTypescriptMigration.makeMigration(sequelize, {
outDir: join(__dirname, './migrations'),
migrationName: 'initial',
preview: false,
});
console.log('Migration file generated in ./migrations');
Debug
Known issues
gotchaThe tool only supports sequelize-typescript decorated models, not plain sequelize models. Using plain models will produce empty or incorrect migrations.fixUse @Table, @Column, etc. from 'sequelize-typescript' to define models.
affects: >=1.0.0
gotchaUndo (down) actions may fail due to ordering of model relations (e.g., foreign keys). Manual intervention may be required.fixAfter generation, inspect and reorder migration commands if necessary, or manually write down functions.
affects: >=1.0.0
breakingVersion 2.x uses sequelize@~6.0.0; version 1.x uses sequelize@~4.0.0. Using the wrong version will cause incompatibility.fixCheck your sequelize version: for sequelize@6, use sequelize-typescript-migration-ht@~2.0.0; for sequelize@4, use ~1.0.0.
affects: >=2.0.0 <3.0.0 || >=1.0.0 <2.0.0
deprecatedThis package is a community fork of several abandoned projects. No active maintainer, may not receive updates for future Sequelize versions.fixConsider alternatives like 'sequelize-cli' or 'umzug' for manual migrations, or use 'sequelize-auto-migrations' if you must have auto-generation.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'sequelize-typescript-migration-ht'
Package not installed or wrong package name used.
fixRun 'npm i sequelize-typescript-migration-ht' or 'yarn add sequelize-typescript-migration-ht'.
TypeError: sequelize.define is not a function
Passing a Sequelize instance created with plain 'sequelize' package instead of 'sequelize-typescript'.
fixUse 'new Sequelize(...)' from 'sequelize-typescript' (import { Sequelize } from 'sequelize-typescript'). SequelizeTypescriptMigration.makeMigration is not a function
Incorrect import: default import used on a named export.
fixUse named import: import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration-ht'. No changes detected - no migration generated.
Models are not decorated (missing @Table/@Column) or models path not set correctly.
fixEnsure models use sequelize-typescript decorators and are loaded by Sequelize (e.g., via 'models' option or manually importing).
Audit
Dependencies
sequelizerequiredCore ORM dependency; this tool interfaces with Sequelize and relies on it for migrations.
sequelize-typescriptrequiredRequired for reading decorated models; the tool does not support plain Sequelize model definitions.