Registry /
database / typeorm-ts-node-commonjs
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
npm script usage
✓ "typeorm": "typeorm-ts-node-commonjs"
This package provides a CLI binary. It is most commonly referenced in `package.json` scripts to define the 'typeorm' command, allowing TypeORM to run with TypeScript in a CommonJS project. This pattern is officially recommended by TypeORM.
npx direct usage
✓ npx typeorm-ts-node-commonjs migration:run -d ./src/data-source.ts
✗ npx typeorm migration:run -d ./src/data-source.ts
Direct invocation via `npx`. The 'wrong' example shows attempting to use the default `typeorm` binary directly with TypeScript source files in a CommonJS project, which this package is designed to resolve.
Explicit binary path
✓ ./node_modules/.bin/typeorm-ts-node-commonjs schema:sync -d ./config/ormconfig.ts
For explicit invocation of the locally installed binary, bypassing `npm run` or `npx`.
This quickstart demonstrates how to configure `package.json` scripts to use `typeorm-ts-node-commonjs` for TypeORM CLI commands in a TypeScript project configured for CommonJS modules, including a basic DataSource setup.
{
"name": "my-typeorm-cjs-app",
"version": "1.0.0",
"main": "index.js",
"type": "commonjs",
"scripts": {
"start": "node src/index.js",
"typeorm": "typeorm-ts-node-commonjs",
"typeorm:migration:generate": "npm run typeorm -- migration:generate -d ./src/data-source.ts ./src/migrations/MyNewMigration",
"typeorm:migration:run": "npm run typeorm -- migration:run -d ./src/data-source.ts",
"typeorm:schema:sync": "npm run typeorm -- schema:sync -d ./src/data-source.ts"
},
"dependencies": {
"typeorm": "^0.3.20",
"reflect-metadata": "^0.1.13",
"pg": "^8.11.3"
},
"devDependencies": {
"ts-node": "^10.9.1",
"typescript": "^5.3.3",
"typeorm-ts-node-commonjs": "^0.3.20"
}
}
// src/data-source.ts
import "reflect-metadata";
import { DataSource } from "typeorm";
import { User } from "./entity/User";
export const AppDataSource = new DataSource({
type: "postgres",
host: process.env.DB_HOST ?? "localhost",
port: parseInt(process.env.DB_PORT ?? "5432", 10),
username: process.env.DB_USERNAME ?? "user",
password: process.env.DB_PASSWORD ?? "password",
database: process.env.DB_NAME ?? "mydatabase",
synchronize: false,
logging: false,
entities: [User],
migrations: [__dirname + "/migrations/**/*.ts"],
subscribers: [],
});
// To run, assuming package.json is set up as above:
// npm install
// npm run typeorm:migration:generate
typeorm --version
Debug
Known issues
gotchaThis package is not actively maintained by the TypeORM core team. While officially recommended in TypeORM documentation, the lack of recent updates (last publish over a year ago) means it might not immediately support the absolute latest Node.js, TypeORM, or `ts-node` versions without potential issues.fixMonitor TypeORM's official documentation for alternative recommended approaches or be prepared to debug compatibility issues with newer dependency versions.
affects: >=0.3.20
breakingAs a wrapper around TypeORM and `ts-node`, this package's functionality is dependent on the APIs and behaviors of its underlying tools. Breaking changes in major versions of `typeorm` or `ts-node` could render this wrapper ineffective or cause unexpected behavior. This was notably observed during TypeORM's v0.3.0 transition.fixRefer to the TypeORM and ts-node migration guides for breaking changes. If issues arise, consider manually configuring `ts-node` in your scripts instead of relying solely on this wrapper, or use `typeorm-ts-node-esm` for ESM projects.
affects: >=0.3.0 of TypeORM
gotchaThe package name itself, `typeorm-ts-node-commonjs`, is used as the executable binary by TypeORM's CLI. Misconfigurations or attempts to use `typeorm` directly with TypeScript files in a CommonJS project will likely fail to resolve modules correctly.fixAlways ensure your `package.json` scripts explicitly call `typeorm-ts-node-commonjs` when running TypeORM CLI commands with TypeScript files in a CommonJS project, as shown in TypeORM's official documentation.
affects: >=0.1.0
Errors
Common errors & fixes
/usr/bin/env: 'node --require ts-node/register': No such file or directory
This error often occurs when running the CLI in Docker containers or environments where the shebang line's `node --require` parsing is problematic, or when `ts-node` is not correctly installed/accessible.
fixEnsure `ts-node` is installed and accessible in your environment. For `package.json` scripts, try replacing `"typeorm": "typeorm-ts-node-commonjs"` with a more explicit `"typeorm": "node --require ts-node/register ./node_modules/typeorm/cli.js"` or similar direct invocation, adjusting for CommonJS needs.
Error: Unable to open file: '/path/to/datasource.js'. Cannot find module '~/environment' Require stack: ...
This indicates a `ts-node` module resolution issue, often related to path aliases defined in `tsconfig.json` or incorrect `.js` extension resolution for TypeScript files.
fixEnsure your `tsconfig.json` paths are correctly configured for `ts-node` and that your TypeORM data source path is correct. You might need to add `--project tsconfig.json` (or a specific tsconfig file for TypeORM) to your CLI command to ensure `ts-node` picks up the correct configuration.
Error during migration run: Error: Connection lost: The server closed the connection.
While not directly caused by `typeorm-ts-node-commonjs`, this error has been reported in conjunction with it, particularly on newer Node.js versions, and is typically a database connection issue.
fixVerify your database connection parameters (host, port, username, password, database). Check firewall rules, network connectivity to the database, and ensure the database server is running and accessible. Sometimes, using an older stable Node.js version might temporarily resolve it if it's a transient compatibility issue.
Audit
Dependencies
typeormrequiredThis package wraps the TypeORM CLI, requiring TypeORM to be installed in the project.
ts-noderequiredThis package configures and utilizes ts-node to execute TypeScript files within a CommonJS context for TypeORM commands.
typescriptrequiredRequired for compiling and executing TypeScript files.