typeorm_skill

Overview

This skill provides compact, searchable documentation and usage guidance for TypeORM features and APIs. It condenses key topics — data sources, entities, relations, query builder, migrations, indices, and column types — into practical guidance developers can apply quickly. The content is drawn from official TypeORM documentation and organized for fast lookup when answering docs-related questions.

How this skill works

The skill inspects common TypeORM documentation areas and extracts actionable instructions, examples, and configuration patterns. It maps user questions to relevant documentation sections (DataSource, Entities, Relations, QueryBuilder, Migrations, Find Options, indices, etc.) and returns concise, implementation-focused answers. For complex scenarios it synthesizes recommendations across multiple doc topics to produce step-by-step guidance.

When to use it

• When a question asks how to configure or initialize a DataSource
• When you need examples for entities, relations, or inheritance patterns
• When troubleshooting QueryBuilder usage, advanced Find Options, or loading relations
• When planning or running schema sync, migrations, or altering columns/indexes
• When you need column type references, index definitions, or DB-specific options

Best practices

• Prefer DataSource-based initialization for predictable connection management and migrations
• Use explicit relations and proper eager/lazy loading to avoid N+1 queries; load relation ids when full joins are unnecessary
• Keep schema changes in migrations for production; use schema sync only for development or prototyping
• Define indices and unique constraints at the entity level for consistent DDL across environments
• Use QueryBuilder for complex queries; use repository methods or Find Options for simple reads to keep code readable

Example use cases

• Setting up a new DataSource for Postgres and running initial migrations
• Modeling OneToMany/ManyToOne relations with explicit join columns and relation ids
• Converting a Sequelize project to TypeORM-style entities and migrations
• Creating composite indices or unique constraints on multiple columns for performance and data integrity
• Using QueryBuilder to construct complex filtered joins with GROUP BY and HAVING