Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
angular/goldens/public-api/router/errors.api.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

52 lines
1.3 KiB
Markdown
Raw Normal View History

build: migrate to new toolchain usage for api goldens (#62688) Migrate api golden usage to be based on rules_js toolchain implementation PR Close #62688
2025-07-17 17:31:38 +00:00
## API Report File for "router_errors"
refactor(router): Convert user-visible router errors to RuntimeError (#46562) This commit refactors the Router errors to use the standard `RuntimeError` used by the framework packages. PR Close #46562
2022-06-28 21:04:55 +00:00
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public
export const enum RuntimeErrorCode {
// (undocumented)
EMPTY_PATH_WITH_PARAMS = 4009,
// (undocumented)
fix(router): Surface parse errors in Router.parseUrl (#64503) logs error in addition to fallback parse fixes #54937 PR Close #64503
2025-10-17 19:05:17 +00:00
ERROR_PARSING_URL = 4018,
// (undocumented)
refactor(router): Convert user-visible router errors to RuntimeError (#46562) This commit refactors the Router errors to use the standard `RuntimeError` used by the framework packages. PR Close #46562
2022-06-28 21:04:55 +00:00
FOR_ROOT_CALLED_TWICE = 4007,
// (undocumented)
fix(router): Allow redirects after an absolute redirect (#51731) The router currently restricts all further redirects after an absolute redirect. Because there's no documented reason for _why_ this restriction is in place, I'm now deeming this unnecessary. Developers should not be restricted in this manner. Instead, configs that may have caused infinite redirects in the past should be updated to not be infinite. It is confusing to ignore configs with redirects after an absolute redirect occurred because it creates different matching rules depending on the whether an absolute redirect has happened or not. For additional context on why I believe removing this restriction is necessary, #13373 asks for allowing `redirectTo` to be a function. It would make sense to allow this function to return a `UrlTree` like other guards in the Router. When guards in the `Router` return `UrlTree`, they cancel the current navigation and start a new one to re-do the route matching. Since we're already in the router matching part, we don't need to cancel the navigation. However, the restriction on absolute redirects here then creates a weird situation where developers wouldn't see any other redirects if they returned a `UrlTree` as an absolute redirect from `redirectTo`. resolves #39770 BREAKING CHANGE: Absolute redirects no longer prevent further redirects. Route configurations may need to be adjusted to prevent infinite redirects where additional redirects were previously ignored after an absolute redirect occurred. PR Close #51731
2023-09-11 21:21:34 +00:00
INFINITE_REDIRECT = 4016,
// (undocumented)
refactor(router): Convert user-visible router errors to RuntimeError (#46562) This commit refactors the Router errors to use the standard `RuntimeError` used by the framework packages. PR Close #46562
2022-06-28 21:04:55 +00:00
INVALID_DOUBLE_DOTS = 4005,
// (undocumented)
feat(router): Add UrlTree constructor to public API (#47186) 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. PR Close #47186
2022-08-18 16:44:28 +00:00
INVALID_ROOT_URL_SEGMENT = 4015,
// (undocumented)
refactor(router): Remove custom error message for invalid guards (#46678) This custom error message for invalid guards requires a fair bit of extra logic in several places. This change reduces special logic for an error case that would fail anyways. Additionally, there were already a couple places that _did not_ have this special error and we have not seen any indication that there is more confusion for those (resolvers and canMatch). PR Close #46678
2022-07-01 19:28:04 +00:00
INVALID_ROUTE_CONFIG = 4014,
refactor(router): Convert user-visible router errors to RuntimeError (#46562) This commit refactors the Router errors to use the standard `RuntimeError` used by the framework packages. PR Close #46562
2022-06-28 21:04:55 +00:00
// (undocumented)
build: add a noDuplicateEnumValue rule (#63483) It caught several legitimate issues. In the cases I wasn't sure, I just disabled the rule. fixes #45843 PR Close #63483
2025-08-29 16:03:43 +00:00
INVALID_ROUTER_LINK_INPUTS = 4017,
feat(router): Allow `UrlTree` as an input to `routerLink` (#56265) This commit adds `UrlTree` as a valid input to `routerLink`. It disallows using this together with any inputs that come from `UrlCreationOptions`, such as `queryParams` or `fragment`. We could, in the future, decide on a different approach for these, like merging or replacing those in `urlTree` input. We cannot, however, go the other way (decide to prevent those inputs if we've already decided to allow it and using a merging/replacing strategy). For this reason, an error seems the most reasonable approach to start and we can re-evaluate if there's a compelling reason to. fixes #34468 PR Close #56265
2024-06-05 02:20:46 +00:00
// (undocumented)
refactor(router): Convert user-visible router errors to RuntimeError (#46562) This commit refactors the Router errors to use the standard `RuntimeError` used by the framework packages. PR Close #46562
2022-06-28 21:04:55 +00:00
MISPLACED_OUTLETS_COMMAND = 4004,
// (undocumented)
MISSING_REDIRECT = 4001,
// (undocumented)
NAMED_OUTLET_REDIRECT = 4000,
// (undocumented)
NO_MATCH = 4002,
// (undocumented)
NULLISH_COMMAND = 4008,
// (undocumented)
OUTLET_ALREADY_ACTIVATED = 4013,
// (undocumented)
OUTLET_NOT_ACTIVATED = 4012,
// (undocumented)
ROOT_SEGMENT_MATRIX_PARAMS = 4003,
// (undocumented)
TWO_SEGMENTS_WITH_SAME_OUTLET = 4006,
// (undocumented)
UNEXPECTED_VALUE_IN_URL = 4011,
// (undocumented)
UNPARSABLE_URL = 4010
}
// (No @packageDocumentation comment for this package)
```
Reference in a new issue Copy permalink