refactor(router): refactor documentation withHashLocation return type (…

…angular#52016) This improve the documentation of withHashLocation function by returning the correct type. PR Close angular#52016
AndrewKushnir · Oct 9, 2023 · e25006b · e25006b
1 parent 753eb24
commit e25006b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/goldens/public-api/router/index.md b/goldens/public-api/router/index.md
@@ -770,7 +770,7 @@ export interface RouterFeature<FeatureKind extends RouterFeatureKind> {
 }
 
 // @public
-export type RouterFeatures = PreloadingFeature | DebugTracingFeature | InitialNavigationFeature | InMemoryScrollingFeature | RouterConfigurationFeature | NavigationErrorHandlerFeature | ComponentInputBindingFeature | ViewTransitionsFeature;
+export type RouterFeatures = PreloadingFeature | DebugTracingFeature | InitialNavigationFeature | InMemoryScrollingFeature | RouterConfigurationFeature | NavigationErrorHandlerFeature | ComponentInputBindingFeature | ViewTransitionsFeature | RouterHashLocationFeature;
 
 // @public
 export type RouterHashLocationFeature = RouterFeature<RouterFeatureKind.RouterHashLocationFeature>;
@@ -1101,7 +1101,7 @@ export function withDisabledInitialNavigation(): DisabledInitialNavigationFeatur
 export function withEnabledBlockingInitialNavigation(): EnabledBlockingInitialNavigationFeature;
 
 // @public
-export function withHashLocation(): RouterConfigurationFeature;
+export function withHashLocation(): RouterHashLocationFeature;
 
 // @public
 export function withInMemoryScrolling(options?: InMemoryScrollingOptions): InMemoryScrollingFeature;

diff --git a/packages/router/src/provide_router.ts b/packages/router/src/provide_router.ts
@@ -586,11 +586,11 @@ export type RouterHashLocationFeature = RouterFeature<RouterFeatureKind.RouterHa
  *
  * @publicApi
  */
-export function withHashLocation(): RouterConfigurationFeature {
+export function withHashLocation(): RouterHashLocationFeature {
   const providers = [
     {provide: LocationStrategy, useClass: HashLocationStrategy},
   ];
-  return routerFeature(RouterFeatureKind.RouterConfigurationFeature, providers);
+  return routerFeature(RouterFeatureKind.RouterHashLocationFeature, providers);
 }
 
 /**
@@ -752,7 +752,7 @@ export function withViewTransitions(options?: ViewTransitionsFeatureOptions):
  */
 export type RouterFeatures = PreloadingFeature|DebugTracingFeature|InitialNavigationFeature|
     InMemoryScrollingFeature|RouterConfigurationFeature|NavigationErrorHandlerFeature|
-    ComponentInputBindingFeature|ViewTransitionsFeature;
+    ComponentInputBindingFeature|ViewTransitionsFeature|RouterHashLocationFeature;
 
 /**
  * The list of features as an enum to uniquely type each feature.