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.
Entity
✓ import { Entity } from 'myorm_pg'
✗ const { Entity } = require('myorm_pg')
ESM-only since v10; CommonJS require will fail.
PrimaryGeneratedColumn
✓ import { PrimaryGeneratedColumn } from 'myorm_pg'
✗ import { PrimaryGeneratedColumn } from 'myorm_pg/decorators'
All decorators are re-exported from the main module; no need for subpath imports.
createConnection
✓ import { createConnection } from 'myorm_pg'
✗ import { createConnection } from 'myorm_pg/connection'
createConnection is a top-level export since v8.
getRepository
✓ import { getRepository } from 'myorm_pg'
Type-safe repository factory; returns a typed Repository<T>.
Shows how to define an entity with decorators, create a connection, and perform insert/find operations.
import 'reflect-metadata';
import { Entity, PrimaryGeneratedColumn, Column, createConnection, getRepository } from 'myorm_pg';
@Entity('users')
class User {
@PrimaryGeneratedColumn()
id!: number;
@Column()
name!: string;
}
async function main() {
await createConnection({
host: process.env.DB_HOST ?? 'localhost',
port: Number(process.env.DB_PORT) || 5432,
username: process.env.DB_USER ?? 'postgres',
password: process.env.DB_PASS ?? '',
database: process.env.DB_NAME ?? 'test',
entities: [User]
});
const userRepo = getRepository(User);
const newUser = userRepo.create({ name: 'Alice' });
await userRepo.save(newUser);
const users = await userRepo.find();
console.log(users);
}
main().catch(console.error);
Errors
Common errors & fixes
Cannot find module 'reflect-metadata'
reflect-metadata is not installed despite being listed as peer dependency.
fixRun 'npm install reflect-metadata' or add it to your package.json.
EntityMetadataNotFoundError: No metadata for "User" was found.
The entity class is not registered in the connection options' 'entities' array or decorators are not applied.
fixEnsure the entity is added to the entities array in createConnection and that reflect-metadata is imported.
DataError: invalid input syntax for type integer
A column mapped as number receives a non-numeric string value.
fixValidate input types before assigning; use TypeScript to enforce types at compile time.
Audit
Dependencies
reflect-metadatarequiredRequired for decorator-based entity definitions and runtime type reflection