Skip to content

Commit fc571a2

Browse files
docs(Transition): Document UrlRouter as internal API
Relates to angular-ui/ui-router#3262 (comment)
1 parent c211b60 commit fc571a2

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/url/urlRouter.ts

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ defaultRuleSortFn = composeSort(
5151
/**
5252
* Updates URL and responds to URL changes
5353
*
54+
* ### Deprecation warning:
55+
* This class is now considered to be an internal API
56+
* For configuring URL rules, use the [[UrlRulesApi]] which can be found on [[UrlService.rules]].
57+
*
5458
* This class updates the URL when the state changes.
5559
* It also responds to changes in the URL.
5660
*/

0 commit comments

Comments
 (0)