feat: update cli migration up and down from any to void (#5630)

Co-authored-by: Alexandre Piel <alexandre.piel@zooplus.com>
typeorm · Mar 11, 2020 · 76e165d · 76e165d
1 parent 0adbe5c
commit 76e165d
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 92 deletions.
diff --git a/docs/migrations.md b/docs/migrations.md
diff --git a/docs/zh_CN/migrations.md b/docs/zh_CN/migrations.md
@@ -94,9 +94,9 @@ typeorm migration:create -n PostRefactoring
 import { MigrationInterface, QueryRunner } from "typeorm";
 
 export class PostRefactoringTIMESTAMP implements MigrationInterface {
-  async up(queryRunner: QueryRunner): Promise<any> {}
+  async up(queryRunner: QueryRunner): Promise<void> {}
 
-  async down(queryRunner: QueryRunner): Promise<any> {}
+  async down(queryRunner: QueryRunner): Promise<void> {}
 }
 ```
 
@@ -115,11 +115,11 @@ export class PostRefactoringTIMESTAMP implements MigrationInterface {
 import { MigrationInterface, QueryRunner } from "typeorm";
 
 export class PostRefactoringTIMESTAMP implements MigrationInterface {
-  async up(queryRunner: QueryRunner): Promise<any> {
+  async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(`ALTER TABLE "post" ALTER COLUMN "title" RENAME TO "name"`);
   }
 
-  async down(queryRunner: QueryRunner): Promise<any> {
+  async down(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(`ALTER TABLE "post" ALTER COLUMN "name" RENAME TO "title"`); // 恢复"up"方法所做的事情
   }
 }
@@ -171,11 +171,11 @@ typeorm migration:generate -n PostRefactoring
 import { MigrationInterface, QueryRunner } from "typeorm";
 
 export class PostRefactoringTIMESTAMP implements MigrationInterface {
-  async up(queryRunner: QueryRunner): Promise<any> {
+  async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(`ALTER TABLE "post" ALTER COLUMN "title" RENAME TO "name"`);
   }
 
-  async down(queryRunner: QueryRunner): Promise<any> {
+  async down(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(`ALTER TABLE "post" ALTER COLUMN "name" RENAME TO "title"`);
   }
 }
@@ -194,7 +194,7 @@ export class PostRefactoringTIMESTAMP implements MigrationInterface {
 import { MigrationInterface, QueryRunner, Table, TableIndex, TableColumn, TableForeignKey } from "typeorm";
 
 export class QuestionRefactoringTIMESTAMP implements MigrationInterface {
-  async up(queryRunner: QueryRunner): Promise<any> {
+  async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.createTable(
       new Table({
         name: "question",
@@ -258,7 +258,7 @@ export class QuestionRefactoringTIMESTAMP implements MigrationInterface {
     );
   }
 
-  async down(queryRunner: QueryRunner): Promise<any> {
+  async down(queryRunner: QueryRunner): Promise<void> {
     const table = await queryRunner.getTable("question");
     const foreignKey = table.foreignKeys.find(fk => fk.columnNames.indexOf("questionId") !== -1);
     await queryRunner.dropForeignKey("question", foreignKey);

diff --git a/src/commands/MigrationCreateCommand.ts b/src/commands/MigrationCreateCommand.ts
@@ -82,10 +82,10 @@ export class MigrationCreateCommand implements yargs.CommandModule {
 
 export class ${camelCase(name, true)}${timestamp} implements MigrationInterface {
 
-    public async up(queryRunner: QueryRunner): Promise<any> {
+    public async up(queryRunner: QueryRunner): Promise<void> {
     }
 
-    public async down(queryRunner: QueryRunner): Promise<any> {
+    public async down(queryRunner: QueryRunner): Promise<void> {
     }
 
 }

diff --git a/test/functional/migrations/show-command/migration/1530542855524-ExampleMigration.ts b/test/functional/migrations/show-command/migration/1530542855524-ExampleMigration.ts
@@ -2,8 +2,8 @@ import { MigrationInterface } from "../../../../../src/migration/MigrationInterf
 import { QueryRunner } from "../../../../../src/query-runner/QueryRunner";
 
 export class ExampleMigration1530542855524 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<any> {
+    public async up(queryRunner: QueryRunner): Promise<void> {
     }
-    public async down(queryRunner: QueryRunner): Promise<any> {
+    public async down(queryRunner: QueryRunner): Promise<void> {
     }
 }
diff --git a/test/functional/migrations/show-command/migration/1530542855524-ExampleMigrationTwo.ts b/test/functional/migrations/show-command/migration/1530542855524-ExampleMigrationTwo.ts
@@ -2,8 +2,8 @@ import { MigrationInterface } from "../../../../../src/migration/MigrationInterf
 import { QueryRunner } from "../../../../../src/query-runner/QueryRunner";
 
 export class ExampleMigrationTwo1530542855524 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<any> {
+    public async up(queryRunner: QueryRunner): Promise<void> {
     }
-    public async down(queryRunner: QueryRunner): Promise<any> {
+    public async down(queryRunner: QueryRunner): Promise<void> {
     }
 }
diff --git a/test/github-issues/2875/migration/1530542855524-CreateUsersSeq.ts b/test/github-issues/2875/migration/1530542855524-CreateUsersSeq.ts
@@ -2,15 +2,15 @@ import { MigrationInterface } from "../../../../src/migration/MigrationInterface
 import { QueryRunner } from "../../../../src/query-runner/QueryRunner";
 
 export class InitUsers1530542855524 implements MigrationInterface {
-     public async up(queryRunner: QueryRunner): Promise<any> {
+     public async up(queryRunner: QueryRunner): Promise<void> {
         await queryRunner.query(`
             CREATE SEQUENCE users_id_seq INCREMENT 1 MINVALUE 1 MAXVALUE 9223372036854775807 START 1 CACHE 1
         `);
         await queryRunner.query(`
             DROP SEQUENCE IF EXISTS users_id_seq
         `);
     }
-     public async down(queryRunner: QueryRunner): Promise<any> {
+     public async down(queryRunner: QueryRunner): Promise<void> {
         await queryRunner.query(`
             DROP SEQUENCE IF EXISTS users_id_seq
         `);

diff --git a/test/github-issues/4701/migration/1567759789051-ExampleMigration.ts b/test/github-issues/4701/migration/1567759789051-ExampleMigration.ts
@@ -2,6 +2,6 @@ import { MigrationInterface } from "../../../../src/migration/MigrationInterface
 import { QueryRunner } from "../../../../src/query-runner/QueryRunner";
 
 export class ExampleMigrationOne1567759789051 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<any> {}
-    public async down(queryRunner: QueryRunner): Promise<any> {}
+    public async up(queryRunner: QueryRunner): Promise<void> {}
+    public async down(queryRunner: QueryRunner): Promise<void> {}
 }
diff --git a/test/github-issues/4701/migration/1567759832591-ExampleMigrationTwo.ts b/test/github-issues/4701/migration/1567759832591-ExampleMigrationTwo.ts
@@ -2,6 +2,6 @@ import { MigrationInterface } from "../../../../src/migration/MigrationInterface
 import { QueryRunner } from "../../../../src/query-runner/QueryRunner";
 
 export class ExampleMigrationOne1567759789051 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<any> {}
-    public async down(queryRunner: QueryRunner): Promise<any> {}
+    public async up(queryRunner: QueryRunner): Promise<void> {}
+    public async down(queryRunner: QueryRunner): Promise<void> {}
 }
diff --git a/test/github-issues/4701/migration/1571426391120-ExampleMigrationThree.ts b/test/github-issues/4701/migration/1571426391120-ExampleMigrationThree.ts
@@ -2,6 +2,6 @@ import { MigrationInterface } from "../../../../src/migration/MigrationInterface
 import { QueryRunner } from "../../../../src/query-runner/QueryRunner";
 
 export class ExampleMigrationThree1571426391120 implements MigrationInterface {
-    public async up(queryRunner: QueryRunner): Promise<any> {}
-    public async down(queryRunner: QueryRunner): Promise<any> {}
+    public async up(queryRunner: QueryRunner): Promise<void> {}
+    public async down(queryRunner: QueryRunner): Promise<void> {}
 }