docs(router): Fix incorrect name for url match options (#43268)

fixes #43123

PR Close #43268
This commit is contained in:
Andrew Scott 2021-08-26 08:15:21 -07:00 committed by Jessica Janiuk
parent c3968047b6
commit 78690ee354

View file

@ -362,7 +362,7 @@ type LocationChangeInfo = {
};
/**
* The equivalent `IsActiveUrlTreeOptions` options for `Router.isActive` is called with `true`
* The equivalent `IsActiveMatchOptions` options for `Router.isActive` is called with `true`
* (exact = true).
*/
export const exactMatchOptions: IsActiveMatchOptions = {
@ -373,7 +373,7 @@ export const exactMatchOptions: IsActiveMatchOptions = {
};
/**
* The equivalent `IsActiveUrlTreeOptions` options for `Router.isActive` is called with `false`
* The equivalent `IsActiveMatchOptions` options for `Router.isActive` is called with `false`
* (exact = false).
*/
export const subsetMatchOptions: IsActiveMatchOptions = {
@ -1318,9 +1318,9 @@ export class Router {
* Returns whether the url is activated.
*
* @deprecated
* Use `IsActiveUrlTreeOptions` instead.
* Use `IsActiveMatchOptions` instead.
*
* - The equivalent `IsActiveUrlTreeOptions` for `true` is
* - The equivalent `IsActiveMatchOptions` for `true` is
* `{paths: 'exact', queryParams: 'exact', fragment: 'ignored', matrixParams: 'ignored'}`.
* - The equivalent for `false` is
* `{paths: 'subset', queryParams: 'subset', fragment: 'ignored', matrixParams: 'ignored'}`.