New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(router): Add UrlTree constructor to public API #47186
Conversation
7e699c3
to
856189e
Compare
The `UrlTree` is a fundamental concept in the router's API design. Generally speaking, a `UrlTree` would be constructed via things like `Router.createUrlTree` or `UrlSerializer#parse`. The second example here is the core reason to make the constructor public, regardless of how develpers generally create a `UrlTree` in an application. Applications can provide their own `UrlSerializer` and may want to implement their own `parse` method. This means they would also need to create a `UrlTree` but would not be able to do so effectively because the constructor is marked `@internal`. In addition, the `UrlTree` constructor only has 3 parameters, all of which are already public. There's nothing "special" about it other than the potential desire to push developers to use other methods for constructing a `UrlTree` (i.e. `Router.createUrlTree`). Also see http://b/234604699#comment9 for additional context.
856189e
to
3bf6423
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reviewed-for: public-api
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reviewed-for: public-api
This PR was merged into the repository by commit 5163e3d. |
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/animations](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fanimations/14.2.0/14.2.1) | | [@angular/common](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fcommon/14.2.0/14.2.1) | | [@angular/compiler](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/14.2.0/14.2.1) | | [@angular/compiler-cli](https://github.com/angular/angular/tree/main/packages/compiler-cli) ([source](https://github.com/angular/angular)) | devDependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/14.2.0/14.2.1) | | [@angular/core](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fcore/14.2.0/14.2.1) | | [@angular/forms](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fforms/14.2.0/14.2.1) | | [@angular/platform-browser](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/14.2.0/14.2.1) | | [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | patch | [`14.2.0` -> `14.2.1`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/14.2.0/14.2.1) | --- ### Release Notes <details> <summary>angular/angular</summary> ### [`v14.2.1`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#​1421-2022-09-07) [Compare Source](angular/angular@14.2.0...14.2.1) ##### common | Commit | Type | Description | | -- | -- | -- | | [c0d7ac9ec2](angular/angular@c0d7ac9) | fix | improve formatting of image warnings ([#​47299](angular/angular#47299)) | | [1875ce520a](angular/angular@1875ce5) | fix | use DOCUMENT token to query for preconnect links ([#​47353](angular/angular#47353)) | ##### compiler | Commit | Type | Description | | -- | -- | -- | | [0e35829580](angular/angular@0e35829) | fix | avoid errors for inputs with Object-builtin names ([#​47220](angular/angular#47220)) | ##### service-worker | Commit | Type | Description | | -- | -- | -- | | [6091786696](angular/angular@6091786) | fix | include headers in requests for assets ([#​47260](angular/angular#47260)) | | [28d33505fd](angular/angular@28d3350) | fix | only consider GET requests as navigation requests ([#​47263](angular/angular#47263)) | #### Special Thanks Aristeidis Bampakos, Asaf M, Bingo's Code, Bob Watson, Daniel Ostrovsky, George Kalpakas, Giovanni Alberto Rivas, Jeremy Elbourn, Jobayer Hossain, Joe Martin (Crowdstaffing), Joey Perrott, JoostK, Kara Erickson, Kristiyan Kostadinov, Maina Wycliffe, Sabareesh Kappagantu, Simona Cotin, Sonu Sindhu, Yann Provoost, abergquist, jaybell and vyom1611 <!-- CHANGELOG SPLIT MARKER --> ##### router | Commit | Type | Description | | -- | -- | -- | | [5163e3d876](angular/angular@5163e3d) | feat | Add UrlTree constructor to public API ([#​47186](angular/angular#47186)) | #### Special Thanks Alan Agius, Alex Rickabaugh, Andrew Scott, Joey Perrott, Kara Erickson, Kristiyan Kostadinov and Pawel Kozlowski <!-- CHANGELOG SPLIT MARKER --> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTIuMyIsInVwZGF0ZWRJblZlciI6IjMyLjE5Mi4zIn0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1538 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
The
UrlTree
is a fundamental concept in the router's API design.Generally speaking, a
UrlTree
would be constructed via things likeRouter.createUrlTree
orUrlSerializer#parse
. The second example hereis the core reason to make the constructor public, regardless of how
develpers generally create a
UrlTree
in an application.Applications can provide their own
UrlSerializer
and may want to implement theirown
parse
method. This means they would also need to create aUrlTree
but would not be able to do so effectively because theconstructor is marked
@internal
.In addition, the
UrlTree
constructor only has 3 parameters, all ofwhich are already public. There's nothing "special" about it other than
the potential desire to push developers to use other methods for
constructing a
UrlTree
(i.e.Router.createUrlTree
).Also see http://b/234604699#comment9 for additional context.