docs(router): deprecate RouterTestingModule (#54466)

atscott · alxhub · commit a9741e69d2c2 · 2024-02-20T09:33:16.000-08:00
Deprecate `RouterTestingModule` as it is no longer needed or useful and is not actively maintained. fixes #54461 PR Close #54466
diff --git a/goldens/public-api/router/testing/index.md b/goldens/public-api/router/testing/index.md
@@ -24,7 +24,7 @@ export class RouterTestingHarness {
     get routeNativeElement(): HTMLElement | null;
 }
 
-// @public
+// @public @deprecated
 export class RouterTestingModule {
     // (undocumented)
     static withRoutes(routes: Routes, config?: ExtraOptions): ModuleWithProviders<RouterTestingModule>;
diff --git a/packages/router/testing/src/router_testing_module.ts b/packages/router/testing/src/router_testing_module.ts
@@ -66,6 +66,11 @@ function throwInvalidConfigError(parameter: string): never {
  * ```
  *
  * @publicApi
+ * @deprecated Use `provideRouter` or `RouterModule`/`RouterModule.forRoot` instead.
+ * This module was previously used to provide a helpful collection of test fakes,
+ * most notably those for `Location` and `LocationStrategy`.  These are generally not
+ * required anymore, as `MockPlatformLocation` is provided in `TestBed` by default.
+ * However, you can use them directly with `provideLocationMocks`.
  */
 @NgModule({
   exports: [RouterModule],

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export class RouterTestingHarness {`
`24`	`24`	`get routeNativeElement(): HTMLElement \| null;`
`25`	`25`	`}`
`26`	`26`
`27`		`-// @public`
	`27`	`+// @public @deprecated`
`28`	`28`	`export class RouterTestingModule {`
`29`	`29`	`// (undocumented)`
`30`	`30`	`static withRoutes(routes: Routes, config?: ExtraOptions): ModuleWithProviders<RouterTestingModule>;`