docs(router): document segment consumption during route evaluation #57437
Conversation
| @@ -1109,6 +1109,8 @@ export interface CanMatch { | |||
| * If all guards return `true`, navigation continues and the `Router` will use the `Route` during | |||
| * activation. If any guard returns `false`, the `Route` is skipped for matching and other `Route` | |||
| * configurations are processed instead. | |||
| * | |||
| * Segments array will only include parts not already consumed in previous parent route evaluations. | |||
There was a problem hiding this comment.
Is this true even when paramsInheritanceStrategy is set to 'always' ?
There was a problem hiding this comment.
Apparently yes. It always works the same way.
Here is a setup with the default value for paramsInheritanceStrategy: https://codesandbox.io/p/devbox/infallible-sound-tmrpr7
Here, another setup with paramsInheritanceStrategy set to 'always': https://codesandbox.io/p/devbox/happy-bash-8f7wk8?workspaceId=f5c8f0ef-a755-4a46-b49a-4d65fbbe56a5
There, you can see that both setups (if nothing is wrong with how I provide the value to paramsInheritanceStrategy in the forRoot() config) produce the same result in the console (the guard logs an empty array for the segment)
Might that be a bug instead of missing documentation?
There was a problem hiding this comment.
No, this is not a bug. Yes, this is working as it always has. I would suggest documenting this on the individual parameters rather than a long-form description. i.e.
@param route The `Route` being matched
@param segments The remaining segments not yet consumed...
|
Without feedback for OP, I'll close this PR. Feel free to re-open it if you want to land the change. Thank you for your understanding. |
|
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. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information