feat(lib): add support for forRoot pattern for all modules

EdricChan03 · Jun 30, 2019 · e9e1704 · e9e1704
1 parent 64873a3
commit e9e1704
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 12 deletions.
diff --git a/projects/ngx-ytd-api-lib/commentThreads/src/ytd-api-comment-threads.module.ts b/projects/ngx-ytd-api-lib/commentThreads/src/ytd-api-comment-threads.module.ts
@@ -1,5 +1,5 @@
-import { NgModule } from '@angular/core';
-import { NgxYtdApiCommonModule } from 'ngx-ytd-api/common';
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { NgxYtdApiCommonModule, NgxYtdApiStandardParams, NGX_YTD_API_DEFAULT_STANDARD_PARAMS } from 'ngx-ytd-api/common';
 import { NgxYtdApiCommentThreadsService } from './ytd-api-comment-threads.service';
 
 @NgModule({
@@ -10,4 +10,20 @@ import { NgxYtdApiCommentThreadsService } from './ytd-api-comment-threads.servic
     NgxYtdApiCommonModule
   ]
 })
-export class NgxYtdApiCommentThreadsModule { }
+export class NgxYtdApiCommentThreadsModule {
+  /**
+   * Returns the module with the specified standard parameters
+   * @param defaultParams The default standard parameters
+   * @returns The module with the specified standard parameters
+   */
+  static forRoot(
+    defaultParams: NgxYtdApiStandardParams
+  ): ModuleWithProviders {
+    return {
+      ngModule: NgxYtdApiCommentThreadsModule,
+      providers: [
+        { provide: NGX_YTD_API_DEFAULT_STANDARD_PARAMS, useValue: defaultParams }
+      ]
+    };
+  }
+}
diff --git a/projects/ngx-ytd-api-lib/comments/src/ytd-api-comments.module.ts b/projects/ngx-ytd-api-lib/comments/src/ytd-api-comments.module.ts
@@ -1,5 +1,5 @@
-import { NgModule } from '@angular/core';
-import { NgxYtdApiCommonModule } from 'ngx-ytd-api/common';
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { NgxYtdApiCommonModule, NgxYtdApiStandardParams, NGX_YTD_API_DEFAULT_STANDARD_PARAMS } from 'ngx-ytd-api/common';
 import { NgxYtdApiCommentsService } from './ytd-api-comments.service';
 @NgModule({
   imports: [
@@ -9,4 +9,20 @@ import { NgxYtdApiCommentsService } from './ytd-api-comments.service';
     NgxYtdApiCommentsService
   ]
 })
-export class NgxYtdApiCommentsModule { }
+export class NgxYtdApiCommentsModule {
+  /**
+   * Returns the module with the specified standard parameters
+   * @param defaultParams The default standard parameters
+   * @returns The module with the specified standard parameters
+   */
+  static forRoot(
+    defaultParams: NgxYtdApiStandardParams
+  ): ModuleWithProviders {
+    return {
+      ngModule: NgxYtdApiCommentsModule,
+      providers: [
+        { provide: NGX_YTD_API_DEFAULT_STANDARD_PARAMS, useValue: defaultParams }
+      ]
+    };
+  }
+}
diff --git a/projects/ngx-ytd-api-lib/search/src/ytd-api-search.module.ts b/projects/ngx-ytd-api-lib/search/src/ytd-api-search.module.ts
@@ -1,5 +1,5 @@
-import { NgModule } from '@angular/core';
-import { NgxYtdApiCommonModule } from 'ngx-ytd-api/common';
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { NgxYtdApiCommonModule, NgxYtdApiStandardParams, NGX_YTD_API_DEFAULT_STANDARD_PARAMS } from 'ngx-ytd-api/common';
 import { NgxYtdApiSearchService } from './ytd-api-search.service';
 
 @NgModule({
@@ -10,4 +10,20 @@ import { NgxYtdApiSearchService } from './ytd-api-search.service';
     NgxYtdApiSearchService
   ]
 })
-export class NgxYtdApiSearchModule { }
+export class NgxYtdApiSearchModule {
+  /**
+   * Returns the module with the specified standard parameters
+   * @param defaultParams The default standard parameters
+   * @returns The module with the specified standard parameters
+   */
+  static forRoot(
+    defaultParams: NgxYtdApiStandardParams
+  ): ModuleWithProviders {
+    return {
+      ngModule: NgxYtdApiSearchModule,
+      providers: [
+        { provide: NGX_YTD_API_DEFAULT_STANDARD_PARAMS, useValue: defaultParams }
+      ]
+    };
+  }
+}
diff --git a/projects/ngx-ytd-api-lib/videos/src/ytd-api-videos.module.ts b/projects/ngx-ytd-api-lib/videos/src/ytd-api-videos.module.ts
@@ -1,5 +1,5 @@
-import { NgModule } from '@angular/core';
-import { NgxYtdApiCommonModule } from 'ngx-ytd-api/common';
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { NgxYtdApiCommonModule, NgxYtdApiStandardParams, NGX_YTD_API_DEFAULT_STANDARD_PARAMS } from 'ngx-ytd-api/common';
 import { NgxYtdApiVideosService } from './ytd-api-videos.service';
 
 @NgModule({
@@ -10,4 +10,20 @@ import { NgxYtdApiVideosService } from './ytd-api-videos.service';
     NgxYtdApiVideosService
   ]
 })
-export class NgxYtdApiVideosModule { }
+export class NgxYtdApiVideosModule {
+  /**
+   * Returns the module with the specified standard parameters
+   * @param defaultParams The default standard parameters
+   * @returns The module with the specified standard parameters
+   */
+  static forRoot(
+    defaultParams: NgxYtdApiStandardParams
+  ): ModuleWithProviders {
+    return {
+      ngModule: NgxYtdApiVideosModule,
+      providers: [
+        { provide: NGX_YTD_API_DEFAULT_STANDARD_PARAMS, useValue: defaultParams }
+      ]
+    };
+  }
+}