Rename Orm decorators to Inject

Author: MichalLytek

README.md

@@ -33,7 +33,7 @@ createConnection({
 All decorators can be used on properties and constructor arguments, e.g. you can use both
 property and constructor injection.
 
-### @OrmConnection
+### @InjectConnection
 
 Injects `Connection` from where you can access anything in your connection.
 
@@ -42,12 +42,12 @@ Example using property injection:
 ```typescript
 import {Service} from "typedi";
 import {Connection} from "typeorm";
-import {OrmConnection} from "typeorm-typedi-extensions";
+import {InjectConnection} from "typeorm-typedi-extensions";
 
 @Service()
 export class PostRepository {
 
-    @OrmConnection()
+    @InjectConnection()
     private connection: Connection;
 
 }
@@ -58,20 +58,20 @@ Example using constructor injection:
 ```typescript
 import {Service} from "typedi";
 import {Connection} from "typeorm";
-import {OrmConnection} from "typeorm-typedi-extensions";
+import {InjectConnection} from "typeorm-typedi-extensions";
 
 @Service()
 export class PostRepository {
 
-    constructor(@OrmConnection() private connection: Connection) {
+    constructor(@InjectConnection() private connection: Connection) {
     }
 
 }
 ```
 
 Optionally, you can specify a connection name in the decorator parameters.
 
-### @OrmManager
+### @InjectManager
 
 Injects `EntityManager` from where you can access any entity in your connection. 
 
@@ -80,12 +80,12 @@ Example using property injection:
 ```typescript
 import {Service} from "typedi";
 import {EntityManager} from "typeorm";
-import {OrmManager} from "typeorm-typedi-extensions";
+import {InjectManager} from "typeorm-typedi-extensions";
 
 @Service()
 export class PostRepository {
 
-    @OrmManager()
+    @InjectManager()
     private entityManager: EntityManager;
 
 }
@@ -96,36 +96,36 @@ Example using constructor injection:
 ```typescript
 import {Service} from "typedi";
 import {EntityManager} from "typeorm";
-import {OrmManager} from "typeorm-typedi-extensions";
+import {InjectManager} from "typeorm-typedi-extensions";
 
 @Service()
 export class PostRepository {
 
-    constructor(@OrmManager() private entityManager: EntityManager) {
+    constructor(@InjectManager() private entityManager: EntityManager) {
     }
 
 }
 ```
 
 Optionally, you can specify a connection name in the decorator parameters.
 
-### @OrmRepository
+### @InjectRepository
 
 Injects `Repository`, `MongoRepository`, `TreeRepository` or custom repository of some Entity.
-Be aware that the property or param decorated with `@OrmRepository` has to be annotated with repository type!
+Be aware that the property or param decorated with `@InjectRepository` has to be annotated with repository type!
 
 Example using property injection:
 
 ```typescript
 import {Service} from "typedi";
 import {Repository} from "typeorm";
-import {OrmRepository} from "typeorm-typedi-extensions";
+import {InjectRepository} from "typeorm-typedi-extensions";
 import "../entity/Post";
 
 @Service()
 export class PostRepository {
 
-    @OrmRepository(Post)
+    @InjectRepository(Post)
     private repository: Repository<Post>;
 
 }
@@ -136,14 +136,14 @@ Example using constructor injection:
 ```typescript
 import {Service} from "typedi";
 import {Repository} from "typeorm";
-import {OrmRepository} from "typeorm-typedi-extensions";
+import {InjectRepository} from "typeorm-typedi-extensions";
 import "../entity/Post";
 
 @Service()
 export class PostRepository {
 
     constructor(
-        @OrmRepository(Post)
+        @InjectRepository(Post)
         private repository: Repository<Post>
     ) {}
 
@@ -155,7 +155,7 @@ Optionally, you can specify a connection name in the decorator parameters:
 @Service()
 export class PostRepository {
 
-    @OrmRepository(Post, "custom-con-name")
+    @InjectRepository(Post, "custom-con-name")
     private repository: Repository<Post>;
 
 }
@@ -169,7 +169,7 @@ Example using constructor injection:
 ```typescript
 import { Service } from "typedi";
 import { Repository, EntityRepository } from "typeorm";
-import { OrmRepository } from "typeorm-typedi-extensions";
+import { InjectRepository } from "typeorm-typedi-extensions";
 import "../entity/user";
 
 // create custom Repository class
@@ -188,7 +188,7 @@ export class PostService {
 
     // using constructor injection
     constructor(
-        @OrmRepository()
+        @InjectRepository()
         private readonly userRepository: UserRepository,
     ) {}
 
@@ -205,7 +205,7 @@ Optionally, you can specify a connection name in the decorator parameters.
 @Service()
 export class PostService {
 
-    @OrmRepository("custom-con-name")
+    @InjectRepository("custom-con-name")
     private userRepository: UserRepository;
 
 }

sample/sample1-simple-usage/app.ts

@@ -1,6 +1,7 @@
 import "reflect-metadata";
 import {createConnection, useContainer} from "typeorm";
 import {Container} from "typedi";
+
 import {PostRepository} from "./repository/PostRepository";
 import {Post} from "./entity/Post";
 

sample/sample1-simple-usage/repository/PostRepository.ts

@@ -1,28 +1,29 @@
 import {EntityManager, Repository} from "typeorm";
 import {Service} from "typedi";
+
 import {Post} from "../entity/Post";
-import {OrmRepository} from "../../../src/decorators/OrmRepository";
-import {OrmManager} from "../../../src/decorators/OrmManager";
+import {InjectRepository} from "../../../src/decorators/InjectRepository";
+import {InjectManager} from "../../../src/decorators/InjectManager";
 
 @Service()
 export class PostRepository {
 
-    @OrmManager()
+    @InjectManager()
     private entityManager: EntityManager;
 
-    constructor(@OrmRepository(Post) private ormRepository: Repository<Post>) {
+    constructor(@InjectRepository(Post) private InjectRepository: Repository<Post>) {
     }
 
     saveUsingRepository(post: Post) {
-        return this.ormRepository.save(post);
+        return this.InjectRepository.save(post);
     }
 
     saveUsingManager(post: Post) {
         return this.entityManager.save(post);
     }
 
     findAll() {
-        return this.ormRepository.find();
+        return this.InjectRepository.find();
     }
 
 }

src/decorators/OrmConnection.ts renamed to src/decorators/InjectConnection.ts

@@ -4,7 +4,7 @@ import {Container} from "typedi";
 /**
  * Allows to inject an Connection using typedi's Container.
  */
-export function OrmConnection(connectionName: string = "default"): Function {
+export function InjectConnection(connectionName: string = "default"): Function {
     return function(object: Object|Function, propertyName: string, index?: number) {
         Container.registerHandler({ object, index, propertyName, value: () => {
             const connectionManager = Container.get(ConnectionManager);

src/decorators/OrmManager.ts renamed to src/decorators/InjectManager.ts

@@ -4,7 +4,7 @@ import {Container} from "typedi";
 /**
  * Allows to inject an EntityManager using typedi's Container.
  */
-export function OrmManager(connectionName: string = "default"): Function {
+export function InjectManager(connectionName: string = "default"): Function {
     return function(object: Object|Function, propertyName: string, index?: number) {
         Container.registerHandler({ object, index, propertyName, value: () => {
             const connectionManager = Container.get(ConnectionManager);

src/decorators/OrmRepository.ts renamed to src/decorators/InjectRepository.ts

@@ -44,35 +44,35 @@ export type ParamOrPropDecorator = (object: object, propertyName: string, index?
  * class Sample {
  *   // constructor injection
  *   constructor(
- *     \@OrmRepository()
+ *     \@InjectRepository()
  *      private userRepository: UserRepository,
  *   ) {}
  * 
  *   // property injection
- *  \@OrmRepository()
+ *  \@InjectRepository()
  *   userRepository: UserRepository;
  * }
  * ```
  */
-export function OrmRepository(): ParamOrPropDecorator;
+export function InjectRepository(): ParamOrPropDecorator;
 /**
  * Allows to inject a Repository, MongoRepository, TreeRepository using TypeDI's Container.
  * Be aware that you have to annotate the param/property  with correct type!
  * ```ts
  * class Sample {
  *   // constructor injection
  *   constructor(
- *     \@OrmRepository(User)
+ *     \@InjectRepository(User)
  *      private userRepository: Repository<User>,
  *   ) {}
  * 
  *   // property injection
- *  \@OrmRepository(User)
+ *  \@InjectRepository(User)
  *   userRepository: Repository<User>;
  * }
  * ```
  */
-export function OrmRepository(entityType: Function): ParamOrPropDecorator;
+export function InjectRepository(entityType: Function): ParamOrPropDecorator;
 /**
  * Allows to inject a custom repository using TypeDI's Container
  * and specify the connection name in a parameter.
@@ -81,17 +81,17 @@ export function OrmRepository(entityType: Function): ParamOrPropDecorator;
  * class Sample {
  *   // constructor injection
  *   constructor(
- *     \@OrmRepository("test-conn")
+ *     \@InjectRepository("test-conn")
  *      private userRepository: UserRepository,
  *   ) {}
  * 
  *   // property injection
- *  \@OrmRepository("test-conn")
+ *  \@InjectRepository("test-conn")
  *   userRepository: UserRepository;
  * }
  * ```
  */
-export function OrmRepository(connectionName: string): ParamOrPropDecorator;
+export function InjectRepository(connectionName: string): ParamOrPropDecorator;
 /**
  * Allows to inject a Repository, MongoRepository, TreeRepository using TypeDI's Container
  * and specify the connection name in a parameter.
@@ -100,19 +100,19 @@ export function OrmRepository(connectionName: string): ParamOrPropDecorator;
  * class Sample {
  *   // constructor injection
  *   constructor(
- *     \@OrmRepository(User, "test-conn")
+ *     \@InjectRepository(User, "test-conn")
  *      private userRepository: Repository<User>,
  *   ) {}
  * 
  *   // property injection
- *  \@OrmRepository(User, "test-conn")
+ *  \@InjectRepository(User, "test-conn")
  *   userRepository: Repository<User>;
  * }
  * ```
  */
-export function OrmRepository(entityType: Function, connectionName: string): ParamOrPropDecorator;
+export function InjectRepository(entityType: Function, connectionName: string): ParamOrPropDecorator;
 
-export function OrmRepository(entityTypeOrConnectionName?: Function|string, paramConnectionName = "default"): ParamOrPropDecorator {
+export function InjectRepository(entityTypeOrConnectionName?: Function|string, paramConnectionName = "default"): ParamOrPropDecorator {
     return (object: object, propertyName: string, index?: number) => {
         let entityType: Function|undefined;
         let connectionName: string;

src/errors/EntityTypeMissingError.ts

@@ -1,7 +1,7 @@
 export class EntityTypeMissingError extends Error {
     constructor(object: Object, propertyName: string, index?: number) {
         super(
-            `Missing "entityType" parameter of "@OrmRepository" decorator ` +
+            `Missing "entityType" parameter of "@InjectRepository" decorator ` +
             index !== undefined
                 ? `for a "${propertyName}" method's ${index! + 1}. parameter of ${object.constructor.name} class. `
                 : `for a property "${propertyName}" of ${object.constructor.name} class. `

src/index.ts

@@ -1,3 +1,3 @@
-export * from "./decorators/OrmConnection";
-export * from "./decorators/OrmManager";
-export * from "./decorators/OrmRepository";
+export * from "./decorators/InjectConnection";
+export * from "./decorators/InjectManager";
+export * from "./decorators/InjectRepository";