feat(*): deprecate forRoot and forRootAsync

Add register and registerAsync in their place Signed-off-by: Will Soto <[email protected]>
willsoto · Feb 15, 2020 · 5b2db23 · 5b2db23
1 parent 7fdecaf
commit 5b2db23
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 15 deletions.
diff --git a/lib/core.ts b/lib/core.ts
@@ -16,7 +16,7 @@ import {
 
 @Module({})
 export class ObjectionCoreModule {
-  public static forRoot(options: ObjectionModuleOptions): DynamicModule {
+  public static register(options: ObjectionModuleOptions): DynamicModule {
     const BaseModel = options.Model || Model;
     const connection = Knex(options.config);
 
@@ -48,7 +48,7 @@ export class ObjectionCoreModule {
     };
   }
 
-  public static forRootAsync(
+  public static registerAsync(
     options: ObjectionModuleAsyncOptions = {}
   ): DynamicModule {
     const knexConnectionProvider: Provider = {

diff --git a/lib/module.ts b/lib/module.ts
@@ -1,5 +1,5 @@
 /* eslint-disable new-cap */
-import { DynamicModule, Module } from "@nestjs/common";
+import { DynamicModule, Logger, Module } from "@nestjs/common";
 import { ObjectionCoreModule } from "./core";
 import {
   ObjectionModuleAsyncOptions,
@@ -9,19 +9,36 @@ import {
 @Module({})
 export class ObjectionModule {
   public static forRoot(options: ObjectionModuleOptions): DynamicModule {
+    Logger.warn(
+      "ObjectionModule#forRoot has been deprecated and will be removed in the next major version. Please use ObjectionModule#register instead."
+    );
+    return ObjectionModule.register(options);
+  }
+
+  public static register(options: ObjectionModuleOptions): DynamicModule {
     return {
       module: ObjectionModule,
-      imports: [ObjectionCoreModule.forRoot(options)],
+      imports: [ObjectionCoreModule.register(options)],
       exports: [ObjectionCoreModule]
     };
   }
 
   public static forRootAsync(
     options: ObjectionModuleAsyncOptions
+  ): DynamicModule {
+    Logger.warn(
+      "ObjectionModule#forRootAsync has been deprecated and will be removed in the next major version. Please use ObjectionModule#registerAsync instead."
+    );
+
+    return ObjectionModule.registerAsync(options);
+  }
+
+  public static registerAsync(
+    options: ObjectionModuleAsyncOptions
   ): DynamicModule {
     return {
       module: ObjectionModule,
-      imports: [ObjectionCoreModule.forRootAsync(options)],
+      imports: [ObjectionCoreModule.registerAsync(options)],
       exports: [ObjectionCoreModule]
     };
   }

diff --git a/tests/core.spec.ts b/tests/core.spec.ts
@@ -22,11 +22,11 @@ describe("ObjectionCoreModule", () => {
     }
   };
 
-  describe("#forRoot", () => {
+  describe("#register", () => {
     beforeEach(async () => {
       testingModule = await Test.createTestingModule({
         imports: [
-          ObjectionCoreModule.forRoot({
+          ObjectionCoreModule.register({
             config
           })
         ]
@@ -46,11 +46,11 @@ describe("ObjectionCoreModule", () => {
     });
   });
 
-  describe("#forRootAsync", () => {
+  describe("#registerAsync", () => {
     beforeEach(async () => {
       testingModule = await Test.createTestingModule({
         imports: [
-          ObjectionCoreModule.forRootAsync({
+          ObjectionCoreModule.registerAsync({
             useFactory() {
               return {
                 config
@@ -183,7 +183,7 @@ describe("ObjectionCoreModule", () => {
 
       await Test.createTestingModule({
         imports: [
-          ObjectionCoreModule.forRootAsync({
+          ObjectionCoreModule.registerAsync({
             useClass: ModuleOptionsFactory
           })
         ]

diff --git a/tests/fixtures.ts b/tests/fixtures.ts
@@ -14,7 +14,7 @@ export class ConnectionCheck {
 
 @Module({
   imports: [
-    ObjectionModule.forRoot({
+    ObjectionModule.register({
       config: {
         client: "sqlite3",
         useNullAsDefault: true,

diff --git a/tests/module.spec.ts b/tests/module.spec.ts
@@ -13,11 +13,11 @@ describe("ObjectionModule", () => {
     }
   };
 
-  describe("#forRoot", () => {
+  describe("#register", () => {
     beforeEach(async () => {
       testingModule = await Test.createTestingModule({
         imports: [
-          ObjectionModule.forRoot({
+          ObjectionModule.register({
             config
           })
         ]
@@ -37,11 +37,11 @@ describe("ObjectionModule", () => {
     });
   });
 
-  describe("#forRootAsync", () => {
+  describe("#registerAsync", () => {
     beforeEach(async () => {
       testingModule = await Test.createTestingModule({
         imports: [
-          ObjectionModule.forRootAsync({
+          ObjectionModule.registerAsync({
             useFactory() {
               return {
                 config