Removing the use of ModuleWithProviders

andrefarzat · andrefarzat · commit 111c1cb69a41 · 2019-04-20T17:48:48.000-03:00
diff --git a/README.md b/README.md
@@ -173,7 +173,7 @@ If you wish to optimize loading `plotly.js` in a different way, please check bot
 
 ### Plotly Via CDN Module
 
-If you want to load `plotly.js` [from a CDN](https://github.com/plotly/plotly.js#use-the-plotlyjs-cdn-hosted-by-fastly), use the `PlotlyViaCDNModule` and call `forRoot` method with the version you want to use:
+If you want to load `plotly.js` [from a CDN](https://github.com/plotly/plotly.js#use-the-plotlyjs-cdn-hosted-by-fastly), use the `PlotlyViaCDNModule` and set on the `PlotlyViaCDNModule.plotlyVersion` property the plotly.js's version you want to use:
 
 ```typescript
 import { NgModule } from '@angular/core';
diff --git a/src/app/plotly-via-cdn/plotly-via-cdn.module.ts b/src/app/plotly-via-cdn/plotly-via-cdn.module.ts
@@ -1,4 +1,4 @@
-import { NgModule, ModuleWithProviders } from '@angular/core';
+import { NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 
 import { PlotComponent } from '../shared/plot/plot.component';
@@ -51,18 +51,8 @@ export class PlotlyViaCDNModule {
         fn();
     }
 
-    static forRoot(config: Partial<{version: string}>): ModuleWithProviders<PlotlyViaCDNModule> {
-        if (config.version === undefined) {
-            console.warn(`It's strongly recommended that you set a plotly version when using via CDN.`);
-            config.version = 'latest';
-        }
-
-        PlotlyViaCDNModule.setPlotlyVersion(config.version);
-        PlotlyViaCDNModule.loadViaCDN();
-
-        return {
-            ngModule: PlotlyViaCDNModule,
-            providers: [PlotlyService]
-        };
+    static forRoot(config: Partial<{version: string}>): never {
+        const url = "https://github.com/plotly/angular-plotly.js#customizing-the-plotlyjs-bundle";
+        throw new Error(`[PlotlyViaCDNModule] forRoot method is deprecated. Please see: ${url}`);
     }
 }
diff --git a/src/app/plotly-via-window/plotly-via-window.module.ts b/src/app/plotly-via-window/plotly-via-window.module.ts
@@ -1,4 +1,4 @@
-import { NgModule, ModuleWithProviders } from '@angular/core';
+import { NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 
 import { PlotComponent } from '../shared/plot/plot.component';
@@ -22,10 +22,8 @@ export class PlotlyViaWindowModule {
         PlotlyService.setPlotly(plotly);
     }
 
-    static forRoot(): ModuleWithProviders {
-        return {
-            ngModule: PlotlyViaWindowModule,
-            providers: [PlotlyService]
-        };
+    static forRoot(): never {
+        const url = "https://github.com/plotly/angular-plotly.js#plotly-via-window-module";
+        throw new Error(`[PlotlyViaWindowModule] forRoot method is deprecated. Please see: ${url}`);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { NgModule, ModuleWithProviders } from '@angular/core';`
	`1`	`+import { NgModule } from '@angular/core';`
`2`	`2`	`import { CommonModule } from '@angular/common';`
`3`	`3`
`4`	`4`	`import { PlotComponent } from '../shared/plot/plot.component';`
`@@ -22,10 +22,8 @@ export class PlotlyViaWindowModule {`
`22`	`22`	`PlotlyService.setPlotly(plotly);`
`23`	`23`	`}`
`24`	`24`
`25`		`- static forRoot(): ModuleWithProviders {`
`26`		`- return {`
`27`		`- ngModule: PlotlyViaWindowModule,`
`28`		`- providers: [PlotlyService]`
`29`		`- };`
	`25`	`+ static forRoot(): never {`
	`26`	`+ const url = "https://github.com/plotly/angular-plotly.js#plotly-via-window-module";`
	`27`	+ throw new Error(`[PlotlyViaWindowModule] forRoot method is deprecated. Please see: ${url}`);
`30`	`28`	`}`
`31`	`29`	`}`